.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.TH TREE 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation"
Tk::Tree \- Create and manipulate Tree widgets
\&\ \fI$tree\fR = \fI$parent\fR\->\fBTree\fR(?\fIoptions\fR?);
The \fBTree\fR class is derived from the HList class and inherits all
the methods, options and subwidgets of its super\-class. A \fBTree\fR widget is
.IX Header "STANDARD OPTIONS"
\&\fBTree\fR supports all the standard options of an HList widget.
See Tk::options for details on the standard options.
.SH "WIDGET-SPECIFIC OPTIONS"
.IX Header "WIDGET-SPECIFIC OPTIONS"
.IP "Name: \fBbrowseCmd\fR" 4
.IX Item "Name: browseCmd"
.IP "Class: \fBBrowseCmd\fR" 4
.IX Item "Class: BrowseCmd"
.IP "Switch: \fB\-browsecmd\fR" 4
.IX Item "Switch: -browsecmd"
Specifies a callback to call whenever the user browses on an entry
(usually by single-clicking on the entry). The callback is called with
one argument, the pathname of the entry.
.IP "Name: \fBcloseCmd\fR" 4
.IX Item "Name: closeCmd"
.IP "Class: \fBCloseCmd\fR" 4
.IX Item "Class: CloseCmd"
.IP "Switch: \fB\-closecmd\fR" 4
.IX Item "Switch: -closecmd"
Specifies a callback to call whenever an entry needs to be closed (See
\&\*(L"\s-1BINDINGS\s0\*(R" below). This method is called with one argument,
the pathname of the entry. This method should perform appropriate
actions to close the specified entry. If the \fB\-closecmd\fR option
is not specified, the default closing action is to hide all child
entries of the specified entry.
.IP "Name: \fBcommand\fR" 4
.IP "Class: \fBCommand\fR" 4
.IX Item "Class: Command"
.IP "Switch: \fB\-command\fR" 4
.IX Item "Switch: -command"
Specifies a callback to call whenever the user activates an entry
(usually by double-clicking on the entry). The callback
is called with one argument, the pathname of the entry.
.IP "Name: \fBignoreInvoke\fR" 4
.IX Item "Name: ignoreInvoke"
.IP "Class: \fBIgnoreInvoke\fR" 4
.IX Item "Class: IgnoreInvoke"
.IP "Switch: \fB\-ignoreinvoke\fR" 4
.IX Item "Switch: -ignoreinvoke"
A Boolean value that specifies when a branch should be opened or
closed. A branch will always be opened or closed when the user presses
the (+) and (\-) indicators. However, when the user invokes a branch
(by doublc-clicking or pressing <Return>), the branch will be opened
or closed only if \fB\-ignoreinvoke\fR is set to false (the default
.IP "Name: \fBopenCmd\fR" 4
.IP "Class: \fBOpenCmd\fR" 4
.IX Item "Class: OpenCmd"
.IP "Switch: \fB\-opencmd\fR" 4
.IX Item "Switch: -opencmd"
Specifies a callback to call whenever an entry needs to be opened (See
\&\*(L"\s-1BINDINGS\s0\*(R" below). This method is called with one argument,
the pathname of the entry. This method should perform appropriate
actions to open the specified entry. If the \fB\-opencmd\fR option
is not specified, the default opening action is to show all the child
entries of the specified entry.
The \fBTree\fR method creates a new window and makes it into a Tree widget
and return a reference to it. Additional options, described above, may
be specified on the command line or in the option database to configure
aspects of the Tree widget such as its cursor and relief.
The Tree widget can be used to display hierarchical data in a tree
form. The user can adjust the view of the tree by opening or closing
To display a static tree structure, you can add the entries into the
Tree widget and hide any entries as desired. Then you can call
the \fBautosetmode\fR method. This will set up the Tree widget so that it
handles all the \fIopen\fR and \fIclose\fR events automatically.
the demonstration program \fITixish/examples/perl\-tix\-tree\fR).
The above method is not applicable if you want to maintain a dynamic tree
structure, i.e, you do not know all the entries in the tree and you need
to add or delete entries subsequently. To do this, you should first create
the entries in the Tree widget. Then, use the \fBsetmode\fR method to
indicate the entries that can be opened or closed, and use the \fB\-opencmd\fR
and \fB\-closecmd\fR options to handle the opening and closing events. (Please
see the demonstration program \fITixish/examples/perl\-tix\-dyntree\fR).
\&\ \fI$parent\fR\->\fBScrolled\fR(\fB'Tree'\fR, ... );
\&\ \fI$parent\fR\->\fBScrlTree\fR( ... );
to create a scrolled \fBTree\fR. See Tk::Scrolled for details.
.IX Header "WIDGET METHODS"
The \fBTree\fR method creates a widget object.
This object supports the \fBconfigure\fR and \fBcget\fR methods
described in Tk::options which can be used to enquire and
modify the options described above.
The widget also inherits all the methods provided by the generic
The following additional methods are available for Tree widgets:
.IP "\fI$tree\fR\->\fBautosetmode\fR" 4
.IX Item "$tree->autosetmode"
This method calls the \fBsetmode\fR method for all the entries in
this Tree widget: if an entry has no child entries, its mode is set to
\&\fBnone\fR. Otherwise, if the entry has any hidden child entries, its
mode is set to \fBopen\fR; otherwise its mode is set to \fBclose\fR.
.IP "\fI$tree\fR\->\fBclose\fR(\fIentryPath\fR)" 4
.IX Item "$tree->close(entryPath)"
Close the entry given by \fIentryPath\fR if its \fImode\fR is \fBclose\fR.
.IP "\fI$tree\fR\->\fBgetmode\fR(\fIentryPath\fR)" 4
.IX Item "$tree->getmode(entryPath)"
Returns the current \fImode\fR of the entry given by \fIentryPath\fR.
.IP "\fI$tree\fR\->\fBopen\fR(\fIentryPath\fR)" 4
.IX Item "$tree->open(entryPath)"
Open the entry given by \fIentryPath\fR if its \fImode\fR is \fBopen\fR.
.IP "\fI$tree\fR\->\fBsetmode\fR(\fIentryPath, mode\fR)" 4
.IX Item "$tree->setmode(entryPath, mode)"
This method is used to indicate whether the entry given by
\&\fIentryPath\fR has children entries and whether the children are
visible. \fImode\fR must be one of \fBopen\fR,
\&\fBclose\fR or \fBnone\fR. If \fImode\fR is set to \fBopen\fR, a (+)
indicator is drawn next the the entry. If \fImode\fR is set to
\&\fBclose\fR, a (\-) indicator is drawn next the the entry. If
\&\fImode\fR is set to \fBnone\fR, no indicators will be drawn for this
entry. The default \fImode\fR is none. The \fBopen\fR mode indicates
the entry has hidden children and this entry can be opened by the
user. The \fBclose\fR mode indicates that all the children of the entry
are now visible and the entry can be closed by the user.
The basic mouse and keyboard bindings of the Tree widget are the same
as the bindings of the HList widget.
In addition, the entries can be opened or closed under the following
If the \fImode\fR of the entry is \fBopen\fR, it can be opened by clicking
If the \fImode\fR of the entry is \fBclose\fR, it can be closed by clicking
Perl/TK version by Chris Dean <ctdean@cogit.com>. Original Tcl/Tix
.IX Header "ACKNOWLEDGEMENTS"
Thanks to Achim Bohnet <ach@mpe.mpg.de> for all his help.
projects / OpenSPARC-T2-DV / blob