summaryrefslogtreecommitdiffstats
path: root/doc/treectrl.n
diff options
context:
space:
mode:
authorkrischan <krischan>2002-12-28 13:41:15 (GMT)
committerkrischan <krischan>2002-12-28 13:41:15 (GMT)
commit108bc351b4d0118053643aede2b763cb17eeef73 (patch)
treec4e7646b92e8aa19556d54c69ed248aca2a0e9a7 /doc/treectrl.n
parent8d2df712c1944f83f0181de47eae0efb713481f8 (diff)
downloadtktreectrl-108bc351b4d0118053643aede2b763cb17eeef73.zip
tktreectrl-108bc351b4d0118053643aede2b763cb17eeef73.tar.gz
tktreectrl-108bc351b4d0118053643aede2b763cb17eeef73.tar.bz2
- Added subcommands index, move, and neededwidth of widget command column.
- Added widget command numcolumns - Added description of tail column to section COLUMNS
Diffstat (limited to 'doc/treectrl.n')
-rw-r--r--doc/treectrl.n41
1 files changed, 37 insertions, 4 deletions
diff --git a/doc/treectrl.n b/doc/treectrl.n
index 625ac47..3201b06 100644
--- a/doc/treectrl.n
+++ b/doc/treectrl.n
@@ -7,7 +7,7 @@
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\"
-'\" $Id: treectrl.n,v 1.7 2002/12/27 22:04:06 krischan Exp $
+'\" $Id: treectrl.n,v 1.8 2002/12/28 13:41:15 krischan Exp $
'\"
.so man.macros
.TH treectrl n 8.4 Tk "Tk Commands"
@@ -270,7 +270,8 @@ If \fB\-recurse\fR is specified, all descendants of \fIitemDesc\fR
will also be collapsed.
.TP
\fIpathName \fBcolumn \fIoption\fR \fIcolumn\fR ?\fIarg ...\fR?
-This command is used to manipulate the columns of the treectrl widget.
+This command is used to manipulate the columns of the treectrl widget
+(see section COLUMNS below).
The exact behavior of the command depends on the \fIoption\fR argument
that follows the \fBcolumn\fR argument.
The following forms of the command are supported:
@@ -285,7 +286,8 @@ an empty list is returned instead.
.TP
\fIpathName \fBcolumn cget \fIcolumn option\fR
This command returns the current value of the option named \fIoption\fR
-for the column specified by \fIcolumn\fR.
+for the column specified by \fIcolumn\fR,
+\fIColumn\fR may also be the string \fBtail\fR to specify the tail column.
\fIOption\fR may have any of the values accepted by the
\fBcolumn configure\fR widget command.
.TP
@@ -293,6 +295,7 @@ for the column specified by \fIcolumn\fR.
This command is similar to the \fBconfigure\fR widget command except
that it modifies options associated with the column specified by \fIcolumn\fR
instead of modifying options for the overall treectrl widget.
+\fIColumn\fR may also be the string \fBtail\fR to specify the tail column.
If no \fIoption\fR is specified, the command returns a list describing
all of the available options for \fIcolumn\fR (see \fBTk_ConfigureInfo\fR
for information on the format of this list).
@@ -313,6 +316,23 @@ Deletes the specified \fIcolumn\fR from the treectrl widget.
All remaining columns of the treectrl widget will get new column numbers:
in an unchanged order, but with succesive numbers.
.TP
+\fIpathName \fBcolumn index \fIcolumn\fR
+This command returns a decimal string giving the column number
+of the column specified by \fIcolumn\fR,
+which may also be the string \fBtail\fR to specify the tail column.
+.TP
+\fIpathName \fBcolumn move \fIcolumn\fR \fIbefore\fR
+Moves the specified \fIcolumn\fR to the left of the column
+specified by \fIbefore\fR.
+If \fIbefore\fR is the string \fBtail\fR,
+the column \fIcolumn\fR will become the last column.
+.TP
+\fIpathName \fBcolumn neededwidth \fIcolumn\fR
+This command returns a decimal string giving the needed width
+of the column specified by \fIcolumn\fR.
+The needed width is the maximum of the width of the column header
+and the width of the "widest" currently visible item.
+.TP
\fIpathName \fBcolumn width \fIcolumn\fR
This command returns a decimal string giving the width
of the column specified by \fIcolumn\fR,
@@ -339,7 +359,7 @@ sublist of the value returned if no \fIoption\fR is specified). If
one or more \fIoption\fR\-\fIvalue\fR 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.
-\fIOption\fR may have any of the values accepted by the \fBtree\fR
+\fIOption\fR may have any of the values accepted by the \fBtreectrl\fR
command.
.TP
\fIpathName \fBdepth\fR ?\fIitemDesc\fR?
@@ -778,6 +798,13 @@ Returns 1 if the dotted line surrounding the marquee is currently visible,
0 otherwise.
.RE
.TP
+\fIpathName \fBnumcolumns\fR
+Returns a decimal string giving the number of
+columns configured in the treectrl widget.
+Since the always existant tail column is ignored by this command,
+the number can be 0 if no column is configured yet.
+.RE
+.TP
\fIpathName \fBnumitems\fR
Returns a decimal string giving the number of
items created in the treectrl widget.
@@ -1123,6 +1150,12 @@ as numerical index as given by the first \fBcolumn configure\fR
widget command which created the column or by its name,
which can be configured my means of the \fB-tag\fR column option.
+There is always one special column, the tail column, which fills
+all space to the right of the last ordinary column.
+This column can only be specified by its name \fBtail\fR, it has no number.
+It is explicitely mentioned for a widget command,
+if its \fIcolumn\fR argument can also specify the tail column.
+
The following options are supported for columns:
.TP
\fB\-arrow \fIdirection\fR