summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorkrischan <krischan>2002-12-24 23:29:13 (GMT)
committerkrischan <krischan>2002-12-24 23:29:13 (GMT)
commit90e31711936d9887d2128fd141d09d9a7ffa7988 (patch)
tree2b74a001879f0761aa489926ddc8989a8f73ab20
parent3f5d4c14bafdcb790fe75ecafcaf6897428fe5b1 (diff)
downloadtktreectrl-90e31711936d9887d2128fd141d09d9a7ffa7988.zip
tktreectrl-90e31711936d9887d2128fd141d09d9a7ffa7988.tar.gz
tktreectrl-90e31711936d9887d2128fd141d09d9a7ffa7988.tar.bz2
Sorted descriptions of item widget command alphabetically.
-rw-r--r--doc/treectrl.n116
1 files changed, 58 insertions, 58 deletions
diff --git a/doc/treectrl.n b/doc/treectrl.n
index bae0e65..a97a8ea 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.1 2002/12/24 22:18:33 krischan Exp $
+'\" $Id: treectrl.n,v 1.2 2002/12/24 23:29:13 krischan Exp $
'\"
.so man.macros
.TH treectrl n 8.4 Tk "Tk Commands"
@@ -310,11 +310,29 @@ Returns a list containing the numerical indexes of all ancestors
of the item specified by \fIitemDesc\fR from its parent upto the
root item.
.TP
+\fIpathName \fBitem bbox \fIitemDesc\fR ?\fIcolumn\fR? ?\fIelement\fR?
+Returns a list with four elements giving an approximate bounding box
+for the item described by \fIitemDesc\fR.
+If no further argument is specified, the bbox spans the area of the item
+over all columns. If a \fIcolumn\fR is specified, only the area of the item
+in this column is considered, if an additional \fIelement\fR is specified,
+the area of this \fIelement\fR in \fIcolumn\fR of the specified item is
+returned.
+.TP
\fIpathName \fBitem children \fIitemDesc\fR
Returns a list containing the numerical indexes of all children
of the item specified by \fIitemDesc\fR in the correct order from
the first child to the last child.
.TP
+\fIpathName \fBitem complex \fIitemDesc list\fR ...
+Modifies the elements of the item described by \fIitemDesc\fR.
+For every column of the treectrl there may be specified one \fIlist\fR,
+which in turn is an odd elemented list with at least three elements:
+the name of an element followed by \fIoption\-value\fR pairs.
+Every \fIoption\fR must be known by the element's type (see ELEMENTS below).
+The corresponding \fIvalue\fR will overwrite the value of the element for this
+one column in this item.
+.TP
\fIpathName \fBitem create\fR
Creates a new item and returns its numerical indexes.
.TP
@@ -329,63 +347,6 @@ If both \fIfirst\fR and \fIlast\fR are specified,
the must decribe items with the same root item;
then the range of items between \fIfirst\fR and \fIlast\fR is deleted.
.TP
-\fIpathName \fBitem firstchild \fIparent\fR ?\fIchild\fR?
-If \fIchild\fR is not specified, returns the numerical index of the first
-child of the item described by \fIparent\fR.
-If \fIchild\fR is specified, it must described an item
-that is not an ancestor of \fIparent\fR.
-Then it will become the new first child of \fIparent\fR.
-.TP
-\fIpathName \fBitem lastchild \fIparent\fR ?\fIchild\fR?
-If \fIchild\fR is not specified, returns the numerical index of the last
-child of the item described by \fIparent\fR.
-If \fIchild\fR is specified, it must described an item
-that is not an ancestor of \fIparent\fR.
-Then it will become the new last child of \fIparent\fR.
-.TP
-\fIpathName \fBitem nextsibling \fIsibling\fR ?\fInext\fR?
-If \fInext\fR is not specified, returns the numerical index of the next
-sibling of the item described by \fIsibling\fR.
-If \fInext\fR is specified, it must described an item
-that is not an ancestor of \fIsibling\fR.
-Then it will become the new next sibling of \fIsibling\fR.
-.TP
-\fIpathName \fBitem numchildren \fIitemDesc\fR
-Returns the number of children of the item described by \fIitemDesc\fR.
-.TP
-\fIpathName \fBitem parent \fIitemDesc\fR
-Returns the numerical index of the parent of the item
-described by \fIitemDesc\fR.
-.TP
-\fIpathName \fBitem prevsibling \fIsibling\fR ?\fIprev\fR?
-If \fIprev\fR is not specified, returns the numerical index of the previous
-sibling of the item described by \fIsibling\fR.
-If \fIprev\fR is specified, it must described an item
-that is not an ancestor of \fIsibling\fR.
-Then it will become the new previous sibling of \fIsibling\fR.
-.TP
-\fIpathName \fBitem remove \fIitemDesc\fR
-Removes the item described by \fIitemDesc\fR
-from the children list of its father, so that it will become an orphan.
-.TP
-\fIpathName \fBitem bbox \fIitemDesc\fR ?\fIcolumn\fR? ?\fIelement\fR?
-Returns a list with four elements giving an approximate bounding box
-for the item described by \fIitemDesc\fR.
-If no further argument is specified, the bbox spans the area of the item
-over all columns. If a \fIcolumn\fR is specified, only the area of the item
-in this column is considered, if an additional \fIelement\fR is specified,
-the area of this \fIelement\fR in \fIcolumn\fR of the specified item is
-returned.
-.TP
-\fIpathName \fBitem complex \fIitemDesc list\fR ...
-Modifies the elements of the item described by \fIitemDesc\fR.
-For every column of the treectrl there may be specified one \fIlist\fR,
-which in turn is an odd elemented list with at least three elements:
-the name of an element followed by \fIoption\-value\fR pairs.
-Every \fIoption\fR must be known by the element's type (see ELEMENTS below).
-The corresponding \fIvalue\fR will overwrite the value of the element for this
-one column in this item.
-.TP
\fIpathName \fBitem dump \fIitemDesc\fR
Returns a list with six elements in the form
\fBindex \fIindex \fBindexVis \fIindexVis \fBneededHeight \fIneededHeight\fR.
@@ -431,6 +392,13 @@ modifies the given option(s) to have the given value(s) in the
in this case the command returns an empty string.
.RE
.TP
+\fIpathName \fBitem firstchild \fIparent\fR ?\fIchild\fR?
+If \fIchild\fR is not specified, returns the numerical index of the first
+child of the item described by \fIparent\fR.
+If \fIchild\fR is specified, it must described an item
+that is not an ancestor of \fIparent\fR.
+Then it will become the new first child of \fIparent\fR.
+.TP
\fIpathName \fBitem hasbutton \fIitemDesc\fR ?\fIboolean\fR?
If \fIboolean\fR is not specified, returns 1 if to the left of
the item described by \fIitemDesc\fR a button should be drawn, 0 otherwise.
@@ -452,6 +420,38 @@ parent of the item decribed by \fIdescendant\fR, 0 otherwise.
Returns 1, if the item described by \fIitemDesc\fR has cuurently the
state \fBopen\fR switched on, 0 otherwise.
.TP
+\fIpathName \fBitem lastchild \fIparent\fR ?\fIchild\fR?
+If \fIchild\fR is not specified, returns the numerical index of the last
+child of the item described by \fIparent\fR.
+If \fIchild\fR is specified, it must described an item
+that is not an ancestor of \fIparent\fR.
+Then it will become the new last child of \fIparent\fR.
+.TP
+\fIpathName \fBitem nextsibling \fIsibling\fR ?\fInext\fR?
+If \fInext\fR is not specified, returns the numerical index of the next
+sibling of the item described by \fIsibling\fR.
+If \fInext\fR is specified, it must described an item
+that is not an ancestor of \fIsibling\fR.
+Then it will become the new next sibling of \fIsibling\fR.
+.TP
+\fIpathName \fBitem numchildren \fIitemDesc\fR
+Returns the number of children of the item described by \fIitemDesc\fR.
+.TP
+\fIpathName \fBitem parent \fIitemDesc\fR
+Returns the numerical index of the parent of the item
+described by \fIitemDesc\fR.
+.TP
+\fIpathName \fBitem prevsibling \fIsibling\fR ?\fIprev\fR?
+If \fIprev\fR is not specified, returns the numerical index of the previous
+sibling of the item described by \fIsibling\fR.
+If \fIprev\fR is specified, it must described an item
+that is not an ancestor of \fIsibling\fR.
+Then it will become the new previous sibling of \fIsibling\fR.
+.TP
+\fIpathName \fBitem remove \fIitemDesc\fR
+Removes the item described by \fIitemDesc\fR
+from the children list of its father, so that it will become an orphan.
+.TP
\fIpathName \fBitem rnc \fIitemDesc\fR
Returns a list of two integers, which corresponds to the row and column
of the item described by \fIitemDesc\fR for a vertical oriented treectrl;