tixHList(n)

📦 version 8.4.3, in opensuse-leap 16.0

🦋 tixHList(n) — Tix Built-In Commands 🦋

okay so this is the tixHList(n) manual page from Tix Built-In Commands, and it's giving hierarchical-list realness ✨ bestie, we're building trees out here.

✨ NAME ✨

tixHList — create and manipulate Tix Hierarchial List widgets 🫶

✨ SYNOPSIS ✨

tixHList pathName ?options?

✨ STANDARD OPTIONS ✨

These are the standard options, and yes, they all count:

  • -background
  • -borderWidth
  • -cursor
  • -foreground
  • -font
  • -height
  • -highlightColor
  • -highlightThickness
  • -relief
  • -selectBackground
  • -selectForeground
  • -xScrollCommand
  • -yScrollCommand
  • -width

See the options manual entry for details on the standard options. 💅

✨ WIDGET-SPECIFIC OPTIONS ✨

  • -browsecmd browsecmd — Specifies a TCL command to be executed when the user browses through the entries in the HList widget.
  • -columns columns — Specifies the number of columns in this HList widget. This option can only be set during the creation of the HList widget and cannot be changed subsequently.
  • -command command — Specifies the TCL command to be executed when the user invokes a list entry in the HList widget. Normally the user invokes a list entry by double-clicking it or pressing the Return key.
  • -drawbranch drawBranch — A Boolean value to specify whether branch line should be drawn to connect list entries to their parents.
  • -foreground — Name: foreground; Class: Foreground; Switch: -foreground; Alias: -fg. [OBSOLETE] Specifies the default foreground color for the list entries.
  • -gap gap — [OBSOLETE] The default distance between the bitmap/image and the text in list entries.
  • -header header — A Boolean value specifying whether headers should be displayed for this HList widget (see the header widget command below).
  • -height height — Specifies the desired height for the window in number of characters.
  • -indent indent — Specifies the amount of horizontal indentation between a list entry and its children. Must be a valid screen distance value.
  • -indicator indicator — Specifies whether the indicators should be displayed inside the HList widget. See the indicator widget command below.
  • -indicatorcmd indicatorCmd — Specifies a TCL command to be executed when the user manipulates the indicator of an HList entry. The -indicatorcmd is triggered when the user press or releases the mouse button over the indicator in an HList entry. By default the TCL command specified by -indicatorcmd is executed with one additional argument, the entryPath of the entry whose indicator has been triggered. Additional information about the event can be obtained by the tixEvent command.
  • -itemtype itemType — Specifies the default type of display item for this HList widget. When you call the add and addchild widget commands, display items of this type will be created if the -itemtype option is not specified .
  • -padx padX — [OBSOLETE] The default horizontal padding for list entries.
  • -padx padY — [OBSOLETE] The default vertical padding for list entries. yes bestie, the page really has -padx twice there 😭 I'm not making the rules.
  • -selectbackground selectBackground — Specifies the background color for the selected list entries.
  • -selectborderwidth selectBorderWidth — Specifies a non-negative value indicating the width of the 3-D border to draw around selected items. The value may have any of the forms acceptable to Tk_GetPixels.
  • -selectforeground selectForeground — Specifies the foreground color for the selected list entries.
  • -selectmode selectMode — Specifies one of several styles for manipulating the selection. The value of the option may be arbitrary, but the default bindings expect it to be either single, browse, multiple, or extended; the default value is single.
  • -sizecmd sizeCmd — Specifies a TCL script to be called whenever the HList widget changes its size. This command can be useful to implement "user scroll bars when needed" features.
  • -separator separator — Specifies the character to used as the separator character when intepreting the path-names of list entries. By default the character "." is used.
  • -width width — Specifies the desired width for the window in characters.

✨ DESCRIPTION ✨

The tixHList command creates a new window (given by the pathName argument) and makes it into a HList widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the HList widget such as its cursor and relief. 🌸

The HList widget can be used to display any data that have a hierarchical structure, for example, file system directory trees. The list entries are indented and connected by branch lines according to their places in the hierachy. 🌳

Each list entry is identified by an entryPath. The entryPath is a sequence of entry names separated by the separator charactor (specified by the -separator option). An entry name can be any string that does not contain the separator charactor, or it can be the a string that contains only one separator charactor. 💅

For example, when "." is used as the separator charactor, "one.two.three" is the entryPath for a list entry whose parent is "one.two", whose parent is "one", which is a toplevel entry (has no parents).

Another examples: ".two.three" is the entryPath for a list entry whose parent is ".two", whose parent is ".", which is a toplevel entry. 🦋

✨ DISPLAY ITEMS ✨

Each list entry in an HList widget is associated with a display item. The display item determines what visual information should be displayed for this list entry. Please see the tixDisplayStyle manual page for a list of all display items. 👑

When a list entry is created by the add or addchild widget commands, the type of its display item is determined by the -itemtype option passed to these commands. If the -itemtype is omitted, then by default the type specified by this HList widget's -itemtype option is used. ✨

✨ WIDGET COMMAND ✨

The tixHList command creates a new Tcl command whose name is the same as the path name of the HList widget's window. This command may be used to invoke various operations on the widget. It has the following general form:

pathName option ?arg arg ...?

PathName is the name of the command, which is the same as the HList widget's path name. Option and the args determine the exact behavior of the command. The following commands are possible for HList widgets:

pathName add entryPath ?option value ...?

Creates a new list entry with the pathname entryPath. A list entry must be created after its parent is created (unless this entry is a top-level entry, which has no parent). This command returns the entryPath of the newly created list entry. The following configuration options can be given to configure the list entry:

  • -at position — Insert the new list at the position given by position. position must be a valid integer. the Position 0 indicates the first position, 1 indicates the second position, and so on.
  • -after afterWhich — Insert the new list entry after the entry identified by afterWhich. afterWhich must be a valid list entry and it mush have the same parent as the new list entry.
  • -before beforeWhich — Insert the new list entry before the entry identified by beforeWhich. beforeWhich must be a valid list entry and it mush have the same parent as the new list entry.
  • -data string — Specifies a string to associate with this list entry. This string can be queried by the info widget command. The application programmer can use the -data option to associate the list entry with the data it represents.
  • -itemtype type — Specifies the type of display item to be display for the new list entry. type must be a valid display item type. Currently the available display item types are imagetext, text, and window. If this option is not specified, then by default the type specified by this HList widget's -itemtype option is used.
  • -state — Specifies whether this entry can be selected or invoked by the user. Must be either normal or disabled.

The add widget command accepts additional configuration options to configure the display item associated with this list entry. The set of additional configuration options depends on the type of the display item given by the -itemtype option. Please see the tixDisplayStyle manual page for a list of the configuration options for each of the display item types. 🫶

pathName addchild parentPath ?option value ... ?

Adds a new child entry to the children list of the list entry identified by parentPath. Or, if parentPath is set to be the empty string, then creates a new toplevel entry. The name of the new list entry will be a unique name automatically generated by the HList widget. Usually if parentPath is foo, then the entryPath of the new entry will be foo.1, foo.2, ... etc. This command returns the entryPath of the newly created list entry. option can be any option for the add widget command. 💖

pathName anchor set entryPath

Sets the anchor to the list entry identified by entryPath. The anchor is the end of the selection that is fixed while the user is dragging out a selection with the mouse.

pathName anchor clear

Removes the anchor, if any, from this HList widget. This only removes the surrounding highlights of the anchor entry and does not affect its selection status.

pathName cget option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the tixHList command.

pathName column width col ?-char? ?width?

Querys or sets the width of a the column col in the HList widget. The value of col is zero-based: 0 stands for the first column, 1 stands for the second, and so on. If no further parameters are given, returns the current width of this column (in number of pixels). Additional parameters can be given to set the width of this column:

  • pathName column width col {} — pass this an empty string and the column just auto-sizes itself, like it's got main character instincts 💅 it'll be exactly wide enough to fit the widest element chillin' in that column. Heads up though: because it's sizing to the content, the width of this column can legit change whenever the elements in it change their sizes. it's giving "adaptive queen".
  • pathName column width col width — here width has to be in a form accepted by Tk_GetPixels(3). no fake numbers bestie 🙈
  • pathName column width col -char nChars — this sets the width to the average width occupied by nChars number of characters of the font specified by the -font option of this HList widget. so like, character-count energy ✨

🛠️ pathName configure ?option? ?value option value ...?

Query or modify the configuration options of the widget, classic. If no option is specified, it returns a list describing all of the available options for pathName (peep Tk_ConfigureInfo for info on the format of this list 👀). If option is specified with no value, then the command returns a list describing the one named option — and yes, this list will be identical to the corresponding sublist of the value returned if no option was specified, consistency slay. 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 tixHList command. periodt 💅

🗑️ pathName delete option ?entryPath?

Delete one or more list entries. option may be one of the following:

  • all — deletes all entries in the HList. In this case the entryPath doesn't even need to be specified, we love a low-effort icon ✨
  • entry — deletes the entry specified by entryPath and all its offsprings, if any. whole bloodline, gone 😭
  • offsprings — deletes all the offsprings, if any, of the entry specified by entryPath. but entryPath itself is not deleted — the parent stays, the kids gotta go 🙈
  • siblings — deletes all the list entries that share the same parent with the entry specified by entryPath. again, entryPath itself is not deleted. only the sibling drama gets removed 💀

🫳 pathName dragsite set entryPath

Sets the dragsite to the list entry identified by entryPath. The dragsite is used to indicate the source of a drag-and-drop action. ngl though, currently drag-and-drop functionality has not been implemented in Tix yet — so it's giving "notion of a vibe" rather than an actual feature 🫠

🧹 pathName dragsite clear

Removes the dragsite, if any, from this HList widget. And to be clear (pun intended 💅): this only removes the surrounding highlights of the dragsite entry and does not affect its selection status. the entry stays selected, we're just removing the little glow-up.

🎯 pathName dropsite set entryPath

Sets the dropsite to the list entry identified by entryPath. The dropsite is used to indicate the target of a drag-and-drop action. Same situation as above bestie — currently drag-and-drop functionality has not been implemented in Tix yet 😭

🧽 pathName dropsite clear

Removes the dropsite, if any, from this HList widget. Again: this only removes the surrounding highlights of the dropsite entry and does not affect its selection status. highlights only, no consequences ✨

🔍 pathName entrycget entryPath option

Returns the current value of the configuration option given by option for the entry identified by entryPath. Option may have any of the values accepted by the add widget command. it's literally just "tell me what this entry's set to" energy 💖

⚙️ pathName entryconfigure entryPath ?option? ?value option value ...?

Query or modify the configuration options of the list entry identified by entryPath. If no option is specified, it returns a list describing all of the available options for entryPath (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 — identical to the corresponding sublist of the value returned if no option is specified, we stay consistent 😌. If one or more option-value pairs are specified, then the command modifies the given 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 add or addchild widget command. And the exact set of options depends on the value of the -itemtype option passed to the add or addchild widget command when this list entry is created. so like, the menu of options literally changes per item type — iykyk 🌈

🏷️ pathName header option col ?args ...?

Manipulates the header items of this HList widget. If the -header option of this HList widget is set to true, then a header item is displayed at the top of each column (the crown of the column, if you will 👑). The col argument for this command must be a valid integer: 0 indicates the first column, 1 the second column, ... and so on. This command supports the following options:

  • pathName header cget col option — if the col-th column has a header display item, returns the value of the specified option of the header item. If the header doesn't exist, returns an error. no header, no answer, sorry babe 😭
  • pathName header configure col ?option? ?value option value ...? — query or modify the configuration options of the header display item of the col-th column. The header item must exist, or an error will result (rude but fair 💀). If no option is specified, it returns a list describing all of the available options for the header display item (see Tk_ConfigureInfo(3) for information on the format of this list). If option is specified with no value, the command returns a list describing the one named option — 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 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 header create widget command, and the exact set of options depends on the value of the -itemtype option passed to the header create widget command when this display item was created. context matters, always 💅
  • pathName header create col ?-itemtype type? ?option value ...? — creates a new display item as the header for the col-th column. If a header display item already exists for this column, it will be replaced by the new item, out with the old ✨. An optional parameter -itemtype can be used to specify what type of display item should be created; if the -itemtype is not given, then by default the type specified by this HList widget's -itemtype option is used. Additional parameters, in option-value pairs, can be passed to configure the appearance of the display item. Each option-value pair must be a valid option for this type of display item or one of the following:
    • -borderwidth — specifies the border width of this header item.
    • -headerbackground — specifies the background color of this header item.
    • -relief — specifies the relief type of the border of this header item.
  • pathName header delete col — deletes the header display item for the col-th column. bye bestie 👋
  • pathName header exists col — returns true if a header display item exists for the col-th column; returns false otherwise. vibe check ✅
  • pathName header size entryPath — if a header display item exists for the col-th column, returns its size in a two element list of the form {width height}; returns an error if the header display item does not exist. two numbers, one little list, no notes 🎀

🙈 pathName hide option ?entryPath?

Makes some of the entries invisible without deleting them — they're still there, just in their stealth era 🥷. Option can be one of the following:

  • entry — hides the list entry identified by entryPath.

Currently only the entry option is supported. Other options will be added in the next release 👀 so stay tuned fr fr.

🚦 pathName indicator option entryPath ?args ...?

Manipulates the indicator on the list entries. An indicator is usually a small display item (such as an image) that is displayed to the left of an entry to indicate the status of the entry. Like, for example, it may be used to indicate whether a directory is opened or closed — tiny icon, huge informational impact 💅. option can be one of the following:

  • pathName indicator cget entryPath option — if the list entry given by entryPath has an indicator, returns the value of the specified option of the indicator. If the indicator doesn't exist, returns an error. same rules as before, no indicator no tea 😭
  • pathName indicator configure entryPath ?option? ?value option value ...? — query or modify the configuration options of the indicator display item of the entry specified by entryPath. The indicator item must exist, or an error will result. If no option is specified, it returns a list describing all of the available options for the indicator display item (see Tk_ConfigureInfo(3) 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 — 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 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 indicator create widget command, and the exact set of options depends on the value of the -itemtype option passed to the indicator create widget command when this display item was created. every indicator is unique, we respect that 💖

🦋 pathName indicator create

pathName indicator create entryPath ?-itemtype type? ?option value ...?

okay so this one makes a brand-new display item that acts as the indicator for whichever entry entryPath points at. and like, if an indicator display item already exists for that entry? it gets replaced by the new one, no warning, just yeet 🫶

you can drop an optional -itemtype param to say exactly what type of display item should be created. if you don't pass -itemtype, it just uses whatever type this HList widget's -itemtype option says. and then extra params come in option-value pairs to configure how the display item looks — and every single option-value pair has to be a valid option for that type of display item. no mixing and matching bestie 💅

🎀 pathName indicator delete

pathName indicator delete entryPath

deletes the indicator display item for the entry given by entryPath. gone. bye. 💀

✨ pathName indicator exists

pathName indicator exists entryPath

returns true if an indicator display item exists for the entry given by entryPath, and false otherwise. simple vibe check, no cap.

🌸 pathName indicator size

pathName indicator size entryPath

if an indicator display item exists for the entry given by entryPath, this hands you its size as a two element list shaped like {width height}. and if the indicator display item doesn't exist? it returns an error. so like, check exists first, king 👑

👑 pathName info option arg ...

query info about the HList widget, and option can be any one of these little icons:

⭐ pathName info anchor

returns the entryPath of the current anchor (if there is one) of the HList widget. if the anchor isn't set, you get the empty string back. nothing. nada.

🍓 pathName info bbox entryPath

returns a list of four numbers describing the visible bounding box of the entry given by entryPath. the first two elements are the x and y coordinates of the upper-left corner of the screen area covered by the entry (in pixels, relative to the widget), and the last two elements are the lower-right corner of that area, also in pixels.

and here's the plot twist 😭 — if no part of the entry given by index is visible on screen, the result is an empty string. and if the entry is only partially visible, you only get the visible area. partial info for a partial appearance, iconic honestly.

🧚 pathName info children ?entryPath?

if entrpyPath is given, returns a list of the entryPath's of its children entries. otherwise it returns a list of the toplevel entryPath's. choose your fighter 💜

🎀 pathName info data ?entryPath?

returns the data associated with entryPath. that's it. that's the whole thing.

🦋 pathName info dragsite

returns the entryPath of the current dragsite (if any) of the HList widget. if the dragsite isn't set, you get the empty string.

🌈 pathName info dropsite

same energy, different site — returns the entryPath of the current dropsite (if any) of the HList widget. if the dropsite isn't set, empty string.

🔥 pathName info exists entryPath

returns a boolean value telling you whether the list entry entrpyPath exists.

💫 pathName info hidden entryPath

returns a boolean value telling you whether the list entry entrpyPath is hidden or not. sneaky little entry 🙈

🌸 pathName info next entryPath

returns the entryPath of the list entry (if any) immediately below this list entry. and if this entry is already at the bottom of the HList widget, you get an empty string. you've reached the end bestie, go touch grass.

💜 pathName info parent entryPath

returns the name of the parent of the list entry identified by entrpyPath. and if entrpyPath is a toplevel list entry, it returns the empty string — no parents, main character energy only 👑

⭐ pathName info prev entryPath

returns the entryPath of the list entry (if any) immediately above this list entry. if this entry is already at the top of the HList widget, empty string. you are literally at the ceiling.

🫶 pathName info selection

returns a list of selected entries in the HList widget. if no entries are selected, it returns an empty string — which like, valid, sometimes nobody's getting picked 😭

💅 pathName item option ?args ...?

this one creates and configures the display items sitting at individual columns of the entries. the form of the extra arguments depends on which option you pick:

🎀 pathName item cget entryPath col option

returns the current value of the configure option of the display item at the column designated by col of the entry specified by entryPath. very much "just reading the receipt" energy.

🦋 pathName item configure entryPath col ?option? ?value option value ...?

query or modify the configuration options of the display item at the column designated by col of the entry specified by entryPath. here's the breakdown:

  • if no option is specified, it returns a list describing all of the available options for entryPath (peep Tk_ConfigureInfo(3) for the deets on the format of that list).
  • if option is specified with no value, then the command returns a list describing that one named option — and that list will be identical to the corresponding sublist of the value you'd get if no option were specified. consistency slay ✨
  • if one or more option-value pairs are specified, then the command modifies the given option(s) to have the given value(s). in that case the command returns an empty string.

Option may have any of the values accepted by the item create widget command. and the exact set of options depends on the value of the -itemtype option passed to the item create widget command when this display item was created. so like, it remembers how it was born 💖

🌸 pathName item create entryPath col ?-itemtype type? ?option value ...?

creates a new display item at the column designated by col of the entry specified by entryPath. you can pass the optional -itemtype parameter to say what type of display items should be created. if -itemtype isn't specified, it defaults to the type specified by this HList widget's -itemtype option. additional parameters in option-value pairs get passed along to configure the appearance, and each option-value pair must be a valid option for this type of display item. rules are rules 🫶

💜 pathName item delete entryPath col

deletes the display item at the column designated by col of the entry specified by entryPath. poof. vanished. not me crying over a display item 😭

⭐ pathName item exists entryPath col

returns true if there's a display item at the column designated by col of the entry specified by entryPath, and false otherwise.

🧚 pathName nearest y

given a y-coordinate within the HList window, this command returns the entryPath of the (visible) HList element nearest to that y-coordinate. it's giving "which one of y'all is closest" 💅

🌈 pathName see entryPath

adjusts the view in the HList so that the entry given by entryPath is visible. if the entry is already visible, the command has no effect — don't fix what isn't broken. if the entry is near one edge of the window, the HList scrolls to bring the element into view at that edge. otherwise the HList widget scrolls to center the entry. always centering the main character ✨

👑 pathName selection option arg ...

this command adjusts the selection inside a HList widget, and it's got a few forms depending on option:

🎀 pathName selection clear ?from? ?to?

  • no extra arguments → deselects all of the list entrie(s) in this HList widget.
  • only from given → only the list entry identified by from gets deselected.
  • both from and to given → deselects all of the list entrie(s) between from and to, inclusive, without affecting the selection state of entries outside that range. respect the boundaries babes 🫶

🦋 pathName selection get

this is an alias for the info selection widget command. same thing, shorter name, we love efficiency.

🌸 pathName selection includes entryPath

returns 1 if the list entry indicated by entryPath is currently selected, and 0 otherwise. binary. iconic.

💜 pathName selection set from ?to?

selects all of the list entrie(s) between from and to, inclusive, without affecting the selection state of entries outside that range. when only from is given, only the list entry identified by from is selected. your fave gets picked and nobody else gets un-picked 💅

⭐ pathName show option ?entryPath?

shows the entries that are hidden by the hide command. option can be one of the following:

  • entry — shows the list entry identified by entryPath.
🫶 heads up: currently only the entry option is supported. other options will be added in future releases. so like, don't come for me, it's coming.

🌈 pathName xview args

this command queries and changes the horizontal position of the information in the widget's window. it can take any of these forms:

🍓 pathName xview

returns a list containing two elements. each element is a real fraction between 0 and 1, and together they describe the horizontal span that's visible in the window.

for example — if the first element is .2 and the second element is .6, then 20% of the HList entry is off-screen to the left, the middle 40% is visible in the window, and 40% of the entry is off-screen to the right. math ate that 💅 these are the same values passed to scrollbars via the -xscrollcommand option.

🧚 pathName xview entryPath

adjusts the view in the window so that the list entry identified by entryPath is aligned to the left edge of the window. left-align and thrive.

🔥 pathName xview moveto fraction

adjusts the view in the window so that fraction of the total width of the HList is off-screen to the left. fraction must be a fraction between 0 and 1. no funny business with the numbers, bestie.

okay so pathName xview scroll number what — this command shifts the view in the window left or right according to number and what. number must be an integer, periodt. what must be either units or pages or an abbreviation of one of these. If what is units, the view adjusts left or right by number character units (the width of the 0 character) on the display; if it is pages then the view adjusts by number screenfuls. If number is negative then characters farther to the left become visible; if it is positive then characters farther to the right become visible. ✨

pathName yview ?args? — this command is used to query and change the vertical position of the entries in the widget's window. It can take any of the following forms:

  • pathName yview — returns a list containing two elements, both of which are real fractions between 0 and 1. The first element gives the position of the list element at the top of the window, relative to the HList as a whole (0.5 means it is halfway through the HList, for example). The second element gives the position of the list entry just after the last one in the window, relative to the HList as a whole. These are the same values passed to scrollbars via the -yscrollcommand option. 💅
  • pathName yview entryPath — adjusts the view in the window so that the list entry given by entryPath is displayed at the top of the window.
  • pathName yview moveto fraction — adjusts the view in the window so that the list entry given by fraction appears at the top of the window. fraction is a fraction between 0 and 1; 0 indicates the first entry in the HList, 0.33 indicates the entry one-third the way through the HList, and so on.
  • pathName yview scroll number what — this command adjusts the view in the window up or down according to number and what. number must be an integer. what must be either units or pages. If what is units, the view adjusts up or down by number lines; if it is pages then the view adjusts by number screenfuls. If number is negative then earlier entries become visible; if it is positive then later entries become visible. 🦋

🎀 BINDINGS 🎀

  • [1] — If the -selectmode is "browse", when the user drags the mouse pointer over the list entries, the entry under the pointer will be highlighted and the -browsecmd procedure will be called with one parameter, the entryPath of the highlighted entry. Only one entry can be highlighted at a time. The -command procedure will be called when the user double-clicks on a list entry.
  • [2] — If the -selectmode is "single", the entries will only be highlighted by mouse <ButtonRelease-1> events. When a new list entry is highlighted, the -browsecmd procedure will be called with one parameter indicating the highlighted list entry. The -command procedure will be called when the user double-clicks on a list entry.
  • [3] — If the -selectmode is "multiple", when the user drags the mouse pointer over the list entries, all the entries under the pointer will be highlighted. However, only a contiguous region of list entries can be selected. When the highlighted area is changed, the -browsecmd procedure will be called with an undefined parameter. It is the responsibility of the -browsecmd procedure to find out the exact highlighted selection in the HList. The -command procedure will be called when the user double-clicks on a list entry.
  • [4] — If the -selectmode is "extended", when the user drags the mouse pointer over the list entries, all the entries under the pointer will be highlighted. The user can also make disjointed selections using <Control-ButtonPress-1>. When the highlighted area is changed, the -browsecmd procedure will be called with an undefined parameter. It is the responsibility of the -browsecmd procedure to find out the exact highlighted selection in the HList. The -command procedure will be called when the user double-clicks on a list entry.
  • [5] — Arrow key bindings: <Up> arrow key moves the anchor point to the item right on top of the current anchor item. <Down> arrow key moves the anchor point to the item right below the current anchor item. <Left> arrow key moves the anchor to the parent item of the current anchor item. <Right> moves the anchor to the first child of the current anchor item. If the current anchor item does not have any children, moves the anchor to the item right below the current anchor item. 👑

🌸 EXAMPLE 🌸

This example demonstrates how to use an HList to store a file directory structure and respond to the user's browse events:

tixHList .h -separator "/" -browsecmd browse -selectmode single \
   -itemtype text
.h add /         -text /
.h add /home     -text /home
.h add /home/ioi -text /home/ioi
.h add /home/foo -text /home/foo
.h add /usr      -text /usr
.h add /usr/lib  -text /usr/lib
pack .h

proc browse {file} {
    puts "$file browsed"
}

💀 BUGS 💀

The fact that the display item at column 0 is implicitly associated with the whole entry is probably a design bug. This was done for backward compatibility purposes. The result is that there is a large overlap between the item command and the add, addchild, entrycget and entryconfigure commands. Whenever multiple columns exist, the programmer should use ONLY the item command to create and configure the display items in each column; the add, addchild, entrycget and entryconfigure should be used ONLY to create and configure entries. 🫶

👑 KEYWORDS 👑

Tix(n), Hierarchical Listbox

Byeee bestie 💖 — footer tea: Tix version 4.0, manual page tixHList(n). The date line is lowkey missing from this footer, so I'm not inventing one 😭🍓

📦 where this page comes from