ActiveTcl User Guide
|
||
iwidgets::hierarchy pathName ?options? itk::Widget <- iwid- gets::Labeledwidget <- iwidgets::Scrolledwidget <- iwidgets::Hi- erarchy
activeBackground activeForeground background borderWidth
tions.
activeRelief elementBorderWidth
jumptroughColor
associated options.
spacing1 spacing2 spacing3 tabs
ciated options.
labelBitmap labelFont labelImage
labelMargin
herited options.
refresh of the display should be via a new query using the com- mand value of the -querycommand option or use the values previous found the last time the query was made. The default is no.
the hierarchy before those nodes that are collapsed. Should one
not be provided, then a folder icon will be generated, pixmap if
possible, bitmap otherwise.
mouse button one of the text label of an entry. If this command contains %n", it is replaced with the name of the selected node.
current selection status is substituted.
first displayed. A fresh display can be triggered by resetting the -querycommand option. The default is false.
false.
value may be specified in any of the forms acceptable to Tk_Get*-
nents such as labels, margins, and scrollbars force the
hierarchy to be compressed. A value of zero along with the same
value for the width causes the value given for the visibleitems
option to be applied which administers geometry constraints in a
different manner. The default height is zero.
button one of any additional icons given in the values returned
by the command associated with the -querycommand option. If this
command contains %n", it is replaced with the name of the node the
icon belongs to. Should it contain %i then the icon name is
substituted.
mouse button one of the icon of an entry. If this command con-
tains %n", it is replaced with the name of the node the icon be-
longs to. Should it contain %i then the icon name is substitut-
ed.
of an entry. If this command contains %n", it is replaced with
the name of the selected node. Should it contain %s then a boolean
indicator of the node's current selection status is sub-
stituted.
mouse button one of the image of an entry. If this command con-
tains %n", it is replaced with the name of the node the icon be-
longs to. Should it contain %i then the icon name is substitut-
ed.
button three, on the image or icon, that will dynamically load
the itemMenu for the widget.
nodes.
nodes.
menus. The value may have any of the forms accept able to
the hierarchy before those nodes that are leafs. Should one not
be provided, then a dog-eared page icon will be generated, pixmap
if possible, bitmap otherwise.
the hierarchy before those nodes that are expanded. Should one
not be provided, then an open folder icon will be generated, pixmap
if possible, bitmap otherwise.
node. If this command contains %n", it is replaced with the name
of the desired node. In its simpilest form it should return the
children of the given node as a list which will be depicted in the
display. Since the names of the children are used as tags in the
underlying text widget, each child must be unique in the hierarchy.
Due to the unique requirement, the nodes shall be reffered to as
uids or uid in the singular sense. The format of returned list
is
{uid [uid ...]}
where uid is a unique id and primary key for the hierarchy en- try
Should the unique requirement pose a problem, the list re- turned
can take on another more extended form which enables the
association of text to be displayed with the uids. The uid must
still be unique, but the text does not have to obey the unique
rule. In addition, the format also allows the specification of
additional tags to be used on the same entry in the hierarchy as
the uid and additional icons to be displayed just before the node.
The tags and icons are considered to be the property of the user in
that the hierarchy widget will not depend on any of their values.
The extended format is
{{uid [text [tags [icons]]]} {uid [text [tags [icons]]]} ...}
where uid is a unique id and primary key for the hierarchy en-
try
text is the text to be displayed for this uid tags is a list of
user tags to be applied to the entry icons is a list of icons to be
displayed in front of the text The hierarchy widget does a look
ahead from each node to de- termine if the node has a children.
This can be cost some per- formace with large hierarchies. User's
can avoid this by provid- ing a hint in the user tags. A tag of
leaf or branch tells the hierarchy widget the information it needs
to know thereby avoiding the look ahead operation.
scrollbar: static, dynamic, or none. In
static mode, the scroll bar is displayed at all times. Dynamic mode
displays the scroll bar as required, and none disables the scroll
bar display. The default is static.
able to Tk_GetPixels.
and the scrollbars in any of the forms acceptable to
Tk_GetPix*- els. The default is 3 pixels.
the hierarchy via left mouse click. If %n is included in the command, it is substituted with the node name. Similarly, %s" is substituted with the node's current selection status: 1 for selected, 0 otherwise. Name: textBackground
archy in any of the forms acceptable to Tk_GetColor.
chy.
button three, that will dynamically load the itemMenu for the
widget.
archy. This option is only administered if the width and height options are both set to zero, otherwise they take precedence.
gaged, geometry constraints are maintained only on the text por- tion of the hierarchy. The size of the other components such as labels, margins, and scroll bars, are additive and independent, effecting the overall size of the hierarchy. In contrast, should the width and height options have non zero values, they are ap- plied to the hierarchy as a whole. The hierarchy is compressed or expanded to maintain the geometry constraints.
scrollbar: static, dynamic, or none. In
static mode, the scroll bar is displayed at all times. Dynamic mode
displays the scroll bar as required, and none disables the scroll
bar display. The default is static.
ue may be specified in any of the forms acceptable to Tk_GetPix*- els. Any additional space needed to display the other components such as labels, margins, and scrollbars force the text portion of the hierarchy to be compressed. A value of zero along with the same value for the height causes the value given for the visi- bleitems option to be applied which administers geometry con- straints in a different manner. The default width is zero.
_________________________________________________________________
widget. It allows the graphical management of a a list of nodes that can be expanded or collapsed. Individual nodes can be high- lighted. Clicking with the right mouse button on any item brings up a special item menu. Clicking on the background area brings up a different popup menu. Options exist to provide user control over the loading of the nodes and actions associated with node selection. Since the hierarchy is based on the scrolledtext wid- get, it includes options to control the method in which the scrollbars are displayed, i.e. statically or dynamically. Op- tions also exist for adding a label to the hierarchy and control- ling its position.
name is pathName. This command may be used to invoke various op- erations on the widget. It has the following general form:
pathName option ?arg arg ...?
pathName cget option Returns the current value of the configura- tion option given by option. Option may have any of the values accepted by the iwidgets::hierarchy command. pathName clear Re- moves all items from the hierarchy display including all tags and icons. The display will remain empty until the -filter or -querycommand options are set. pathName collapse uid Collapses the hierarchy beneath the node with the specified unique id by one level. Since this can take a moment for large hierarchies, the cursor will be changed to a watch during the collapse. Also, if any of the nodes beneath the node being collapsed are select- ed, their status is changed to unselected. pathName configure ?option? ?value option value ...? Query or modify the configura- tion options of the widget. If no option is specified, returns a list describing all of the available options for pathName (see
option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified). If one or more option-value pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. Option may have any of the values accepted by the iwid*- gets::hierarchy command. pathName current Returns the tags for the node that was most recently selected by the right mouse but- ton when the item menu was posted. Usually used by the code in the item menu to figure out what item is being manipulated. pathName draw ?when? Performs a complete redraw of the entire hierarchy. When may be either -now or -eventually where the lat- ter means the draw can be performed after idle. pathName expand uid Expands the hierarchy beneath the node with the specified unique id by one level. Since this can take a moment for large hierarchies, the cursor will be changed to a watch during the ex- pansion. pathName expanded uid Returns the current state of ex- pansion for the node with the specified unique id. pathName exp*-
mark option ?arg arg ...? This command is used to manipulate marks which is quite similar to selection, adding a secondary means of hilighting an item in the hierarchy. The exact behavior of the command depends on the option argument that follows the mark argument. The following forms of the command are currently supported: pathName mark clear Clears all the currently marked nodes in the hierarchy. pathName mark add uid ?uid uid ...?
the -markbackground and -markforeground options and without af- fecting the mark state of any other nodes that were already marked. pathName mark remove uid ?uid uid ...? Unmarks the nodes with the specified uids in the hierarchy without affecting the mark state of any other nodes that were already marked. pathName mark get Returns a list of the unique ids that are cur- rently marked. pathName refresh uid Performs a redraw of a spe- cific node that has the given uid. If the node is not currently visible or in other words already drawn on the text, then no ac- tion is taken. pathName prune uid Removes the node specified by the given uid from the hierarchy. Should the node have children, then all of its children will be removed as well. pathName se*- lection option ?arg arg ...? This command is used to manipulate the selection of nodes in the hierarchy. The exact behavior of the command depends on the option argument that follows the se*- lection argument. The following forms of the command are cur- rently supported: pathName selection clear Clears all the cur- rently selected nodes in the hierarchy. pathName selection add uid ?uid uid ...? Selects the nodes with the specified uids in the hierarchy using the -selectionbackground and -selectionfore*- ground options and without affecting the selection state of any other nodes that were already selected. pathName selection re*- move uid ?uid uid ...? Deselects the nodes with the specified uids in the hierarchy without affecting the selection state of any other nodes that were already selected. pathName selection get Returns a list of the unique ids that are currently selected.
selected node not visible, then its selection status is changed to unselected. pathName toggle uid Toggles the hierarchy beneath the node with the specified unique id. If the hierarchy is cur- rently expanded, then it is collapsed, and vice-versa.
displayed. See the text widget manual entry for details on the
text component item.
pressing the right mouse button in the background, i.e. not over a specific node. Menu items can be added along with their com- mands via the component command. See the menu widget manual entry for details on the bgMenu component item.
scrollbar widget manual entry for details on the horizsb compo-
nent item.
selection of a hierarchy node with the right mouse button. Menu
items can be added along with their commands via the component
command. See the menu widget manual entry for details on the
itemMenu component item.
scrollbar widget manual entry for details on the vertsb compo- nent item.
package require Iwidgets 4.0
proc get_files {file} {
global env
if {$file == "} {
set dir $env(HOME)
} else {
set dir $file
}
if {[catch {cd $dir}] != 0} {
return "
}
set rlist "
foreach file [lsort [glob -nocomplain *]] { lappend rlist [list [file join $dir $file] $file] }
return $rlist
}
iwidgets::hierarchy .h -querycommand get_files %n -visibleitems 30x15 -labeltext $env(HOME) pack .h -side left -expand yes -fill both