treeview(n)

🌸 NAME — `treeview(n)` but make it cute 🌸

treeview — create and manipulate hierarchical table widgets. This is the treeview(n) page from BLT Built-In Commands, and yes bestie, we're doing the whole thing. 💅

✨ SYNOPSIS ✨

treeview pathName ?options?

🦋 DESCRIPTION 🦋

Okay so the treeview widget displays a tree of data with styles, tags, and data sharing (via tree data objects). It's giving hierarchical data, but with accessories. ✨

🌈 INTRODUCTION 🌈

The treeview widget manages a collection of entries where each entry contains a tree node plus added style and attribute information. So every entry is a node wearing its little outfit. 👑

Entries are usually inserted into a treeview with a label-list to specify the unique hierarchical position relative to root (or the -at node); the tail of this label-list is unique within its hierarchical level. If no label is given, the generated node-id is used as the label. Labels provide a convenient way to index entries using the -> notation. eg.

treeview .t
.t insert end
.t insert end X
.t insert end A {A a} {A b} B C
.t insert end a b c {c i} {c ii}   -at root->B
set id [.t index root->B->c->i]
puts [.t get $id];        # outputs i
puts [.t get -full $id];  # outputs {B c i}
pack .t

🍓 COLUMN DATA 🍓

Column data can be stored within an entry using the -data option or entry sub-commands, eg.

treeview .t
.t column insert end X Y Z
.t insert end A -data {X 1 Y 2}
.t insert end B -data {X 3 Y 4 Z 5}
.t entry conf root->B -data {X 5 Y 4 Z 3}
.t entry set  root->A Z 3
.t entry incr root->B Y
pack .t

Labels can be created with auto-generated sequence numbers using an empty string or a trailing #auto.

treeview .t
.t column insert end X
.t insert end {}       -data {X 0};   # Label is "1"
.t insert end #auto    -data {X 1};   # Label is "2"
.t insert end Foo#auto -data {X 2};   # Label is "Foo1"
pack .t

🧚 TREE DATA OBJECT 🧚

Node data in treeview is actually stored in a tree data object, which separates data storage from widget appearance. The -tree option can be used to explicitly set a tree (externally created with the tree command) thus giving access to tree's more extensive data manipulation facilities, eg.

set t [tree create]
$t insert root -label A
$t insert root->A -label B -data {X 1}
treeview .t -tree $t
.t column insert end X
pack .t

A tree can also be attached to a treeview, eg.

set t [tree create]
$t attach [.t cget -tree]
set dump [$t dump root]
tree destroy $t

Heads up bestie: when inserting data via the tree sub-commands, unique label checking is not performed. No cap. 💀

💜 SYNTAX 💜

treeview pathName ?option value?... — the treeview command creates a new window pathName and makes it into a treeview widget. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist. Additional options may be specified on the command line or in the option database to configure aspects of the widget such as its colors and font. See the configure operation below for the exact details about what option and value pairs are valid.

If successful, treeview returns the path name of the widget. It also creates a new Tcl command by the same name. You can use this command to invoke various operations that query or modify the widget. The operations available are described in the TREEVIEW OPERATIONS section.

Treeview displays nodes as row entries in the widget. Each entry has a text label and icon. When a node has children, its entry is drawn with a small button to the left of the label. Clicking the mouse over this button opens or closes the node. When a node is open, its children are exposed. When it is closed, the children and their descendants are hidden. The button is normally a + or - symbol (ala Windows Explorer), but can be replaced with a pair of Tk images (open and closed images).

If the node has data associated with it, they can be displayed in columns running vertically on either side the tree. You can control the color, font, etc of each entry. Any entry label or data field can be edited in-place. Slay. 💅

🎀 IDS AND TAGS 🎀

Nodes can be inserted into a tree using the treeview widget

blt::treeview .t
set node [.t insert end "one"]

or tree command.

set tree [blt::tree create]
set node [$tree insert root -label "one"]
blt::treeview .t -tree $tree

In both cases, a number identifying the node is returned (the value of $node). This serial number or id uniquely identifies the node. Please note that you can't infer a location or position of a node from its id. The only exception is that the root node is always id 0. Since nodes may have the same labels or be moved within the tree, ids provide a convenient way to identify nodes. If a tree is shared, the ids will be the same regardless of whether you're using the treeview widget or the tree command. Ids are recycled only when all nodes are deleted.

A node may also have any number of tags associated with it. A tag is just a string of characters, and it may take any form except that of an integer. For example, x123 is valid, but 123 isn't. The same tag may be associated with many different nodes. This is typically done to associate a group of nodes. Many operations in the treeview widget take either node ids or tag names as arguments. Using a tag means apply the operation to all nodes with that tag.

Commands that take a tagnode will also accept a list of zero or more integer node numbers (node-list). A node-list consist of space separated integers, without leading spaces. Node lists can simplify the use of iterating commands and are used widely in the tree command.

There are four built-in or psuedo tags:

all — applies to every node in the tree.
nonroot — applies to every node in the tree except the root node.
rootchildren — applies to every node in the tree whose parent is the root node.
root — managed automatically by the tree object, root specifies the node that is currently set as the root node for the tree.

Tags are shared between clients. This means for example that tags created by the tree command are available in the treeview widget.

👑 SPECIAL NODE IDS 👑

There are several special non-numeric ids. Special ids differ from tags in that they are always translated to a single numeric node. They also take precedence over tags. For example, you can't use a tag name that is a special id. These ids are specific to the treeview widget.

active — the node where the mouse pointer is currently located. When a node is active, it is drawn using its active icon (see the -activeicon option). The active id is changed automatically by moving the mouse pointer over another node or by using the entry activate operation. Note that there can be only one active node at a time. 🖱️
anchor — the node representing the fixed end of the current selection. The anchor is set by the selection anchor operation.
bottom — the last viewable node.
current — the node where the mouse pointer is currently located. But unlike active, this id changes while the selection is dragged. It is used to determine the current node during button drags.
down — the next open node from the current focus. The down of the last open node is the same.
end — the last node at depth 1 in tree.
focus — the node that currently has focus. When a node has focus, it receives key events. To indicate focus, the node is drawn with a dotted line around its label. You can change the focus using the focus operation.
last — same as tail.
mark — the node representing the non-fixed end of the current selection. The mark is set by the selection mark operation.
next — the next open node from the current focus. But unlike down, when the focus is on last open node, next wraps around to the root node.
nextsibling — the next sibling from the node with the current focus. If the node is already the last sibling then it is the nextsibling.
parent — the parent of the node with the current focus. The parent of the root is also the root.
prev — the last open node from the current focus. But unlike up, when the focus is at root, last wraps around to the last open node in the tree.
prevsibling — the previous sibling from the node with the current focus. If the node is already the first sibling then it is the prevsibling.
root — the root node. You can also use id 0 to indicate the root.
tail — the last node in the tree, viewable or not.
top — the first node.
up — the last open node (in depth-first order) from the current focus. The up of the root node (i.e. the root has focus) is also the root.
view.top — first node that's current visible in the widget.
view.bottom — last node that's current visible in the widget.
@x,y — indicates the node that covers the point in the treeview window specified by x and y (in pixel coordinates). If no part of the entryd covers that point, then the closest node to that point is used. (Yes, the page says entryd; we're keeping the lore. 🙈)
ID->LABEL->LABEL... — lookup via node labels, eg. 0->Main->Users. Quotes can be used around labels that use reserved words or contain spaces, eg. 0->"Main"->'User Groups'. See the tree man page for more details.

A node may be specified as an id or tag. If the specifier is an integer then it is assumed to refer to the single node with that id. If the specifier is not an integer, it's checked to see if it's a special id (such as focus). Otherwise, it's assumed to be tag. Some operations only operate on a single node at a time; if a tag refers to more than one node, then an error is generated. Periodt. 💀

🍓 DATA FIELDS 🍓

okay so bestie, nodes in treeview can manage data fields associated with columns. The data is displayed in columns running on either side of the displayed tree. Any node that doesn't have a specific field will show as blank. Columns can (interactively) be resized, hidden, and, moved. 💅

Nodes can contain disjoint data fields (they aren't required to set all fields). And data manipulated via the tree command does not require an associated treeview column at all. periodt.

🧚 ARRAY REFERENCES 🧚

Like tree, treeview supports accessing data sub-fields with an array notation, eg.

treeview .t
.t col insert end A
.t insert end a -data {A "x 1 y 2 z 3"}
.t entry incr  root->a A(x)
.t entry set   root->a A(w) 0
.t entry unset root->a A(z)

Only the following treeview commands support the array notation: entry get, entry set, entry incr, entry unset, and find -column. See tree for more complete support. iykyk ✨

💜 ENTRY BINDINGS 💜

You can bind Tcl commands to be invoked when events occur on nodes (much like Tk canvas items). You can bind a node using its id or its bindtags. Bindtags are simply names that associate a binding with one or more nodes. There is a built-in tag all that all node entries automatically have. 🫶

🔥 TREEVIEW OPERATIONS 🔥

The treeview operations are invoked by specifying the widget's pathname, the operation, and any arguments that pertain to that operation. The general form is:

pathName operation ?arg arg ...?

Operation and the args determine the exact behavior of the command. The following operations are available for treeview widgets:

pathName bbox ?-screen? tagOrId... — Returns a list of 4 numbers, representing a bounding box around the specified entries. The entries are given by one or more tagOrId arguments. If the -screen flag is given, then the x-y coordinates of the bounding box are returned as screen coordinates, not virtual coordinates. Virtual coordinates start from 0 from the root node and include the title. If the -world flag is given, then the title height is added into the y coordinate. The returned list contains the following values:
- x — X-coordinate of the upper-left corner of the bounding box.
- y — Y-coordinate of the upper-left corner of the bounding box.
- width — Width of the bounding box.
- height — Height of the bounding box.
pathName bind tagName ?sequence command? — Associates command with tagName such that whenever the event sequence given by sequence occurs for a node with this tag, command will be invoked. The syntax is similar to the bind command except that it operates on treeview entries, rather than widgets. The tagName can be an entry or tag, or predefined tags such as all, Entry or Button. See the bind manual entry for complete details on sequence and the substitutions performed on command before invoking it.

If all arguments are specified then a new binding is created, replacing any existing binding for the same sequence and tagName. If the first character of command is + then command augments an existing binding rather than replacing it. If no command argument is provided then the command currently associated with tagName and sequence (it's an error if there's no such binding) is returned. If both command and sequence are missing then a list of all the event sequences for which bindings have been defined for tagName is returned.

pathName button operation ?args? — This command is used to control the button selectors within a treeview widget. It has several forms, depending on operation:
- pathName button activate tagOrId — Designates the node given by tagOrId as active. When a node is active its entry is drawn using its active icon (see the -activeicon option). Note that there can be only one active entry at a time. The special id active indicates the currently active node.
- pathName button bind tagName ?sequence command? — Associates command with tagName such that whenever the event sequence given by sequence occurs for a button of a node entry with this tag, command will be invoked. The syntax is similar to the bind command except that it operates on treeview buttons, rather than widgets. See the bind manual entry for complete details on sequence and the substitutions performed on command before invoking it.

pathName button cget option — Returns the current value of the configuration option given by option. option may have any of the values accepted by the configure operation described below.
pathName button 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 and value are described in the section BUTTON OPTIONS below.

pathName cget option — Returns the current value of the configuration option given by option. option may have any of the values accepted by the configure operation described below.
pathName close ?-recurse? ?-trees? tagOrId... — Closes the node specified by tagOrId. In addition, if a Tcl script was specified by the -closecommand option, it is invoked. If the node is already closed, this command has no effect. If the -recurse flag is present, each child node is recursively closed. The -trees flag is like -recurse but operates only on nodes with children, excluding the root.
pathName column operation ?args? — The following operations are available for treeview columns.
- pathName column activate column — Sets the active column to column. column is the name of a column in the widget. When a column is active, it's drawn using its -activetitlebackground and -activetitleforeground options. If column is "", then no column will be active. If no column argument is provided, then the name of the currently active column is returned.
- pathName column bbox ?-visible? column entry — Returns a list of 4 numbers, representing a bounding box around the specified entry's cell. Giving an entry of -1 matches the title row. If -visible is given, the width is constrained to not extend past the widget's display.
- pathName column bind column ?sequence command? — These deal with the title part of columns. Associates command with column such that whenever the event sequence given by sequence occurs for a column node entry with this tag, command will be invoked. The syntax is similar to the bind command except that it operates on treeview columns, rather than widgets. See the bind manual entry for complete details on sequence and the substitutions performed on command before invoking it.
- pathName column cget name option — Returns the current value of the column configuration option given by option for name. name is the name of a column that corresponds to a data field. option may have any of the values accepted by the configure operation described below.
- pathName column configure name ?name ...? ?option? ?value option value ...? — Query or modify the configuration options of one or more columns name. name is the name of the column corresponding to a data field. 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 and value are described in the section COLUMN OPTIONS below.
- pathName column current — Get column currently under the mouse.
- pathName column delete field ?field...? — Deletes one or more columns designated by field. Requests to delete the tree column are silently ignored. Note that this does not delete the data fields themselves.
- pathName column index index — Return the integer for index. May use "end" or end-N.

okay so the column subcommands keep rolling, and they’re lowkey carrying the whole widget rn:

pathName column insert position field ?field ...? ?options...? — inserts one (or more) columns designated by field. A column displays each entry node’s data field using this name. If the node doesn’t define the given field, the cell is left blank. position says where in the list of columns to add the new column — it can be a name, a number or end. If multiple column fields are given, only the first can start with a dash. If field is the empty string or #auto, a name is generated prefixed by the string Col and a unique integer. If field ends with #auto, the generated name uses its prefix instead. The returned values are the created column names. Note: the tree column #0 is predefined and can not be deleted. 🚨
pathName column invoke field — invokes the Tcl command associated with the column field, if there is one (using the column’s -command option). The command is ignored if the column’s -state option is set to disabled.
pathName column isset ?startOrTag? ?end? — returns a list of data columns for elements in the range that actually have data values set in them. One possible use for this might be hiding columns which are empty. With no arguments, it checks only entries on the visible screen. With one argument, it checks all entries matching a tag or id. With two arguments, it checks all entries between start and end range.
pathName column istree field — return 1 if the column is the tree column.
pathName column move name dest — moves the column name to the destination position. dest is the offset, the name of another column or a screen position in the form @x,y.
pathName column names ?-visible? ?PATTERN? — returns a list of the names of all columns in the widget. The list is ordered as the columns are drawn from left-to-right. If -visible, then display only columns where -hide is 0. A PATTERN may be specified to limit results.
pathName column nearest x ?y? — returns the name of the column closest to the given X-Y screen coordinate. If you provide a y argument (it’s optional), a name is returned only when the point is over a column’s title. 🎯
pathName column offsets — returns the starting offsets for each column.
pathName column resize op ... — operations for resize, where op is one of activate, anchor, mark or set.
pathName column see ?-anchor anchor? field — adjusts the view so that the column given by field is visible in the widget window. The node’s position on the screen can be set using the -anchor flag. Its value is a Tk anchor position: w, c, e.
pathName column values ?-visible? ?-default value? field ?start? ?end? — returns a list of data values for a column. The -visible flag excludes the values that are hidden or inside closed subtrees. The root nodes do not get included when -hideroot is true. The -default option specifies a value to substitute for unset data column cells.

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 and value are described in the section TREEVIEW OPTIONS below. ✨
pathName curselection — returns a list containing the ids of all of the entries that are currently selected. If there are no entries selected, then the empty string is returned.
pathName delete tagnode... — deletes one or more entries given by tagnode and its children. 💀
pathName edit ?-test? ?-root? ?-noscroll? ?-scroll? ?X Y? — handle cell editing. The x,y coordinates are usually required, except when using the scroll options.
- -noscroll — disable scrolling. Useful when displaying an edit subwindow.
- -scroll — re-enable scrolling. Usually bound to a destroy event of an edit subwindow.
- -root — use root coordinates.
- -test — test if edit is complete.
pathName entry operation ?args? — the following operations are available for treeview entries:
- pathName entry activate tagOrId — sets the active entry to the one specified by tagOrId. When an entry is active it is drawn using its active icon (see the -activeicon and -activeleaficon options). The special id of the currently active node is active. Note that there can be only one active node at a time and currently icons must be the same size/shape as the backgrounds are not cleared. But bind can be used to overcome these limitations. 👑
- pathName entry cget option — returns the current value of the configuration option given by option. Option may have any of the values accepted by the configure operation described below.
- pathName entry children tagOrId ?first? ?last? — returns a list of ids for the given range of children of tagOrId. TagOrId is the id or tag of the node to be examined. If only a first argument is present, then the id of the child at that numeric position is returned. If both first and last arguments are given, then the ids of all the children in that range are returned. Otherwise the ids of all children are returned.
- pathName entry configure tagnode ?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 tagnode (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 and value are described below:
- pathName entry delete tagOrId ?first ?last? — deletes the one or more children nodes of the parent tagOrId. If first and last arguments are present, they are positions designating a range of children nodes to be deleted.
- pathName entry depth tagOrId — return tree depth of node where root is 0.
- pathName entry down tagOrId — the next open node from the given node. The down of the last open node is the same.
- pathName entry exists tagOrId — return 1 if entry exists.
- pathName entry get tagOrId ?key? ?default? — return a key-field value for an entry. When no key is given, returns the values of all visible columns. If the given key is undefined, return default if given, else throw an error. Unlike entry set, the tree is accessed directly so keys not having associated columns are supported.
- pathName entry incr tagOrId key ?amount? — increment value by 1 or given amount and return the value. The incr operation normally tries to use integers, but uses doubles when one of value or amount is a double. An array reference may also be used.
- pathName entry isbefore tagOrId1 tagOrId2 — returns 1 if tagOrId1 is before tagOrId2 and 0 otherwise.
- pathName entry ishidden tagOrId — returns 1 if the node is currently hidden and 0 otherwise. A node is also hidden if any of its ancestor nodes are closed or hidden.
- pathName entry isleaf tagOrId — returns 1 if the node is a leaf node.
- pathName entry isopen tagOrId — returns 1 if the node is currently open.
- pathName entry isset tagOrId col — return true if the entry sets a column-field (has a value). The entry and column both must exist.
- pathName entry isvisible tagOrId — returns 1 if the node is visible — not hidden and not inside a closed subtree. 🦋
- pathName entry next tagOrId — the next open node from the given node. But unlike down, when the focus is on the last open node, next wraps around to the root node.
- pathName entry parent tagOrId — returns parent of the given node.
- pathName entry prev tagOrId — the last open node from the given node. But unlike up, when the focus is at root, it wraps around to the last open node in the tree.
- pathName entry relabel tagOrId newLabel — change the tree node label associated with an entry. This sets the tree node label; ie. the value returned by the get command. Note this is not the same thing as the treeview entries -label option. Also, the -allowduplicates option must be enabled to use this command as no duplicate checking will be performed. 💅
pathName entry select tagOrId — makes that node visible and gives it the focus. When you're in single selectmode, it also selects it (this calls ::blt::tv::MoveFocus) ✨
pathName entry set tagOrId col ?value col value ...? — get or set column-fields for an entry. It's the easy-peasy way to read or update fields from an entry's -data option. An array reference may also be used 🫶
pathName entry sibling ?-before? tagOrId — the next/previous sibling from the given node. If the node is already the last/first sibling then nothing is returned (sorry bestie, that's just how it is 💀).
pathName entry size -recurse tagOrId — returns the number of children of the parent node tagOrId. If the -recurse flag is set, you get the number of all its descendants instead. The node itself is not counted, no cap 🎀
pathName entry unset tagOrId col — unsets a column-field for an entry. An array reference may also be used.
pathName entry up tagOrId — the last open node (in depth-first order) from the given node. Lowkey iconic detail: the up of the last node is itself 💅
pathName entry value tagOrId ?col? — returns the value for an entry column, or every visible column if col isn't given. Unlike entry set, this gives you the formatted value from -formatcmd (if there was one) 🌸

pathName find ?flags? first last — finds all entries matching the criteria given by the flags. You get back a list of ids for all the matching nodes. first and last are ids designating the range of the search in depth-first order. If last is before first, then the nodes are searched in reverse order 🔄 The valid flags are:
- -addtag NAME — add the tag to each matching entry. The tag will be created even if no nodes are tagged (yes, it just exists now, main character energy 👑).
- -cmdargs columns — specify columns whose values are to be appended to -command.
- -command command — invoke command for each matching node. Before command is invoked, the id of the node is appended. If command generates an error, processing stops and the find operation returns an error. If command returns return, then the returned integer is used to indicate 1 for match or 0 for mismatch.
- -column col — match the name against the value of the given column. An array reference may also be used. This option must be used together with -name and may not be used with -usepath 🚫
- -count — just return the number of matches, that's it, that's the whole vibe.
- -depth number — entry must be at depth number.
- -exact — patterns must match exactly. This is the default.
- -exec string — specifies a Tcl script to be evaluated for each matching node. If -var was also specified, that variable is set with the value of the node id before each evaluation. Otherwise, percent substitutions are performed — fair warning, this is much less efficient than using either -var or -command 😭

The result of each eval gets appended to the return list, unless the script issues a CONTINUE, in which case that node is skipped.

The available percent substitutions on string are:

%# — the id of the node.
%W — the pathname of the widget.
%p — the name of the node.
%P — the full pathname of the node.
%V — the current value (the node name, node label or column value).
%F — like %V, but returns the on-screen value (from -formatcmd).
%C — the current column.
%% — translates to a single percent.

-glob — use global pattern matching. Matching is done in a fashion similar to that used by string match.
-invert — invert the meaning of the pattern match for -name.
-isclosed — include only entries that are closed.
-isempty — only match nodes where the specified -column key value was unset.
-ishidden — include only entries that are hidden, either because the entry has set -hide, or it has a style that is hidden. The root node is not included 🙈
-isleaf — entry must not have child nodes.
-ismapped — include only entries that are currently all or partly drawn on screen. The root node is not included.
-isopen — include only entries that are opened.
-istree — entry must have child nodes.
-limit number — stop searching after number matches.
-maxdepth — entry must be at depth or lower.
-mindepth — entry must be at depth or higher.
-name pattern — specifies the pattern to match against node names.
-nocase — the comparison ignores case. For -regexp, the target string gets lower cased (but not the pattern) 🔡
-notop — exclude the -top or starting node.
-regexp — use regular expression pattern matching (i.e. the same as implemented by the regexp command).
-reldepth — changes the meaning of -depth, -mindepth and -maxdepth to be relative to the -top node.
-return col — instead of the node id, return the data value of the named column. If col starts with a %, it performs percent substitution as per -command. Note that a percent substitution longer than 2 chars will append values as list elements 🫠
-top node — the search is only at node and its descendants. The default is the root node.
-useformat — compare the pattern using the -formatcmd value (if there is one) instead of the key data value.
-uselabel — compare the pattern using the label (if there is one) instead of the last component of the path.
-usepath — compare the pattern using the full path name.
-userow — compare the pattern using the node value plus the values of all keys in the row. If used with -visible, only the visible column keys are used.
-visible — exclude values that are hidden or inside closed subtrees. eg. the root node is excluded if -hideroot is true.
-withouttag NAME — match entries without the tag.
-withtag NAME — match entries with the tag.
-var variable — a variable to set with the node id before each iteration of the -exec script.
-option name value — specifies an option name and value to match against the node entry's configuration option.
-- — indicates the end of flags 🏁

pathName focus ?tagOrId? — get or set the focus to the node given by tagOrId. When a node has focus, it can receive keyboard events ⌨️ The special id focus designates the node that currently has focus.
pathName get ?-full? ?-labels? tagnode tagnode... — translates one or more ids to their node entry names. It returns a list of names for all the ids specified. If the -full flag is set, then the full pathnames are returned. If the -labels flag is set, then the full pathnames using labels are returned ✨

Note: except when called with a single node id (ie. an integer), the result will be a list (or list of lists when -separator isn't set). Don't say I didn't warn you 💀

pathName hide ?flags? tagOrId... — hides all nodes matching the criteria given by the flags. If no tagOrId are given, it traverses the entire tree. The valid flags are described below:
- -column col — match the name against the value of the given column. Must be used with -name and can not use -usepath.
- -depth number — entry must be at depth number.
- -exact — match patterns exactly. This is the default.
- -glob — use global pattern matching. Matching is done in a fashion similar to that used by string match.
- -invert — invert the meaning of the pattern match for -name or -option.
- -maxdepth — entry must be at depth or lower.
- -mindepth — entry must be at depth or higher.
- -name pattern — specifies the pattern to match against node names.
- -nocase — ignore case in the match.
- -option name value — specifies an option name and value to match against the node entry's configuration option.
- -regexp — use regular expression pattern matching (i.e. the same as implemented by the regexp command).
- -uselabel — specifies that the -name pattern is to match the label.
- -usepath — specifies that the -name pattern is to match the full path.
- -withouttag NAME — the page here says "match entries with tag", bestie 🙈 that's the literal wording — it's the mirror partner of -withtag, so read it as the without-tag one.
- -withtag NAME — match entries with the tag.
- -- — indicates the end of flags 🏁
pathName index ?-at tagOrId? ?-path? ?-quiet? string — returns the id of the node specified by string. String may be a tag or node id. Some special ids are normally relative to the node that has focus, but the -at option can be used to change this. The -path flag does a lookup using string as a path relative to the tree root (unless the -at option is given). If the -quiet flag is given, lookup failures quietly return the empty string 🤫
pathName insert position ?path? ?path? ... ?options...? — inserts one or more nodes at child position (a number or end) in the parent node. The parent node is either root or the value given by -at. The returned value is a list of ids for the new entries. Heads up: only the first path may start with a dash 💅

Like, okay, so real talk about path: it's the pathname of your shiny new node. By default pathnames are a Tcl list (each element = one path component), but you can switch that up with the -separator option, iykyk. Pathnames are normally relative to the root, but bestie the -at switch lets you pick a whole different parent node. And if path is ommitted (yes, that's the manpage's spelling, we don't edit 💅), it defaults to #auto. A path name of #auto will generate a name — it literally attempts to use the tree node name as the path name. Slay.

If the last component of a path name ends in #auto, the path is generated using the string prefix (the bit before #auto) followed by a sequential number unique within the parent, eg. .t insert end {users u#auto}.

⚠️ Heads up bestie: all ancestors of the new node must already exist, unless the -autocreate option is set. And it's also an error if a node already exists, unless -allowduplicates is set. No cap.

For large flat trees, setting -allowduplicates to true can greatly speedup loading #auto because it avoids the checking overhead. It's literally the fastest way to bulk load large numbers of nodes (next to using -tree). 🔥

The option arguments may be any of the values accepted by entry configure as described in the ENTRY OPTIONS section below, or any unabbreviated insert-option. Note that for multi-node inserts, insert-options will apply to all following nodes, and only the first path can start with a dash. 🎀

The valid insert-options are:

-at nodeid — specify the parent node to insert entries into. Default is root.
-node num — lets you specify a tree node number id directly instead of having one generated automatically. For multi-node inserts, the node number gets incremented. 🦋
-styles list — specifies a list of column/stylename pairs to set for entries having a -data option.
-tags list — specifies a list of tags to add to the new entries.

🚚 `pathName move tagnode how destId`

Moves the node(s) given by tagnode to the destination node. Bestie, lowkey important: the node cannot be an ancestor of the destination. destId is the id of the destination node and can not be the root of the tree. Together with how, it describes how the move is performed:

before — moves the node before the destination node.
after — moves the node after the destination node.
into — moves the node to the end of the destination's list of children. 🫶

🎯 `pathName nearest ?-root? ?-strict? x y ?varName?`

Returns the id of the node entry closest to the given X-Y screen coordinate. If the coordinate isn't directly over any node, then the nearest node is returned. If the argument varName is present, this is a Tcl variable that gets set to either button, icon, label, title, titlelabel, titleicon, datalabel, dataicon, or "" depending on what part of the entry the coordinate lies in. So basically it snitches on exactly where your cursor is at 👀. The -root option subtracts the window's root from the coordinates. The -strict option fails the match if you're not directly over a node, eg. in the title or past the end of the last row.

🌸 `pathName open ?-recurse? ?-parent? ?-trees? tagnode...`

Opens the one or more nodes specified by tagnode. If a node isn't already open, the Tcl script specified by the -opencommand option is invoked. If the -recurse flag is present, then each descendant is recursively opened. The -trees flag is like -recurse but operates only on nodes with children. The -parent flag ensures visibility by opening all parent nodes. Unfold the whole vibe ✨.

📏 `pathName range ?-open? first last`

Returns the ids in depth-first order of the nodes between first and last ids. If the -open flag is present, it says to consider only open nodes. If last is before first, then the ids come back in reverse order. Cute little palindrome behaviour ngl.

🖱️ `pathName scan option args`

This command implements scanning, and it has two forms depending on option:

pathName scan mark x y — records x and y and the current view in the treeview window; used in conjunction with later scan dragto commands. Typically this is associated with a mouse button press in the widget. It returns an empty string.
pathName scan dragto x y. — computes the difference between its x and y arguments and the x and y arguments to the last scan mark command for the widget. It then adjusts the view by 10 times the difference in coordinates. This command is typically associated with mouse motion events in the widget, to produce the effect of dragging the list at high speed through the window. The return value is an empty string. 🌀

👀 `pathName see ?-anchor anchor? tagOrId`

Adjusts the view of entries so that the node given by tagOrId is visible in the widget window. It's an error if tagOrId is a tag that refers to more than one node (not me trying to see three nodes at once 😭). The node's position on the screen can be set using the -anchor flag. Its value is w, but can be any one of the Tk anchor positions.

💖 `pathName selection option arg`

This command is used to adjust the selection within a treeview widget. It has several forms, depending on option:

pathName selection anchor ?tagOrId? ?column? — sets the selection anchor to the node given by tagOrId. If tagOrId refers to a non-existent node, then the closest node is used. The selection anchor is the end of the selection that stays fixed while dragging out a selection with the mouse. The special id anchor may be used to refer to the anchor node. With no arguments, returns the anchor entry and column if any.
pathName selection cells — returns pairs of nodes and columns for all selected cells. The -selectmode must be cell or multicell.
pathName selection clear first ?last? ?column? — removes the entries between first and last (inclusive) from the selection. Both first and last are ids representing a range of entries. If last isn't given, then only first is deselected. Entries outside the selection are not affected. 🫧
pathName selection clearall — clears the entire selection. Poof, gone, periodt.
pathName selection mark tagOrId ?column? — sets the selection mark to the node given by tagOrId. This causes the range of entries between the anchor and the mark to be temporarily added to the selection. The selection mark is the end of the selection that stays fixed while dragging out a selection with the mouse. The special id mark may be used to refer to the current mark node. If tagOrId refers to a non-existent node, then the mark is ignored. Resetting the mark will unselect the previous range. Setting the anchor finalizes the range.
pathName selection includes tagOrId ?column? — returns 1 if the node given by tagOrId is currently selected, 0 if it isn't.
pathName selection present — returns 1 if any nodes are currently selected and 0 otherwise.
pathName selection set first ?last? ?column? — selects all of the nodes in the range between first and last, inclusive, without affecting the selection state of nodes outside that range.
pathName selection toggle first ?last? ?column? — selects/deselects nodes in the range between first and last, inclusive. If a node is currently selected, it becomes deselected, and visa versa. Flip flop energy 🦋.

🌈 `pathName show ?flags? tagOrId...`

Un-hides nodes matching the criteria given by flags. If no tagOrId are given, it traverses the entire tree. The flags are the same as for the hide command.

🔀 `pathName sort ?operation? args...`

pathName sort auto ?boolean — turns on/off automatic sorting of node entries. If boolean is true, entries will be automatically sorted as they are opened, closed, inserted, or deleted. If no boolean argument is provided, the current state is returned.
pathName sort cget option — returns the current value of the configuration option given by option. Option may have any of the values accepted by the configure operation described below.
pathName sort configure ?option? ?value option value ...? — query or modify the sorting configuration options of the widget. If no option is specified, returns a list describing all the available options for pathName (see 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 (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 sorting option(s) to have the given value(s); in this case the command returns an empty string. Option and value are described below:
- -column string — specifies the column to sort. Entries in the widget are rearranged according to this column. If column is "" then no sort is performed. ✨
- -command string — specifies a Tcl procedure to be called when sorting nodes. The procedure is called with 6 arguments: the pathname of the widget, the node id of two entries, the column key being sorted and the label values of the two entries. The procedure returns 1 if the first node is greater than the second, -1 if the second is greater, and 0 if equal. Iconic comparator behaviour, honestly 👑.
-decreasing boolean — says whether we sort ascending or descending. If boolean is true, then the entries go in descending order. Default is no, bestie. 💅
-mode string — specifies how to compare entries when sorting. String may be one of the following:
- ascii — plain string comparison based upon the ASCII collation order.
- dictionary — dictionary-style comparison. Same as ascii except (a) case is ignored except as a tie-breaker and (b) if two strings contain embedded numbers, the numbers compare as integers, not characters. For example, "bigBoy" sorts between "bigbang" and "bigboy", and "x10y" sorts between "x9y" and "x11y". ✨
- integer — compares fields as integers.
- real — compares fields as floating point numbers.
- command — use the Tcl proc specified by the -command option to compare entries when sorting. If no command is specified, the sort reverts to dictionary sorting.
-setflat bool — used by SortColumn to remember if the tree was forced to flat by a sort.

🔀 `pathName sort once ?flags? tagOrId...`

Sorts the children for each entries specified by tagOrId. By default, entries are sorted by name, but you can specify a Tcl proc to do your own comparisons. Iconic.

-recurse — recursively sort the entire branch, not just the children. Go deeper. 🕳️

🎨 `pathName style operation ?args?`

Styles control how data is going to be rendered by the widget. They get created with the create subcommands (described below, keep reading bestie). A default style name text is builtin. It's of type textbox and is used as the default style for columns. Styles may also be applied to entries, individual cells or widget options — like, the -altstyle option applies a style to every second visible row entry, while the -levelstyles option can specify a different style for each node level. The range?? Unmatched. 🌈

The following operations are available for treeview styles.

`pathName style activate ?entry? ?column?`

Get or sets a particular cell as state to active. With two arguments, sets the current cell to active. With no arguments, returns the active cell. With one argument whose entry is 0, sets no cell to active.

`pathName style cget stylename option`

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the configure operation described below.

`pathName style configure ?stylename 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 and value are described below:

🧚 `pathName style create ...?`

Create a named style. For a full list of style options, see the section STYLE OPTIONS below. 👀

pathName style create barbox stylename ?option value option value ...? — a barbox displays numeric data plus a progressbar. So satisfying fr.
pathName style create checkbox stylename ?option value option value ...? — a checkbox style displays boolean or 2-valued data.
pathName style create combobox stylename ?option value option value ...? — a combobox style displays multi-valued data.
pathName style create textbox stylename ?option value option value ...? — a textbox style displays general text data.
pathName style create windowbox ?stylename? ?option value option value ...? — the special style windowbox suports embedding subwindows within data cells. (Yes, "suports". We keep the typo, it's canon. 💀)

`pathName style find stylename ?column? ?node? ...`

Get all entries with the given style for a given column in the given nodes. When no column is given, looks in entry and data columns. Duplicates are not eliminated. Then the original page just kinda... says cell. and nothing else, which is giving cryptic queen energy 🙈

`pathName style forget stylename ...`

Eliminates one or more style names whose reference count have reached zero (i.e. nothing is using it). Requests to delete styles that are still in use are quietly ignored. Note that the reference count of style text is always greater than zero, so don't even try it with that one. 🫶

`pathName style get column tagorid`

Return the style(s) for column and nodes. And again the page trails off with cell. 😭

`pathName style highlight stylename ?on|off?`

Turns on/off highlighting for a particular style. Used primarily for columns.

`pathName style names`

Lists the names of all the current styles in the treeview widget.

`pathName style priority column node`

Get the priority style for the given cell. (The original manpage mangles this one with %.TP % all over it — we cleaned up the macros, the facts are untouched. 💅)

`pathName style set stylename column node ...`

Sets a style for a given column for all the ids given. If column is the tree, sets the entry style, otherwise sets the style in the data column, thus setting the style for a single cell in an entry. The style name may be an empty string to unset the style. Cells that do not have a value may not have a style set and so are silently ignored. The number of cells that actually get set with a style is returned. Count 'em. 🔥

`pathName style slaves ?-col col? ?-id node? ?-style styleName? ?-visible bool? ?-info path?`

With no arguments, lists all embedded window slaves.

-col — shows only windows in the given column.
-id — shows only windows for the given entry.
-style — shows only windows with the given style.
-visible — shows only windows that are visible or invisible.
-info — dumps all information for a single window.

`pathName style type ?name? ?newtype?`

With no arguments, return list of all available styles. With one argument, return the style type of name. With two arguments, change the style type of name to newtype, and reset all style options back to the defaults. Glow-down-and-reset moment 💅

`pathName style use stylename`

Return the use count for a style. Note: in order to remove a style with style forget, this count must be 0.

🏷️ `pathName tag operation args`

Tags are a general means of selecting and marking nodes in the tree. A tag is just a string of characters, and it may take any form except that of an integer. The same tag may be associated with many different nodes. Very main-character-of-many-scenes of it.

Both operation and its arguments determine the exact behavior of the command. The operations available for tags are listed below.

pathName tag add string ?id...? — adds the tag string to one of more entries. If no nodes are given, just creates the tag.
pathName tag delete string tagnode... — deletes the tag string from one or more entries.
treeName tag exists string ?id? — if an id is given, return 1 (or 0) if entry has (or hasn't) the tag. Otherwise, returns 1 if at least one entry has tag string. (Note it's treeName there, not pathName — that's how the page says it. 🤝)
pathName tag forget string — removes the tag string from all entries. It's not an error if no entries are tagged as string.
pathName tag names ?id? — returns a list of tags used. If an id argument is present, only those tags used by the node designated by id are returned.
pathName tag nodes name ?name ...? — returns a list of ids that have any of the name tags. If no node is tagged as name, then an empty list is returned.

🔓 `pathName toggle tagnode`

Opens or closes the node given by tagOrId. If the corresponding -opencommand or -closecommand option is set, then that command is also invoked. Double the command, double the chaos 🫶

↔️ `pathName xview args`

This command is used to query and change the horizontal position of the information in the widget's window. It can take any of the following forms:

`pathName xview`

Returns a list containing two elements. Each element is a real fraction between 0 and 1; together they describe the horizontal span that is visible in the window. For example, if the first element is .2 and the second element is .6, 20% of the treeview widget's text is off-screen to the left, the middle 40% is visible in the window, and 40% of the text is off-screen to the right. These are the same values passed to scrollbars via the -xscrollcommand option. Math ate, honestly. 🌸

okay so, finishing up the horizontal scrolling bits of the operations section, bestie 💅

pathName xview tagOrId — adjusts the view in the window so the character position given by tagOrId is displayed at the left edge of the window. Character positions are defined by the width of the character 0. slay.
pathName xview moveto fraction — adjusts the view so fraction of the total width of the treeview widget's text is off-screen to the left. fraction must be a fraction between 0 and 1.
pathName xview scroll number what — shifts the view left or right according to number and what. number must be an integer. 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, the view adjusts by number screenfuls. If number is negative, characters farther to the left become visible; if it is positive, characters farther to the right become visible.

pathName yview ?args? — this command queries and changes the vertical position of the text in the widget's window. It can take any of the following forms:

pathName yview — returns a list containing two elements, both real fractions between 0 and 1. The first element gives the position of the node at the top of the window, relative to the widget as a whole (0.5 means it is halfway through the treeview window, for example). The second element gives the position of the node just after the last one in the window, relative to the widget as a whole. These are the same values passed to scrollbars via the -yscrollcommand option.
pathName yview tagOrId — adjusts the view in the window so the node given by tagOrId is displayed at the top of the window.
pathName yview moveto fraction — adjusts the view so the node given by fraction appears at the top of the window. fraction is a fraction between 0 and 1; 0 indicates the first node, 0.33 indicates the node one-third the way through the treeview widget, and so on.
pathName yview scroll number what — adjusts the view 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, the view adjusts by number screenfuls. If number is negative, earlier nodes become visible; if it is positive, later nodes become visible.

🌸 TREEVIEW EDITING 🌸

A column of data is editable when its -edit option is set to True. For column 0, edit changes an entry's -label option. For all other columns, edit will update the -data fields. Tree data traces can also be used for edit control. Most of the following applies to textbox styles. However, combobox and checkbox also generate <<TreeViewEditStart/End>> events, while barbox and windowbox are not editable.

Text editing is aborted with <Escape> and finished with <Return>. A newline may be inserted with a <Control-r>. Native Tk widgets are now used for builtin editing, using the path $w.edit. By default an entry widget will be used, however, column editing options can be changed via -editopts and -validatecmd. Moreover, columns with a combobox style can provide a popup list of options in a listbox using the following style options: -choices, -choicecmd, -choicekey, -choiceicons.

Two virtual events can be used to gain control during edit: <<TreeViewEditStart>> and <<TreeViewEditEnd>>. The column index is passed in %x, and the entry-row index is passed in %y. eg.

treeview .t
bind .t <<TreeViewEditStart>> {EditStart %W %x %y}
bind .t <<TreeViewEditEnd>> {EditEnd %W %x %y}

These gain control at the start and end of editing respectively, and are general alternatives to -editopts -startcmd and -endcmd. For further details see blt::tv::EditCell in $blt_library/treeview.tcl. iykyk 🫶

👑 TREEVIEW OPTIONS 👑

In addition to the configure operation, widget configuration options may also be set by the Tk option command. The class resource name is TreeView.

option add *TreeView.Foreground white
option add *TreeView.Background blue

The following widget options are available:

-activeicons images — specifies images to be displayed for an entry's icon when it is active. images is a list of two Tk images: the first image is displayed when the node is open, the second when it is closed.
-activeleaficons images — specifies images to be displayed for a leaf entry's icon when it is active. images is a list of two Tk images: the first image is displayed when the node is open, the second when it is closed.
-allowduplicates boolean — if boolean is true, allow nodes with duplicate pathnames when inserting new nodes. Otherwise flag an error. The default is no.
-altstyle stylename — set a style to use on every other row. This provides a simple way to implement alternating row colors without explicitly setting entry options. Note -altstyle has limitations. Mostly it is used for setting the background, foreground and tile. Currently the font will not be used in height sizing, and the icon is ignored.
-autocreate boolean — if boolean is true, automatically create missing ancestor nodes when inserting new nodes. Otherwise flag an error. The default is no.
-background color — sets the background color of the widget. The default is white.
-borderwidth pixels — sets the width of the 3-D border around the outside edge of the widget. The -relief option determines if the border is to be drawn. The default is 2.
-button string — indicates whether entries should display a button. If set to anything other than the default of auto, buttons will not be displayed.
-closecommand string — specifies a Tcl script to be invoked when a node is closed. You can override this for individual entries using the entry's -closecommand option. The default is "". Percent substitutions are performed on string before it is executed. The following substitutions are valid:
- %W — the pathname of the widget.
- %p — the name of the node.
- %P — the full pathname of the node.
- %# — the id of the node.
- %% — translates to a single percent.
-columnshowhighlight bool — enable display highlight color when column activated. Default is false.
-cursor cursor — specifies the widget's cursor. The default cursor is "".
-dashes number — sets the dash style of the horizontal and vertical lines drawn connecting entries. number is the length in pixels of the dashes and gaps in the line. If number is 0, solid lines will be drawn. The default is 1 (dotted).
-emptystyle stylename — set a style to be used for empty cells.
-entryshowhighlight bool — enable display highlight color when entry activated. Default is false.
-exportselection boolean — indicates if the selection is exported. If the widget is exporting its selection then it will observe the standard X11 protocols for handling the selection. Selections are available as type STRING; the value of the selection will be the label of the selected nodes, separated by newlines. The default is no.
-fillnull boolean — indicates that empty data columns are to be drawn anyways, and to apply the -nullstyle if defined. Turning this off will leave unsightly gaps where attributes (eg. background and underline) were normally expected to be displayed. The default is yes.
-flat boolean — indicates whether to display the tree as a flattened list. If boolean is true, then the hierarchy will be a list of full paths for the nodes. Hide and show are not supported in flat mode. This option also has an effect on sorting. See the sort command for more information. The default is no.
-focusdashes dashList — sets the dash style of the outline rectangle drawn around the entry label of the node that currently has focus. Number is the length in pixels of the dashes and gaps in the line. If number is 0, a solid line will be drawn. The default is 1.
-focusforeground color — sets the color of the focus rectangle. The default is black.
-focusheight value — set the height in pixels to reserve for focus highlighting above and below the line. The default is 1, but setting this to 0 will result in a more compact display.
-font fontName — specifies the font to use for text. The default is TkDefaultFont.
-foreground color — sets the text color of entry labels. You can override this for individual entries with the entry's -foreground configuration option. The default is black.
-height pixels — specifies the requested height of widget. The default is 400.
-formatcmd scriptcmd — command called to format the displayed data value. Percent substitutions are performed on scriptcmd as per find -exec. The called command returns the value to be displayed. This may be overridden by column or style -formatcmd. For the tree column, has no effect when using -showfull with -flat.
-hidedataicons boolean — if boolean is true, it indicates that data column icons (set via styles) should not be displayed. The default is no.
-hidedatatext boolean — if boolean is true, it indicates that data column text should not be displayed. The default is no.
-hideicons boolean — if boolean is true, it indicates that tree column icons should not be displayed. The default is no.
-hideleaves boolean — if boolean is true, it indicates that no leaves should be displayed. The default is no.

and yes, there are still more options coming, bestie — don't blink ✨

-hideroot boolean — if boolean is true, the root node gets no entry drawn for it at all. Default is no, so the root is out there living its visible life by default. 🫶
-highlightbackground color — the normal color of the traversal highlight region, i.e. what it looks like when the widget does not have the input focus. Chill background highlight vibes.
-highlightcolor color — the color of the traversal highlight rectangle when the widget has the input focus. Default is black. It's giving "look at me, I'm focused" 💅
-highlightthickness pixels — width of that highlight rectangle that shows the widget has input focus. The value can be any of the forms acceptable to Tk_GetPixels. If it's zero, no focus highlight is displayed at all (bold move). Default is 2.
-icons images — the images for the entry's icon. Images is a list of two Tk images: the first one shows when the node is open, the second when it's closed. Open/closed, two moods, two icons ✨
-imagecmd scriptcmd — hands you a command to call the first time an image is displayed, for any image used in the -images, -*icon, and -*icons options. Percent substitutions get performed on scriptcmd as per find -exec, with the image name as the value (%V). The command that gets called can either modify the image or set a new icon.

The main use of -imagecmd is to do image loading on demand, as images become visible for the first time. To use it, an icon option has to be set with a placeholder image. When that placeholder first becomes visible, the callback replaces it with a real image. The callback can also add tags, styles, or even dynamically load data, like:

proc ICMD {w id col img} {
  $w entry conf $id -icon blt::tv::normalFile
  #$img conf -file [GetFile $id $col]
  $w tag add addimg $id
}

pack [treeview .t -imagecmd {ICMD %W %# %C %V}]
foreach i {A B C} {
  .t insert end  $i -icons [image create photo]
}

-inlinedata bool — lets data column values that start with a @ and are a list of length 2 be interpreted as an inline style or image name. If the value is the name of an image, a style is created using the name of the image with -icon set to that image. A style gets applied to the cell in the manner of style set. Default is true. ✨
-insertfirstnum — on inserts, it does a forward search of the tree label for num elements, then falls back to a reverse search. Default is 1, which gives you super fast insertions at the beginning or near the end of really long trees. Set it to -1 for forward search only — for example, if you're using -allowduplicates. (iykyk about those duplicate-laden trees 😭)
-leaficons images — the images for a leaf entry's icons. Images is a list of two Tk images: the first shows when the node is open, the second when it's closed. Same deal as -icons but for the leaves 🍓
-levelpad pixels — indentation to add when displaying sub-tree levels. Nesting, but make it spaced out.
-levelstyles stylenames — set a list of styles to use for entries at a given level. The first style is for entries at level 1, the second for level 2, etc. It's a simple way to specify colors for entries at a given level without explicitly setting entry options. Lazy girl method, and honestly iconic 👑
-linecolor color — sets the color of the connecting lines drawn between entries. Default is black.
-linespacing pixels — sets the number of pixels of spacing between entries. Default is 0.
-linewidth pixels — width of the lines drawn connecting entries. If pixels is 0, no vertical or horizontal lines are drawn. Default is 1.
-minheight pixels — sets the minimum height for entries. Default is 0.
-nextautonum — for inserts at the root node, this is the start number for the next #auto insert. It's automatically incremented on each insert, which speeds up bulk #auto inserts. Bulk mode = slay 🔥
-nextsubautonum — for inserts not into the root node, this is the number the next child #auto insert starts its search from. Default is 1.
-newtags boolean — if boolean is true, when you're sharing a tree object (see the -tree option), don't share its tags too. Default is 0.
-noautocloseleaf boolean — if boolean is true, opening a leaf node leaves it in open mode. Default is false, which automatically sets the mode of a leaf node back to closed without invoking -closecommand. So by default the leaf just quietly closes itself, no drama 💀
-nofocusselectbackground color — background select color when focus is lost.
-nofocusselectforeground color — foreground select color when focus is lost.
-openanchor string — when a node with children is opened, this defines the -anchor used to the see sub-command. Must be one of: n c s. Default is c.
-opencommand string — specifies a Tcl script to be invoked when a node is open. You can override this per entry with the entry's -opencommand configuration option. Default is "". Percent substitutions get performed on string before it's executed. Valid substitutions:
- %W — the pathname of the widget.
- %p — the name of the node.
- %P — the full pathname of the node.
- %# — the id of the node.
- %% — translates to a single percent.
-padx pixels — padding on the left and right of the widget.
-pady pixels — padding on the top and bottom of the widget.
-relief relief — the 3-D effect for the widget. Relief says how the treeview widget should appear relative to the widget it's packed into; for example, raised means the treeview widget should appear to protrude. Default is sunken. 🫧
-resizecursor string — cursor to use on resize.
-rootnode num — specify the node number that's gonna be the root. This lets a subtree appear as the root. Multiple treeviews can share a tree with different root nodes, which supports subviews. Default is 0. Main character energy, but for nodes 👑
-scrollmode mode — the style of scrolling to be used. There are three different modes: listbox, canvas, and hierbox. In listbox mode the last entry can always be scrolled to the top of the widget. In hierbox mode the last entry is always drawn at the bottom of the widget. Default is hierbox.
- listbox — like the listbox widget, the last entry can always be scrolled to the top of the widget window. This lets the scrollbar thumb shrink as the last entry is scrolled upward.
- hierbox — like the hierbox widget, the last entry can only be viewed at the bottom of the widget window. The scrollbar stays a constant size.
- canvas — like the canvas widget, the entries are bound within the scrolling area.
-scrolltile bool — specifies if tiling should scroll with the widget. Default is false.
-selectbackground color — sets the background color of selected node entries. Default is #ffffea. Pastel selection moment 🌸
-selectborderwidth pixels — sets the width of the raised 3-D border drawn around the labels of selected entries. Default is 0.
-selectcommand string — specifies a Tcl script to invoke when the set of selected nodes changes. Default is "".
-selectforeground color — sets the color of the labels of selected node entries while the widget has focus. Default is black.
-selectmode mode — the selection mode. If mode is single, only one node can be selected at a time. If multiple, more than one node can be selected. If none, no selection is displayed. If cell or multicell, then selection is for cells rather than whole nodes (rows). Default is single.
-selectrelief relief — the 3-D effect of the selected text in the edit window. Relief indicates how the text should appear relative to the edit window; for example, raised means the text should appear to protrude. Default is flat.
-selecttile image — set a tile background image to use for selection.
-separator string — the character sequence to use when splitting the path components. The separator can be several characters wide (like "::"). Consecutive separators in a pathname are treated as one. If string is the empty string, pathnames are Tcl lists. If string is none, no splitting is done. Each element is a path component. Default is "".
-showfull boolean — show the full path name when in -flat mode. Default is true.
-showtitles boolean — if boolean is false, column titles are not displayed. Default is yes. (Titles are lowkey the moment, but you do you 💅)
-sortselection boolean — if boolean is true, nodes in the selection are ordered as they're currently displayed (depth-first or sorted), not in the order they were selected. Default is no.
-stylecommand string — specifies a Tcl command to handle references to unknown styles. The call performs the same substitutions as the -exec option in the find command, except string is used for %V. The called command is expected to create the style. Default value is "%W style create textbox %V".

Dynamic creation is performed for any style used in the configure subcommands. It also handles inline data of the form for the image passed after the @ sign (see the -inlinedata option). ✨

-substyle stylename — set a style for use with the -sublabel. Heads up: you can hide all sublabels by using a style with the -hide option set. 🙈
-takefocus focus — info used when moving the focus from window to window via keyboard traversal (e.g. Tab and Shift+Tab). If focus is 0, this window gets skipped entirely during keyboard traversal. 1 means this window should always receive the input focus. An empty value means the traversal scripts make the decision whether to focus on the window. Default is "1".
-tile image — set background tile image.
-titlefont font — font to use for titles. 🎀
-titlepad N — pad to add above and below the title.
-tree tree — use an externally created data tree object. Using a tree command facilitates data access, tracing, and loading/saving. eg.

set t [tree create]
set n 0
while {[incr n]<30000} {
   $t insert end -data {A 0 B 0}
}
pack [treeview .tv -tree $t]
.tv column insert end A B

-trim string — specifies a string of leading characters to trim from entry pathnames before parsing. This only makes sense if the -separator is also set. The default is "". lowkey only useful when separators are in the chat 💅
-underline height — draw an underline of the given height below each entry across its entire width. Use it in conjunction with column reliefs and it provides a grid-like effect. The default height is 0. grid moment ✨
-width pixels — sets the requested width of the widget. If pixels is 0, then the width is computed from the contents of the treeview widget. The default is 200.
-xscrollcommand string — specifies the prefix for a command used to communicate with horizontal scrollbars. Whenever the horizontal view in the widget's window changes, the widget will generate a Tcl command by concatenating the scroll command and two numbers. If this option is not specified, then no command will be executed. horizontal scroll bestie realness 🦋
-xscrollincrement pixels — sets the horizontal scrolling distance. The default is 20 pixels.
-yscrollcommand string — specifies the prefix for a command used to communicate with vertical scrollbars. Whenever the vertical view in the widget's window changes, the widget will generate a Tcl command by concatenating the scroll command and two numbers. If this option is not specified, then no command will be executed.
-yscrollincrement pixels — sets the vertical scrolling distance. The default is 20 pixels.

💖 ENTRY OPTIONS 💖

Many widget configuration options have counterparts in entries. For example, there is a -closecommand configuration option for both the widget itself and for individual entries. Options set at the widget level are global for all entries. If the entry configuration option is set, then it overrides the widget option. They do it this way so we're not wasting memory by replicating options everywhere — most entries will have redundant options.

There is no resource class or name for entries. periodt 🎀

-activeicons images — specifies images to be displayed as the entry's icon when it is active. This overrides the global -activeicons configuration option for the specific entry. Images is a list of two Tk images: the first image is displayed when the node is open, the second when it is closed.
-bindtags tagList — specifies the binding tags for nodes. TagList is a list of binding tag names. The tags and their order will determine how events are handled for nodes. Each tag in the list matching the current event sequence will have its Tcl command executed. The default value is all.
-button string — indicates whether a button should be displayed on the left side of the node entry. String can be yes, no, or auto. If auto, then a button is automatically displayed if the node has children. This is the default. auto button slay 🔘
-closecommand string — specifies a Tcl script to be invoked when the node is closed. This overrides the global -closecommand option for this entry. The default is "". Percent substitutions are performed on string before it is executed. The following substitutions are valid:
- %W — the pathname of the widget.
- %p — the name of the node.
- %P — the full pathname of the node.
- %# — the id of the node.
- %% — translates to a single percent.
-data list — initializes or changes data fields for the node. List is a list of name-value pairs to be set. Note: this can not be used to unset or forget values for columns, meaning an empty list does nothing. For unsetting use entry unset. The default is "".
-font fontName — sets the font for entry row text. This overrides the widget's -font option for this node.
-forcetree bool — force the node to be treated as a tree, even if it has no children. This differs from -button above in that all drawing and querying aspects of the node are treated as a tree. This option is useful primarily for deferring loading until a tree is opened. The default is false. deferred loading icon behavior ✨
-foreground color — sets the text color of the entry label. This overrides the widget's -foreground configuration option. The default is "".
-height num — set height for the entry.
-hide bool — hide the entry. ninja mode 🙈
-icons images — specifies images to be displayed for the entry's icon. This overrides the global -icons configuration option. Images is a list of two Tk images: the first image is displayed when the node is open, the second when it is closed.
-isopen bool — specify if the entry is in the open state. The default is false.
-label string — sets the text for the entry's displayed label. If set to "", the label of the tree node is displayed. The default is "" (see entry relabel).
-opencommand string — specifies a Tcl script to be invoked when the entry is opened. This overrides the widget's -opencommand option for this node. The default is "". Percent substitutions are performed on string before it is executed. The following substitutions are valid:
- %W — the pathname of the widget.
- %p — the name of the node.
- %P — the full pathname of the node.
- %# — the id of the node.
- %% — translates to a single percent.
-shadow color — set shadow color for text.
-state value — set the state of the entry, where value is one of: normal, active, disabled. The default state is normal. When the state is set to disabled, the text color displays using -disabledforeground and the node ignores any attempted open or close. no opening, no closing, we said what we said 💀
-style stylename — set the style to use for the entry. This will override the column style, just as style set will override an entry style. This is useful mostly for setting bg/fg/font for a row. Other options may or may not do nothing. Note, setting icon in a style will apply to all value columns, but not the tree column. styling era 💅
-sublabel string — sets the text for the entry's sub-label to be displayed to the right of the node's -label value. This is rendered using the -substyle style.
-underline num — character to underline in an entry's text label. Default is -1.
-userdata list — extra space available for storing user data.

🔘 BUTTON OPTIONS 🔘

Button configuration options may also be set by the option command. The resource subclass is Button. The resource name is always button. iykyk 🫶

option add *TreeView.Button.Foreground white
option add *TreeView.button.Background blue

The following are the configuration options available for buttons.

-activebackground color — sets the background color of active buttons. A button is made active when the mouse passes over it or by the button activate operation.
-activeforeground color — sets the foreground color of active buttons. A button is made active when the mouse passes over it or by the button activate operation.
-activeimages images — specify images to use for active buttons.
-background color — sets the background of the button. The default is white.
-borderwidth pixels — sets the width of the 3-D border around the button. The -relief option determines if a border is to be drawn. The default is 1.
-closerelief relief — specifies the 3-D effect for the closed button. Relief indicates how the button should appear relative to the widget; for example, raised means the button should appear to protrude. The default is solid.
-cursor cursor — sets the widget's cursor. The default cursor is "".
-foreground color — sets the foreground color of buttons. The default is black.
-images images — specifies images to be displayed for the button. Images is a list of two Tk images: the first image is displayed when the button is open, the second when it is closed. If images is the empty string, then a plus/minus gadget is drawn. The default is "". plus/minus gadget is iconic ngl ✨
-openrelief relief — specifies the 3-D effect of the open button. Relief indicates how the button should appear relative to the widget; for example, raised means the button should appear to protrude. The default is flat.
-size pixels — sets the requested size of the button. The default is 0.

💅 STYLE OPTIONS 💅

okay so there are exactly five style types and that's the whole menu, bestie: textbox, combobox, checkbox, barbox, windowbox. Autocreated styles come out as type textbox by default. A barbox gives you progressbars for numeric cell values. And the special windowbox style is the one that supports embedded subwindows right inside data cells. 🪟✨

The resource subclass is just the name of the style, titlized, ie.

option add *TreeView.TextBoxStyle.tvBackground white
option add *TreeView.ComboBoxStyle.tvBackground green
option add *TreeView.CheckBoxStyle.tvBackground blue

A default textbox style named text comes predefined and is set for each columns -style option. Styles can also be associated with entry-rows and/or cells, like this:

treeview .t -width 300 -height 200
pack .t -fill both -expand y
 .t col insert end Size Age Weight
 .t style create combobox MyStyle0 -bg red
 .t style create textbox MyStyle1 -bg blue
 .t style create textbox MyStyle2 -bg green
 .t style create textbox MyStyle3 -bg orange

 .t col conf Size -style MyStyle0
 foreach i {Able Baker Charlie} {
  .t insert end $i -data {Size 1 Age 2 Weight 3}
 }
 .t entry conf 2 -style MyStyle2
 .t style set MyStyle3 Weight 3
 .t insert end Empty
 .t conf -emptystyle MyStyle1

Also peep the widget options -altstyle, -emptystyle and -levelstyles — they're in on this too. 👀

Everything below is available for all but the windowbox type. Note that some of these options only get used in particular contexts — so don't come for me if one looks shy:

-activebackground color — specifies the active background color of a style. Alias is -activebg.
-activeforeground color — specifies the active foreground color of a style. Alias is -activefg.
-background color — background color override. Default is empty.
-cursor cursorname — specifies the cursor of a style. This cursor for the widget when an element is activated. 🖱️
-editopts values — cell option name/value pairs for the builtin text edit facilty. These are appended to the columns -editopts. See column -editopts.
-font fontName — sets the font for a style.
-foreground color — specifies the foreground color of a style. Alias is -fg.
-gap N — specifies the gap.
-hide bool — values or subtext having a style with hide on are to be hidden. Columns and entries are unaffected. 🙈
-highlightbackground color — specifies the highlight background color of a style. Alias is -highlightbg.
-highlightforeground color — specifies the highlight foreground color of a style. Alias is -highlightfg.
-icon name — specifies the icon.
-priority N — specifies a priority for the style. Higher priorities are used for overriding bg/fg/font. The default is 0.
-readonly bool — disallow editing for a cell whose column has -edit set to true. The default is False. 🔒
-shadow shadow — set shadow.
-tile img — set tiling.

🌈 textbox extra options

The following additional configuration options are available for textbox:

-formatcmd scriptcmd — command called to format the displayed key-data value. Percent substitutions are performed on scriptcmd as per find -exec. The called command returns the value to be displayed.
-iconside N — specifies which side of the text the icon is placed. Default is left.
-side N — specifies which side of cell to anchor contents. Default is top.

🍓 combobox extra options

The following additional configuration options are available for combobox:

-buttonicons icons — a pair of icons to use for the button icon. The second icon is drawn when style activate is used on a cell (managed automatically by the editing code).
-borderwidth pixel — size of border.
-buttonborderwidth pixel — size of buttons border.
-buttonrelief relief — relief of button.
-choicecmd cmd — command called to get the list of choices for editing, after the following substitutions: %X %Y %C %# %W %%. Used by the library proc blt::tv::EditCell which implements builtin editing.
-choicekey key — key field to in the current node to get the list of choices from.
-choices lst — a list of choices for editing.

🎀 checkbox extra options

The following additional configuration options are available for checkbox:

-boxcolor color — color of box.
-boxsize num — size of box.
-checkcolor color — color of check.
-checkicons images — a pair of icons to use to represent the on/off state instead of drawing a checkbox.
-fillcolor color — color of fill.
-halo num — halo around checkbox in which to accept a click. If num is less than zero, accept a click anywhere in the cell. The default is 0.
-linewidth num — line size.
-offvalue val — value representing off.
-onvalue val — value representing on.
-showvalue bool — show value as well.. ✅

🔥 barbox extra options

The following additional configuration options are available for barbox:

-barbg color — color for the background of the bar. Default is the empty string.
-boxcolor color — color of box around bar.
-barfg color — color for the foreground of the bar. Default is green.
-barheight num — height of bar. Default 10.
-barwidth num — width of bar. Default 80.
-filltile tile — image to tile-fill bar with.
-formatcmd scriptcmd — command called to format the displayed value. Percent substitutions are performed on scriptcmd as per find -exec. The called command returns the value to be displayed.
-linewidth num — width of border around the bar. Default is 1.
-maxvalue val — the maxiumum value. Default is 100.0.
-minvalue val — the miniumum value. Default is 0.0.
-showvalue bool — show the numeric value.

🦋 windowbox extra options

Only the following configuration options are available with windowbox — that's it, the whole list, no more:

-minheight num — minimum height of window. Window height will be taller if the the entry height is greater than num. Default is 0.
-minwidth num — minimum width of window. Window width will be wider if the the column width is greater than num. Default is 0.
-sticky val — stickiness of the window inside the cell, as defined by the grid command. The default value is w.
-windowcmd string — command invoked to return window path. Percent substitutions are performed on string before it is executed. The following substitutions are valid:
- %W — the pathname of the widget.
- %p — the name of the node.
- %P — the full pathname of the node.
- %# — the id of the node.
- %C — the column identifier.
- %% — translates to a single percent.

🌸 COLUMN OPTIONS 🌸

Column configuration options may also be set by the option command. The resource subclass is Column. The resource name is the name of the column. iykyk 💫

option add *TreeView.Column.Foreground white
option add *TreeView.treeView.Background blue

The following configuration options are available for columns:

-activetitlebackground color — active title background color.
-activetitleforeground color — active title foreground color.
-autowidth value — if the maximum width of a column exceeds the given value, then the column width uses this value instead -width. When value is zero or -width is non-zero, has no effect. Allows setting a default column width limit, while still permitting the user to manually resize larger (unlike -max). The default value is 0.
-background color — sets the background color of the column. This overrides the widget's -background option. The default is white.
-bindtags string — set binding tags for column.
-borderwidth pixels — sets the width of the 3-D border of the column. The -relief option determines if a border is to be drawn. The default is 0.
-colorpattern patcolors — alter foreground color based on a string match against the cell data value. Pattern/color pairs are specified in patcolors. If the pattern matches, then color becomes the foreground of the data cell. This provides a low-overhead way to display different colors depending only on the form of data. 🎨
-colorregexp patcolors — does the same thing as -colorpattern, except uses regexp instead, and has a lower priority.
-command string — set command for use by invoke. This is called everytime the column is selected. For example, sortable columns can be enabled by a setting this to {blt::tv::SortColumn %W %C}, or sort tree children of with {blt::tv::SortTree %W %C}. Note that SortColumn can temporarily change the treeview mode to -flat. The following substitutions are valid:
- %W — the pathname of the widget.
- %C — the column identifier.
- %% — translates to a single percent.
-edit num — indicates if the column's data fields can be edited via the builtin editing facility. If num is True the data fields in the column can be edited. The default is False.
-editopts values — sub-option pair settings for the builtin text edit facilty implemented by ::blt::tv::EditCol. Note, these are used only for cells with a style type of textbox and combobox. Following is partial documentation of the textbox (or see ::blt::tv::EditCol $blt_library/treeview.tcl). 📝
- -allowtypes type — list of types to allow text editing for, or * for all. The default is textbox.
- -autonl bool — automatically use either an entry, spinbox or text as appropriate. The default is to use an entry widget. Text containing newlines will use a text widget. A column with combobox style where -choices or -choicecmd is set will use a spinbox.
- -choices list — list of choices for spinbox/combo.
- -conf values — options to pass directly to the widget.
-embed bool — when it's True, the edit window is managed internally with an embedded windowbox situation. When it's false, place runs the show. Default? False. An embedded window has perks ngl, but you will get a re-layout at the start and end of editing. Heads up: place is always used for the tree column.
-endcmd cmd — the command that gets called at the end of the edit, after the new value is set. If it finds a percent in there, command substitution happens; otherwise the call appends 5 arguments: widget data olddata ind col.
-leafs bool — limits editing to leafs only. Default is false.
-nlkeys opt — the keys that insert a newline in multiline edits. The default value is: <Control-r> <Shift-Return>.
-nottnull bool — don't edit empty fields that have never had data assigned to them. Default is false.
-optscmd cmd — a command called to get options. It's called with 3 args: widget ind col. It returns name/value pairs, which are additional options exactly as -editopts accepts them. Want a cell to be non-editable? Return {-readonly True}.
-readonly bool — cell is readonly, do not edit. Periodt.
-sel bool — the value starts out selected in the edit window. Default is true.
-startcmd cmd — the command to call at the start of the edit. If a percent is found, command substitution happens; otherwise the 3 arguments get appended: widget ind col.
-tab opts — sets up a bind for Tab in the edit window (either a bool or args passed through to TabMove).
-titles bool — turns on editing of the title label. Default is false.
-treelabel bool — edit the -tree cmd label instead of the treeview label. Default is true.
-type bool — a basic wize type, eg. bool, int, choice.
-typecol column — the column/key to grab -type from.
-vcmd cmd — a command that overrides the column's -validatecmd.
-widget wid — the widget to use. The builtin support types are: spinbox, text, entry. The default is entry.
-withtag tag — only edit if it has this tag.
-withouttag tag — only edit if it does not have this tag.
-wrap value — the wrap mode setting for when the edit window is a text widget. Default is none.

For more generalized control of editing, bestie, just bind to the <<TreeViewEditStart/End>> virtual events. 💫

-font font — sets the font for the column. Currently you should not mix this with a -style font for the column. Pick a lane, basically.
-foreground color — sets the text color of the column.
-fillcmd scriptcmd — demand-loads data into unset values, right before display. The call happens the first time each entry is displayed in the column. Only cells that don't already have a value/label set get updated. Before calling, the id is appended. The new value should be returned. For tree columns, the result is used to set the entry label; otherwise it sets a data cell value. If an error is raised, the value gets set to the empty string.

Here's an example that loads a large tree — it shows off that only the first dozen or so get updated initially, and more as you scroll. A practical example might load data from a database 👀:

set t [tree create]
$t create -num 10000
pack [treeview .t -tree $t]

proc FillLabel {id} { puts "L$id"; return L$id }
proc FillData {id} { return D$id }
.t col conf #0 -fillcmd FillLabel
.t col insert end A -fillcmd FillData

-hide boolean — if boolean is true, the column is not displayed. Default is no.
-justify justify — specifies how the column data fields' text should be justified within the column. This only matters when the column is wider than the data field being displayed. Justify must be left, right, or center. Default is center.
-max size — maximum size for the column.
-min size — minimum size for the column.
-pad pad — specifies how much padding goes on the left and right sides of the column. Pad is a list of one or two screen distances. If pad has two elements, the left side of the column is padded by the first distance and the right side by the second. If pad has just one distance, both sides get padded evenly. The default is 2.
-relief relief — specifies the 3-D effect of the column. Relief says how the column should appear relative to the widget; for example, raised means the column should appear to protrude. The default is flat.
-ruledashes value — set resize rule is dashed.
-scrolltile bool — tile image scrolls.
-sortaltcolumns list — a list of alternate columns sort can use when cell values are equal. Including the current column or the tree column is an error, so don't.
-sortcommand script — the command that actually compares entries during sort.
-sortmode mode — used by scripts to set -mode for the sort command (eg. blt::tv::SortColumn).
-state state — sets the state of the column. If state is disable, then the column title can't be activated nor invoked. The default is normal.
-style stylename — set the style to use for the column.
-tile image — image to tile the column with.
-title string — sets the title for the column. The default is "".
-titlearrow value — forces an arrow to be drawn in the title. The value is one of: left right up down none, and it defaults to none. This is what you use when implementing custom sorts, as the indicator.
-titlebackground color — background for the title.
-titleborderwidth size — border size.
-titlefont font — font for the column title.
-titlejustify just — side to place the title.
-titleforeground color — sets the foreground color of the column title. The default is black.
-titlerelief relief — relief for the title.
-titleshadow color — sets the color of the drop shadow of the column title. The default is "".
-titlestyle style — a style to use for titles.
-width num — the user requested width for the column.
-underline num — which character to underline in the column title text. Default is -1.
-validatecmd command — this option gives you a command for validating or post-processing edits from the builtin column edit feature (enabled with col conf -edit 1). If a percent is found, command substitution occurs; otherwise 5 arguments are appended: widget data olddata ind col. The called command should return newvalue, possibly with modifications. Wanna revert to the original value? Just return $oldvalue. Wanna keep editing? Use return -code return. 🫶
-weight float — weighting to apply extra space.
-width pixels — sets the requested width of the column. This overrides the computed width of the column. If pixels is 0, the width is computed from the contents of the column. The default is 0.

🪟 EMBEDDED WINDOWS 🪟

Embedded windows are supported for columns or cells via the special style type windowbox. If -windowcmd isn't being used, the cell data is assumed to contain the widget name, or the tail part of a widget name. If the data doesn't give you a valid window, it's silently ignored and nothing gets displayed — no drama, no error. And if multiple cells try to display the same widget at the same time, only the first one shows up. The normal Tk slave window rules apply (ie. must be child of the parent).

💀 OLD TEXT EDITING OPTIONS 💀

SECTION OBSOLETE. 👑 (iconic of it to still be here, honestly)

This section is obsolete and has been replaced with builtin editing using a Tk entry widget. See TREEVIEW EDITING above. So like... don't come for me, this is legacy.

Text edit window configuration options may also be set by the Tk option command. The resource class is TreeViewEditor. The resource name is always edit.

option add *TreeViewEditor.Foreground white
option add *edit.Background blue

The following are the configuration options available for the text editing window. Yes, all of them, yes even the obsolete ones, I'm being thorough:

-background color — sets the background of the text edit window. The default is white.
-borderwidth pixels — sets the width of the 3-D border around the edit window. The -relief option determines if a border is to be drawn. The default is 1.
-exportselection boolean — indicates if the text selection is exported. If the edit window is exporting its selection, then it will observe the standard X11 protocols for handling the selection. Selections are available as type STRING. The default is no.
-relief relief — specifies the 3-D effect of the edit window. Relief indicates how the background should appear relative to the edit window; for example, raised means the background should appear to protrude. The default is solid.
-selectbackground color — sets the background of the selected text in the edit window. The default is white.
-selectborderwidth pixels — sets the width of the 3-D border around the selected text in the edit window. The -selectrelief option determines if a border is to be drawn. The default is 1.
-selectforeground color — sets the foreground of the selected text in the edit window. The default is white.
-selectrelief relief — specifies the 3-D effect of the selected text in the edit window. Relief indicates how the text should appear relative to the edit window; for example, raised means the text should appear to protrude. The default is flat.

🎀 DEFAULT BINDINGS 🎀

okay so this is the part where Tk just does stuff for you — no cap, the widget comes pre-wired. Tk automatically creates class bindings for treeviews that give them Motif-like behavior. And a huge chunk of how a treeview widget actually acts? It's decided by its -selectmode option, which picks one of two ways of dealing with the selection. 🦋

If the selection mode is single, only one node can be selected at a time. Clicking button 1 on a node selects it and deselects any other selected item. literally one at a time bestie, that's the whole vibe.

If the selection mode is multiple, any number of entries may be selected at once, including discontiguous ranges. Clicking Control-Button-1 on a node entry toggles its selection state without affecting any other entries. Pressing Shift-Button-1 on a node entry selects it, extends the selection. iconic multi-select behavior, we love to see it ✨

[0] — The virtual event <<TreeViewFocusEvent>> is generated for each keyboard and mouse initiated change in focus. It is up to the user to determine if the focus actually changed. (yes bestie, you gotta check yourself, the widget isn't gonna tell you 💀)
[1] — In extended mode, the selected range can be adjusted by pressing button 1 with the Shift key down: this modifies the selection to consist of the entries between the anchor and the entry under the mouse, inclusive. The un-anchored end of this new selection can also be dragged with the button down. 🫶
[2] — In extended mode, pressing button 1 with the Control key down starts a toggle operation: the anchor is set to the entry under the mouse, and its selection state is reversed. The selection state of other entries isn't changed. If the mouse is dragged with button 1 down, then the selection state of all entries between the anchor and the entry under the mouse is set to match that of the anchor entry; the selection state of all other entries remains what it was before the toggle operation began. ngl this one's a whole little algorithm, respect it 💅
[3] — If the mouse leaves the treeview window with button 1 down, the window scrolls away from the mouse, making information visible that used to be off-screen on the side of the mouse. The scrolling continues until the mouse re-enters the window, the button is released, or the end of the hierarchy is reached. autoscroll go brrr 🌈
[4] — Mouse button 2 may be used for scanning. If it is pressed and dragged over the treeview widget, the contents of the hierarchy drag at high speed in the direction the mouse moves. zoom zoom 😭
[5] — If the Up or Down key is pressed, the location cursor (active entry) moves up or down one entry, as does Control-p and Control-n. If the selection mode is browse or extended then the new active entry is also selected and all other entries are deselected. In extended mode the new active entry becomes the selection anchor.
[6] — In extended mode, Shift-Up and Shift-Down move the location cursor (active entry) up or down one entry and also extend the selection to that entry in a fashion similar to dragging with mouse button 1.
[7] — The Left and Right keys scroll the treeview widget view left and right by the width of the character 0. Control-Left and Control-Right scroll the treeview widget view left and right by the width of the window. (yes, the literal character zero, that's the unit, don't ask 💀)
[8] — The Prior and Next keys scroll the treeview widget view up and down by one page (the height of the window), as does Control-u and Control-d.
[9] — The Home and End keys scroll the treeview widget horizontally to the left and right edges, respectively.
[10] — Control-Home sets the location cursor to the first entry, selects that entry, and deselects everything else in the widget. main character entry energy 👑
[11] — Control-End sets the location cursor to the last entry, selects that entry, and deselects everything else in the widget.
[12] — In extended mode, Control-Shift-Home extends the selection to the first entry and Control-Shift-End extends the selection to the last entry.
[13] — In multiple mode, Control-Shift-Home moves the location cursor to the first entry and Control-Shift-End moves the location cursor to the last entry.
[14] — The space and Select keys make a selection at the location cursor (active entry) just as if mouse button 1 had been pressed over this entry.
[15] — In extended mode, Control-Shift-space and Shift-Select extend the selection to the active entry just as if button 1 had been pressed with the Shift key down.
[16] — In extended mode, the Escape key cancels the most recent selection and restores all the entries in the selected range to their previous selection state. undo but make it selection-only 🙈
[17] — Control-slash selects everything in the widget, except in single and browse modes, in which case it selects the active entry and deselects everything else.
[18] — Control-backslash deselects everything in the widget, except in browse mode where it has no effect.
[19] — The F16 key (labelled Copy on many Sun workstations) or Meta-w copies the selection in the widget to the clipboard, if there is a selection. 🍓

The behavior of treeview widgets can be changed by defining new bindings for individual widgets or by redefining the class bindings. your widget, your rules bestie 💖

In addition to the above behavior, the following additional behavior is defined by the default widget class (TreeView) bindings.

<ButtonPress-2> — Starts scanning.
<B2-Motion> — Adjusts the scan.
<ButtonRelease-2> — Stops scanning.
<B1-Leave> — Starts auto-scrolling.
<B1-Enter> — Starts auto-scrolling
<KeyPress-Up> — Moves the focus to the previous entry.
<KeyPress-Down> — Moves the focus to the next entry.
<Shift-KeyPress-Up> — Moves the focus to the previous sibling.
<Shift-KeyPress-Down> — Moves the focus to the next sibling.
<KeyPress-Prior> — Moves the focus to first entry. Closed or hidden entries are ignored.
<KeyPress-Next> — Move the focus to the last entry. Closed or hidden entries are ignored.
<KeyPress-Left> — Closes the entry. It is not an error if the entry has no children.
<KeyPress-Right> — Opens the entry, displaying its children. It is not an error if the entry has no children.
<KeyPress-space> — In "single" select mode this selects the entry. In "multiple" mode, it toggles the entry (if it was previous selected, it is not deselected).
<KeyRelease-space> — Turns off select mode.
<KeyPress-Return> — Sets the focus to the current entry.
<KeyRelease-Return> — Turns off select mode.
<KeyPress> — Moves to the next entry whose label starts with the letter typed. type-ahead, we stan ⌨️
<KeyPress-Home> — Moves the focus to first entry. Closed or hidden entries are ignored.
<KeyPress-End> — Move the focus to the last entry. Closed or hidden entries are ignored.
<Control-a> — Move to parent of current entry.
<Control-o> — Open current entry.
<Control-Shift-O> — Open current entry recursively.
<Double-ButtonRelease-1> — Edit cell.
<Alt-Double-ButtonRelease-1> — Edit cell.
<Control-KeyPress-minus> — Close parent of current entry.
<Control-F1> — Opens all tree nodes.
<Control-F2> — Closes all tree nodes (except root).
<Control-F3> — Toggle flat mode.
<Control-F4> — Reset all column widths back to 0 allowing autosizing.
<Control-Shift-O> — Open focus tree node recursively.
<Control-Shift-C> — Close focus tree node recursively.

💅 BUTTON BINDINGS 💅

Buttons have bindings. There are associated with the "all" bindtag (see the entry's -bindtag option). You can use the bind operation to change them.

<Enter> — Highlights the button of the current entry.
<Leave> — Returns the button back to its normal state.
<ButtonRelease-1> — Adjust the view so that the current entry is visible.

🌸 ENTRY BINDINGS 🌸

Entries have default bindings. There are associated with the "all" bindtag (see the entry's -bindtag option). You can use the bind operation to modify them.

<Enter> — Highlights the current entry.
<Leave> — Returns the entry back to its normal state.
<ButtonPress-1> — Sets the selection anchor the current entry.
<Double-ButtonPress-1> — Toggles the selection of the current entry.
<B1-Motion> — For "multiple" mode only. Saves the current location of the pointer for auto-scrolling. Resets the selection mark.
<ButtonRelease-1> — For "multiple" mode only. Sets the selection anchor to the current entry.
<Shift-ButtonPress-1> — For "multiple" mode only. Extends the selection.
<Shift-Double-ButtonPress-1> — Place holder. Does nothing. 😴
<Shift-B1-Motion> — Place holder. Does nothing. 😴
<Shift-ButtonRelease-1> — Stop auto-scrolling.
<Control-ButtonPress-1> — For "multiple" mode only. Toggles and extends the selection.
<Control-Double-ButtonPress-1> — Place holder. Does nothing. 😴
<Control-B1-Motion> — Place holder. Does nothing. 😴
<Control-ButtonRelease-1> — Stops auto-scrolling.
<Control-Shift-ButtonPress-1> — ??? (yes that's literally what the page says, we're all just vibing here 💀)
<Control-Shift-Double-ButtonPress-1> — Place holder. Does nothing. 😴
<Control-Shift-B1-Motion> — Place holder. Does nothing. 😴

✨ COLUMN BINDINGS ✨

Columns have bindings too. They are associated with the column's "all" bindtag (see the column -bindtag option). You can use the column bind operation to change them.

<Enter> — Highlights the current column title.
<Leave> — Returns the column back to its normal state.
<ButtonRelease-1> — Invokes the command (see the column's -command option) if one if specified.

🧚 COLUMN RULE BINDINGS 🧚

These are bindings associated with the tag Rule.

<Enter> — Highlights the current and activates the ruler.
<Leave> — Returns the column back to its normal state. Deactivates the ruler.
<ButtonPress-1> — Sets the resize anchor for the column.
<B1-Motion> — Sets the resize mark for the column.
<ButtonRelease-1> — Adjust the size of the column, based upon the resize anchor and mark positions. drag-to-resize, genuinely so satisfying 🔥

🌸 QUICKSTART 🌸

TreeFill is a utility function that makes loading tree data from a human-readable string way easier, bestie. The string uses line indentation to show tree depth. Indentation is in multiples of 4 spaces, relative to the first line. eg.

pack [treeview .t]
.t column insert end X Y Z
blt::tv::TreeFill .t {
    A 1 2 3
    B 4 5 6
        x 7 8 9
        y 10 11 12
            a 1 2 "Level a"
            b 1 2 "Level b"
    C 1 2 3
}
.t open -trees all
.t entry conf 0->B->y->a -state disabled

Any column names that aren't defined are generated. To load a table instead of a tree, just set the -flat option first. eg.

pack [treeview .t -flat 1]
.t column conf #0 -hide 1
.t column insert end Name Age Sex
blt::tv::TreeFill .t {
    "Tom Brown" 9 M
    "Mike Small" 8 M
    "Tina Baker" 7 F
}

🎀 EXAMPLE 🎀

The treeview command creates a new widget. Iconic.

treeview .t -bg white

A new Tcl command .t is also created, and you can use it to query and modify the treeview widget. For example, to change the background color of the table to "green", you use the new command and the widget's configure operation.

# Change the background color.
.t configure -background "green"

By default, the treeview widget will automatically create a new tree object to contain the data. The name of the new tree is the pathname of the widget. Above, the new tree object name is ".t". But you can use the -tree option to specify the name of another tree.

# View the tree "myTree".
.t configure -tree "myTree"

When a new tree is created, it contains only a root node. That node is automatically opened. The id of the root node is always 0 (you can also use the special id root). The insert operation lets you insert one or more new entries into the tree. The last argument is the node's pathname.

# Create a new entry named "myEntry"
set id [.t insert end "myEntry"]

This appends a new node named "myEntry". It gets positioned as the last child of the root of the tree (using the position "end"). You can supply another position to order the node within its siblings.

# Prepend "fred".
set id [.t insert 0 "fred"]

Entry names do not need to be unique. By default, the node's label is its name. To supply a different text label, add the -label option.

# Create a new node named "fred"
set id [.t insert end "fred" -label "Fred Flintstone"]

The insert operation returns the id of the new node. You can also use the index operation to get this information.

# Get the id of "fred"
.t index "fred"

To insert a node somewhere other than root, use the -at switch. It takes the id of the node where the new child will be added.

# Create a new node "barney" in "fred".
.t insert end "barney" -at $id

A pathname describes the path to an entry in the hierarchy. It's a list of entry names that compose the path in the tree. Therefore, you can also add "barney" to "fred" as follows.

# Create a new sub-entry of "fred"
.t insert end "fred barney"

Every name in the list is an ancestor of the next one. All ancestors must already exist. That means that an entry "fred" is an ancestor of "barney" and must already exist. But you can use the -autocreate configuration option to force the creation of ancestor nodes.

# Force the creation of ancestors.
.t configure -autocreate yes
.t insert end "fred barney wilma betty"

Sometimes the pathname is already separated by a character sequence rather than formed as a list. A file name is a good example of this. You can use the -separator option to specify a separator string to split the path into its components. Each pathname inserted is automatically split using the separator string as a separator. Multiple separators are treated as one.

.t configure -separator /
.t insert end "/usr/local/tcl/bin"

If the path is prefixed by extraneous characters, you can automatically trim it off using the -trim option. It removes the string from the path before it is parsed.

.t configure -trim C:/windows -separator /
.t insert end "C:/window/system"

You can delete entries with the delete operation. It takes one or more tags of ids as its argument. It deletes the entry and all its children.

.t delete $id

Entries have several configuration options, and they control the appearance of the entry's icon and label. We have already seen the -label option that sets the entry's text label. The entry configure operation lets you set or modify an entry's configuration options.

.t entry configure $id -color red -font fixed

You can hide an entry and its children using the -hide option.

.t entry configure $id -hide yes

More than one entry can be configured at once. All entries specified are configured with the same options.

.t entry configure $i1 $i2 $i3 $i4 -color brown
# or ...
.t entry configure [list $i1 $i2 $i3 $i4] -color brown

An icon is displayed for each entry. It's a Tk image drawn to the left of the label. You can set the icon with the entry's -icons option. It takes a list of two image names: one to represent the open entry, another when it is closed.

set im1 [image create photo -file openfolder.gif]
set im2 [image create photo -file closefolder.gif]
.t entry configure $id -icons "$im1 $im2"

If -icons is set to the empty string, no icons are displayed.

If an entry has children, a button is displayed to the left of the icon. Clicking the mouse on this button opens or closes the sub-hierarchy. The button is normally a + or - symbol, but can be configured in a variety of ways using the button configure operation. For example, the + and - symbols can be replaced with Tk images.

set im1 [image create photo -file closefolder.gif]
set im2 [image create photo -file downarrow.gif]
.t button configure $id -images "$im1 $im2" \
    -openrelief raised -closerelief raised

Entries can contain an arbitrary number of data fields. Data fields are name-value pairs. Both the value and the name are strings. The entry's -data option lets you set data fields.

.t entry configure $id -data {mode 0666 group users}

The -data takes a list of name-value pairs.

You can display these data fields as columns in the treeview widget. You can create and configure columns with the column operation. For example, to add a new column to the widget, use the column insert operation. The last argument is the name of the data field that you want to display.

.t column insert end "mode"

The column title is displayed at the top of the column. By default, it's the field name. You can override this using the column's -title option.

.t column insert end "mode" -title "File Permissions"

Columns have several configuration options. The column configure operation lets you query or modify column options.

.t column configure "mode" -justify left

The -justify option says how the data is justified within the column. The -hide option indicates whether the column is displayed.

.t column configure "mode" -hide yes

Entries can be selected by clicking on the mouse. Selected entries are drawn using the colors specified by the -selectforeground and -selectbackground configuration options. The selection itself is managed by the selection operation.

# Clear all selections
.t selection clear 0 end
# Select the root node
.t selection set 0

The curselection operation returns a list of ids of all the selected entries.

set ids [.t curselection]

You can use the get operation to convert the ids to their pathnames.

set names [eval .t get -full $ids]

If a treeview is exporting its selection (using the -exportselection option), then it will observe the standard X11 protocols for handling the selection. Treeview selections are available as type STRING; the value of the selection will be the pathnames of the selected entries, separated by newlines.

The treeview supports two modes of selection: single and multiple. In single select mode, only one entry can be selected at a time, while multiple select mode allows several entries to be selected. The mode is set by the widget's -selectmode option.

.t configure -selectmode "multiple"

You can be notified when the list of selected entries changes. The widget's -selectcommand specifies a Tcl procedure that is called whenever the selection changes.

proc SelectNotify { widget } {
   set ids [$widget curselection]
}
.t configure -selectcommand "SelectNotify .t"

The widget supports the standard Tk scrolling and scanning operations. The treeview can be both horizontally and vertically scanned. You can attach scrollbars to the treeview the same way as the listbox or canvas widgets.

scrollbar .xbar -orient horizontal -command ".t xview"
scrollbar .ybar -orient vertical -command ".t yview"
.t configure -xscrollcommand ".xbar set" \
    -yscrollcommand ".ybar set"

Entries can be programmatically opened or closed using the open and close operations respectively.

.t open $id
.t close $id

When an entry is opened, a Tcl procedure can be automatically invoked. The -opencommand option specifies this procedure. This procedure can lazily insert entries as needed.

proc AddEntries { dir } {
   eval .t insert end [glob -nocomplain $dir/*]
}
.t configure -opencommand "AddEntries %P"

Now when an entry is opened, the procedure AddEntries is called and adds children to the entry. Before the command is invoked, special "%" substitutions (like bind) are performed. Above, %P is translated to the pathname of the entry.

The same feature exists when an entry is closed. The -closecommand option specifies the procedure.

proc DeleteEntries { id } {
   .t entry delete $id 0 end
}
.t configure -closecommand "DeleteEntries %#"

When an entry is closed, the procedure DeleteEntries is called and deletes the entry's children using the entry delete operation (%# is the id of entry).

💅 OLD TREEVIEW EDITS 💅

⚠️ Heads up bestie: this whole section is OBSOLETE. Native Tk widgets are used for editing now. It's giving museum exhibit, but we're still documenting it because iykyk and the details matter. 🫶

When editing, the subwidget .edit is available. Slay.

pathName.edit operation ?args?

Okay so this operation is the whole text-editing setup for cells (aka data fields in a column) or entry labels. It has several forms, depending on operation:

pathName.edit apply — Applies the edited buffer, replacing the entry label or data field. The edit window then gets hidden. 💨
pathName.edit cancel — Cancels the editing operation, reverting the entry label or data value back to the previous value. The edit window is hidden. It's giving "nvm, never happened" energy.
pathName.edit cget value — Returns the current value of the configuration option given by option. Option may have any of the values accepted by the configure operation described below. Literally just a lil peek at the config.
pathName.edit configure ?option value? — Query or modify the configuration options of the edit window. If no option is specified, it returns a list describing all of the available options (see 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 (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 and value are described in the section TEXT EDITING OPTIONS below. Iconic configure behavior, no notes. ✨
pathName.edit delete first last — Deletes the characters in the edit buffer between the two given character positions. Bye bye text 🦋
pathName.edit get ?-root? x y — go grab something, bestie 🎀
pathName.edit icursor index — sets the cursor position, main character placement 💅
pathName.edit index index — Returns the text index of given index. Lowkey useful.
pathName.edit insert index string — Insert the text string into the edit buffer at the index index. For example, the index 0 will prepend the buffer. Oh we're fancy.
pathName.edit selection args — This operation controls the selection of the editing window. Note that this differs from the selection of entries. It has the following forms:
- pathName.edit selection adjust index — Adjusts either the first or last index of the selection.
- pathName.edit selection clear — Clears the selection. Gone. 💀
- pathName.edit selection from index — Sets the anchor of the selection.
- pathName.edit selection present — Indicates if a selection is present. A little vibe check on ur selection, honestly.
- pathName.edit selection range start end — Sets both the anchor and mark of the selection.
- pathName.edit selection to index — Sets the unanchored end (mark) of the selection.

🏷️ LABEL ISSUES 🏷️

Entries take a -label option that can be used to specify the text to display. Important though: this is not the same thing as the node label. Don't confuse them, bestie, they're different girlies entirely. 🙈

By default, labels are checked for duplicates by insert, which can slow down large (10k+) inserts. Setting -allowduplicates to 1 disables this checking. Fr fr, that's your speed setting for big inserts. 🚀

An entry's label can be changed either by setting -allowduplicates to 1 and using treeview's entry relabel, or by using tree's label command. Two paths, both valid. ✨

Instead of lists, a separator can be specified with -separator. Thus for managing files we might use:

treeview .t -separator / -autocreate 1
.t insert end  mann/text.n mann/canvas.n
.t insert end  Help Search Close -at root->mann->text.n
pack .t

Periodt. That's the whole file-tree fantasy right there. 🌸

📝 NOTES 📝

Text cells in display height can be at most 64K pixels high per row. That's the ceiling, bestie — literally the limit. Don't come at it with a taller row. 😭

🔑 KEYWORDS 🔑

treeview, widget

And that's a wrap on the whole page, babes! 🎀 This one came to you courtesy of BLT version 2.5, and it's the treeview(n) manual page — you're fully caught up, no cap. Go forth and treeview responsibly. 🦋💜✨

📦 where this page comes from

nixpkgs unstable: blt 2.5.3
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-04: a language model's rewrite of the original, under its terms

treeview(n)

🌸 NAME — treeview(n) but make it cute 🌸

✨ SYNOPSIS ✨

🦋 DESCRIPTION 🦋

🌈 INTRODUCTION 🌈

🍓 COLUMN DATA 🍓

🧚 TREE DATA OBJECT 🧚

💜 SYNTAX 💜

🎀 IDS AND TAGS 🎀

👑 SPECIAL NODE IDS 👑

🍓 DATA FIELDS 🍓

🧚 ARRAY REFERENCES 🧚

💜 ENTRY BINDINGS 💜

🔥 TREEVIEW OPERATIONS 🔥

🚚 pathName move tagnode how destId

🎯 pathName nearest ?-root? ?-strict? x y ?varName?

🌸 pathName open ?-recurse? ?-parent? ?-trees? tagnode...

📏 pathName range ?-open? first last

🖱️ pathName scan option args

👀 pathName see ?-anchor anchor? tagOrId

💖 pathName selection option arg

🌈 pathName show ?flags? tagOrId...

🔀 pathName sort ?operation? args...

🔀 pathName sort once ?flags? tagOrId...

🎨 pathName style operation ?args?

pathName style activate ?entry? ?column?

pathName style cget stylename option

pathName style configure ?stylename option? ?value option value ...?

🧚 pathName style create ...?

pathName style find stylename ?column? ?node? ...

pathName style forget stylename ...

pathName style get column tagorid

pathName style highlight stylename ?on|off?

pathName style names

pathName style priority column node

pathName style set stylename column node ...

pathName style slaves ?-col col? ?-id node? ?-style styleName? ?-visible bool? ?-info path?

pathName style type ?name? ?newtype?

pathName style use stylename

🏷️ pathName tag operation args

🔓 pathName toggle tagnode

↔️ pathName xview args

pathName xview