ActiveTcl User Guide
| |
ActiveTcl User Guide
|
|
iwidgets::hierarchy - Create and manipulate a hierarchy widget
iwidgets::hierarchy pathName ?options?
itk::Widget <- iwidgets::Labeledwidget <-
iwidgets::Scrolledwid- get <- iwidgets::Hierarchy
activeBackground activeForeground background borderWidth
options.
activeRelief elementBorderWidth jumptroughColor
associated options.
spacing1 spacing2 spacing3 tabs
ciated options.
labelBitmap labelFont labelImage labelMargin
inherited 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
components 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
belongs to. Should it contain «%i» then the icon name
is substi- tuted.
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
belongs to. Should it contain «%i» then the icon name
is substi- tuted.
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
entry
can take on another more extended form which enables the associa- tion 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.
tional tags to be used on the same entry in the hierarchy as the uid and additional icons to be displayed just before the node.
in that the hierarchy widget will not depend on any of their
val- ues. The extended format is
{{uid [text [tags [icons]]]} {uid [text [tags [icons]]]} ...}
where uid is a unique id and primary key for the hierarchy
entry
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
mine if the node has a children. This can be cost some perfor-
mace with large hierarchies. User's can avoid this by providing a
hint in the user tags. A tag of «leaf» or
«branch» tells the hierarchy widget the information it
needs to know thereby avoid- ing 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.
mand-Line Switch: -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.
engaged, geometry constraints are maintained only on the text portion of the hierarchy. The size of the other components such as labels, margins, and scroll bars, are additive and indepen- dent, effecting the overall size of the hierarchy. In contrast, should the width and height options have non zero values, they are applied to the hierarchy as a whole. The hierarchy is com- pressed 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.
value may be specified in any of the forms acceptable to Tk_Get-
nents such as labels, margins, and scrollbars force the text por- tion of the hierarchy to be compressed. A value of zero along with the same value for the height causes the value given for the visibleitems 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.
trolling its position.
name is pathName. This command may be used to invoke various operations on the widget. It has the following general form:
pathName option ?arg arg ...?
pathName cget option
option. Option may have any of the values accepted
by the iwid- gets::hierarchy command.
pathName clear
and icons. The display will remain empty until the -filter or
-querycommand options are set.
pathName collapse uid
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 col- lapsed are selected, their status is changed to unselected. pathName configure ?option? ?value option value ...?
option is specified, returns a list describing all of the
avail- able options for pathName (see
Tk_ConfigureInfo for information on the format of this
list). If option is specified with no value, then the
command returns a list describing the one named option (this list
will be identical to the corresponding sublist of the value
returned if no option is specified). If one or more
option-value pairs are specified, then the command modifies
the given widget option(s) to have the given value(s); in this case
the command returns an empty string. Option may have any of
the values accepted by the iwidgets::hierarchy command.
pathName current
the right mouse button 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?
either -now or -eventually where the latter means the draw can
be performed after idle.
pathName expand uid
id by one level. Since this can take a moment for large hierar- chies, the cursor will be changed to a watch during the expan- sion.
pathName expanded uid
specified unique id.
pathName expState
pathName mark option ?arg arg
...?
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
pathName mark add uid ?uid
uid ...?
the -markbackground and -markforeground options
and without affecting the mark state of any other nodes that were
already marked.
pathName mark remove uid ?uid
uid ...?
out affecting the mark state of any other nodes that were
already marked.
pathName mark get
pathName refresh uid
the node is not currently visible or in other words already
drawn on the text, then no action is taken.
pathName prune uid
removed as well.
pathName selection option ?arg
arg ...?
hierarchy. The exact behavior of the command depends on the
option argument that follows the selection argument.
The follow- ing forms of the command are currently supported:
pathName selection clear
pathName selection add uid
?uid uid ...?
the -selectionbackground and -selectionforeground
options and without affecting the selection state of any other
nodes that were already selected.
pathName selection remove uid
?uid uid ...?
without affecting the selection state of any other nodes that
were already selected.
pathName selection get
selected node not visible, then its selection status is changed
to unselected.
pathName toggle uid
id. If the hierarchy is currently expanded, then it is col- lapsed, 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
hierarchy, text, widget