IWIDGETS_EXTFILESELECTIONBOX(3iwidget)

💖 iwidgets::extfileselectionbox 💖

okay so bestie, gather round, because we're talking about iwidgets::extfileselectionbox from [incr Widgets] — the file selection box that ate and left absolutely no crumbs. she's a whole widget, she's iconic, and yes she comes with a manual page (this one, hi, you're reading it 👑).

---

✨ NAME ✨

iwidgets::extfileselectionbox — create and manipulate a file selection box widget. that's it, that's the job, and she does it gorgeously 💅

---

✨ SYNOPSIS ✨

iwidgets::extfileselectionbox pathName ?options?

---

✨ INHERITANCE ✨

the family tree, the bloodline, the lineage 🧬:

itk::Widget <- iwidgets::Extfileselectionbox

so she's an itk::Widget girlie first, and then she became an iwidgets::Extfileselectionbox. glow-up fr fr 🌸

---

✨ STANDARD OPTIONS ✨

these are the classics, the inherited hand-me-downs that still slay:

• activeBackground
• background
• borderWidth
• cursor
• foreground
• highlightColor
• highlightThickness
• insertBackground
• insertBorderWidth
• insertOffTime
• insertOnTime
• insertWidth
• selectBackground
• selectBorderWidth
• selectForeground

see the options manual entry for the full tea on all the standard options ☕

---

✨ ASSOCIATED OPTIONS ✨

these ones come borrowed from her friends. it's giving "my options are your options" 🫶

• popupCursor, textBackground, textFont — see the combobox widget manual entry for details on the above associated options.
• labelFont — see the labeledwidget widget manual entry for details on the above associated option.
• sashCursor — see the panedwindow widget manual entry for details on the above associated option.
• activeRelief, elementBorderWidth, jumptroughColor — see the scrollbar widget class manual entry for details on the above associated options.
• textBackground, textFont — see the scrolledlistbox widget manual entry for details on the above associated options.

(not me noticing textBackground and textFont pulling up twice like they're in two group chats at once 😭 iconic behavior actually)

---

✨ WIDGET-SPECIFIC OPTIONS ✨

okay this is the main character section. every single one of her very own options, no skips, no cuts, no "and the rest" — we do not do that here 💖

• Name: automount Class: Automount Command-Line Switch: -automount

specifies a list of directory prefixes to ignore. typically, this option would be used like this:

-automount {export tmp_mnt}

• Name: childSitePos Class: Position Command-Line Switch: -childsitepos

specifies the position of the child site in the extended fileselection box: n, s, e, w, top, or bottom. the default is s.

• Name: directory Class: Directory Command-Line Switch: -directory

specifies the initial default directory. the default is the present working directory. (so like, wherever you already are, bestie 🏠)

• Name: dirSearchCommand Class: Command Command-Line Switch: -dirsearchcommand

specifies a Tcl command to be executed to perform a directory search. the command will receive the current working directory and filter mask as arguments. the command should return a list of files which will be placed into the directory list.

• Name: dirsLabel Class: Text Command-Line Switch: -dirslabel

specifies the text of the label for the directory list. the default is "Directories".

• Name: dirsOn Class: DirsOn Command-Line Switch: -dirson

specifies whether or not to display the directory list. the value may be given in any of the forms acceptable to Tcl_GetBoolean. the default is true. (yes bestie, show me the dirs ✨)

• Name: fileSearchCommand Class: Command Command-Line Switch: -filesearchcommand

specifies a Tcl command to be executed to perform a file search. the command will receive the current working directory and filter mask as arguments. the command should return a list of files which will be placed into the file list.

• Name: filesLabel Class: Text Command-Line Switch: -fileslabel

specifies the text of the label for the files list. the default is "Files".

• Name: filesOn Class: FilesOn Command-Line Switch: -fileson

specifies whether or not to display the files list. the value may be given in any of the forms acceptable to Tcl_GetBoolean. the default is true.

• Name: fileType Class: FileType Command-Line Switch: -filetype

specify the type of files which may appear in the file list: regular, directory, or any. the default is regular.

• Name: filterCommand Class: Command Command-Line Switch: -filtercommand

specifies a Tcl command to be executed upon hitting the Return key in the filter combobox widget.

• Name: filterLabel Class: Text Command-Line Switch: -filterlabel

specifies the text of the label for the filter combobox. the default is "Filter".

• Name: filterOn Class: FilterOn Command-Line Switch: -filteron

specifies whether or not to display the filter combobox. the value may be given in any of the forms acceptable to Tcl_GetBoolean. the default is true.

• Name: height Class: Height Command-Line Switch: -height

specifies the height of the selection box. the value may be specified in any of the forms acceptable to Tk_GetPixels. the default is 300 pixels.

• Name: invalid Class: Command Command-Line Switch: -invalid

command to be executed should the filter contents be proven invalid. the default is {bell}. 🔔

• Name: mask Class: Mask Command-Line Switch: -mask

specifies the initial file mask string. the default is "*".

• Name: noMatchString Class: NoMatchString Command-Line Switch: -nomatchstring

specifies the string to be displayed in the files list should no files match the mask. the default is "". (the empty string, bestie, she's silent about it 💀)

• Name: selectDirCommand Class: Command Command-Line Switch: -selectdirommand

specifies a Tcl command to be executed following selection of a directory in the directory list.

• Name: selectFileCommand Class: Command Command-Line Switch: -selectfileommand

specifies a Tcl command to be executed following selection of a file in the files list.

• Name: selectionCommand Class: Command Command-Line Switch: -selectioncommand

specifies a Tcl command to be executed upon hitting the Return key in the selection combobox widget.

• Name: selectionLabel Class: Text Command-Line Switch: -selectionlabel

specifies the text of the label for the selection combobox. the default is "Selection".

• Name: selectionOn Class: SelectionOn Command-Line Switch: -selectionon

specifies whether or not to display the selection combobox. the value may be given in any of the forms acceptable to Tcl_GetBoolean. the default is true.

• Name: width Class: Width Command-Line Switch: -width

specifies the width of the selection box. the value may be specified in any of the forms acceptable to Tk_GetPixels. the default is 350 pixels.

heads up: those last two command-line switches are written exactly as they appear above — -selectdirommand and -selectfileommand. copy them character for character, no autocorrect energy, okay? 🙈

---

✨ DESCRIPTION ✨

the iwidgets::extfileselectionbox command creates an extended file selection box which is slightly different than the fileselectionbox widget. the differences are mostly cosmetic, in that the listboxes are within a panedwindow and the entryfields for the filter and selection have been replaced by comboboxes. other than that, the interface is practically the same. same vibes, cuter outfit 💅

---

✨ METHODS ✨

the iwidgets::extfileselectionbox command creates a new Tcl command whose name is pathName. this command may be used to invoke various operations on the widget. it has the following general form:

pathName option ?arg arg ...?

option and the args determine the exact behavior of the command. the following commands are possible for extfileselectionbox widgets:

---

✨ WIDGET-SPECIFIC METHODS ✨

• pathName cget option — returns the current value of the configuration option given by option. option may have any of the values accepted by the iwidgets::extfileselectionbox command.
• pathName childsite — returns the child site widget path name.
• pathName configure ?option? ?value option value ...? — query or modify the configuration options of the widget. if no option is specified, returns a list describing all of the available options for pathName (see Tk_ConfigureInfo for information on the format of this list). if option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified). if one or more option-value pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. option may have any of the values accepted by the iwidgets::extfileselectionbox command.
• pathName filter — update the current contents of the extended file selection box based on the current filter combobox value.
• pathName get — returns the current value of the selection combobox widget.

---

✨ COMPONENTS ✨

the supporting cast, the ensemble, the besties that make her shine 🌈

• Name: dirs Class: Scrolledlistbox

the dirs component is the directory list box for the extended fileselection box. see the scrolledlistbox widget manual entry for details on the dirs component item.

• Name: files Class: Scrolledlistbox

the files component is the file list box for the extended fileselection box. see the scrolledlistbox widget manual entry for details on the files component item.

• Name: filter Class: Combobox

the filter component is the field for user input of the filter value. see the combobox widget manual entry for details on the filter component item.

• Name: selection Class: Combobox

the selection component is the field for user input of the currently selected file value. see the combobox widget manual entry for details on the selection component item.

---

✨ EXAMPLE ✨

here's the moment you've been waiting for, the demo, the reveal 🎀:

package require Iwidgets 4.0 iwidgets::extfileselectionbox .fsb pack
.fsb -padx 10 -pady 10 -fill both -expand yes

she's built, she's packed, she's padded, she's expanding. main character energy, periodt 👑

---

✨ AUTHOR(S) ✨

Mark L. Ulferts Anthony Parent

(thank you for your service, legends 🫶)

---

✨ KEYWORDS ✨

extfileselectionbox, widget

---

and that's the whole page, bestie — every option, every default, every path name, nothing skipped, nothing summarised, all facts intact 💖

this one came to you from the Tk corner of the world, filed under iwidgets::extfileselectionbox(1) in the incr Widgets collection. go build something cute with her, and remember: the vibe is extended, but the facts are exactly the same as they always were. mwah 💅✨🦋