[column delete] now accepts an optional second argument to delete a range of columns with one call.

Added a bunch of links to the COLUMN DESCRIPTION section.
author: treectrl <treectrl> 2005-09-07 20:38:04 (GMT)
committer: treectrl <treectrl> 2005-09-07 20:38:04 (GMT)
commit: ff8c0cd7c0e0954908661171d562467ed5ffcbed (patch)
tree: 95c17d14db670aed3a576d1197a15475cd6985a5 /doc
parent: 9332eca77a4688d640554af94b1323a72275e33d (diff)
download: tktreectrl-ff8c0cd7c0e0954908661171d562467ed5ffcbed.zip
tktreectrl-ff8c0cd7c0e0954908661171d562467ed5ffcbed.tar.gz
tktreectrl-ff8c0cd7c0e0954908661171d562467ed5ffcbed.tar.bz2
3 files changed, 171 insertions, 129 deletions
diff --git a/doc/treectrl.html b/doc/treectrl.html
index bfaf0cb..1477ed6 100644
--- a/doc/treectrl.html
+++ b/doc/treectrl.html
@@ -1,10 +1,10 @@
-<! -- Copyright (c) 2002-2003 Christian Krone.   --    --   See the file &quot;license.terms&quot; for information on usage and redistribution   --   of this file, and for a DISCLAIMER OF ALL WARRANTIES.   --    --   $Id: treectrl.html,v 1.30 2005/07/23 00:35:20 treectrl Exp $
+<! -- Copyright (c) 2002-2003 Christian Krone.   --    --   See the file &quot;license.terms&quot; for information on usage and redistribution   --   of this file, and for a DISCLAIMER OF ALL WARRANTIES.   --    --   $Id: treectrl.html,v 1.31 2005/09/07 20:38:04 treectrl Exp $
    --><html><head>
 <title>treectrl - Tk Commands </title>
 </head>
 <! -- Generated from file 'doc/treectrl.man' by tcllib/doctools with format 'html'
    -->
-<! -- CVS: $Id: treectrl.html,v 1.30 2005/07/23 00:35:20 treectrl Exp $ treectrl.n
+<! -- CVS: $Id: treectrl.html,v 1.31 2005/09/07 20:38:04 treectrl Exp $ treectrl.n
    -->
 
 <body>
@@ -51,22 +51,22 @@ package require <b>treectrl 2.1</b><br>
 <tr valign=top ><td ><a href="#5"><i class='arg'>pathName</i> <b class='cmd'>cget</b> <i class='arg'>option</i></a></td></tr>
 <tr valign=top ><td ><a href="#6"><i class='arg'>pathName</i> <b class='cmd'>collapse</b> ?<strong>-recurse</strong>? ?<i class='arg'>itemDesc ...</i>?</a></td></tr>
 <tr valign=top ><td ><a href="#7"><i class='arg'>pathName</i> <b class='cmd'>column</b> <i class='arg'>option</i> <i class='arg'>column</i> ?<i class='arg'>arg ...</i>?</a></td></tr>
-<tr valign=top ><td ><a href="#8"><i class='arg'>pathName</i> <b class='cmd'>column bbox</b> <i class='arg'>column</i></a></td></tr>
-<tr valign=top ><td ><a href="#9"><i class='arg'>pathName</i> <b class='cmd'>column cget</b> <i class='arg'>column</i> <i class='arg'>option</i></a></td></tr>
-<tr valign=top ><td ><a href="#10"><i class='arg'>pathName</i> <b class='cmd'>column configure</b> <i class='arg'>column</i> ?<i class='arg'>option</i>? ?<i class='arg'>value</i>? ?<i class='arg'>option value ...</i>?</a></td></tr>
+<tr valign=top ><td ><a href="#8"><i class='arg'>pathName</i> <b class='cmd'>column bbox</b> <i class='arg'>columnDesc</i></a></td></tr>
+<tr valign=top ><td ><a href="#9"><i class='arg'>pathName</i> <b class='cmd'>column cget</b> <i class='arg'>columnDesc</i> <i class='arg'>option</i></a></td></tr>
+<tr valign=top ><td ><a href="#10"><i class='arg'>pathName</i> <b class='cmd'>column configure</b> <i class='arg'>columnDesc</i> ?<i class='arg'>option</i>? ?<i class='arg'>value</i>? ?<i class='arg'>option value ...</i>?</a></td></tr>
 <tr valign=top ><td ><a href="#11"><i class='arg'>pathName</i> <b class='cmd'>column compare</b> <i class='arg'>column1</i> <i class='arg'>op</i> <i class='arg'>column2</i></a></td></tr>
 <tr valign=top ><td ><a href="#12"><i class='arg'>pathName</i> <b class='cmd'>column count</b></a></td></tr>
 <tr valign=top ><td ><a href="#13"><i class='arg'>pathName</i> <b class='cmd'>column create</b> ?<i class='arg'>option value ...</i>?</a></td></tr>
-<tr valign=top ><td ><a href="#14"><i class='arg'>pathName</i> <b class='cmd'>column delete</b> <i class='arg'>column</i></a></td></tr>
+<tr valign=top ><td ><a href="#14"><i class='arg'>pathName</i> <b class='cmd'>column delete</b> <i class='arg'>first</i> ?<i class='arg'>last</i>?</a></td></tr>
 <tr valign=top ><td ><a href="#15"><i class='arg'>pathName</i> <b class='cmd'>column dragcget</b> <i class='arg'>option</i></a></td></tr>
 <tr valign=top ><td ><a href="#16"><i class='arg'>pathName</i> <b class='cmd'>column dragconfigure</b> ?<i class='arg'>option</i>? ?<i class='arg'>value</i>? ?<i class='arg'>option value ...</i>?</a></td></tr>
-<tr valign=top ><td ><a href="#17"><i class='arg'>pathName</i> <b class='cmd'>column index</b> <i class='arg'>column</i></a></td></tr>
-<tr valign=top ><td ><a href="#18"><i class='arg'>pathName</i> <b class='cmd'>column id</b> <i class='arg'>column</i></a></td></tr>
+<tr valign=top ><td ><a href="#17"><i class='arg'>pathName</i> <b class='cmd'>column index</b> <i class='arg'>columnDesc</i></a></td></tr>
+<tr valign=top ><td ><a href="#18"><i class='arg'>pathName</i> <b class='cmd'>column id</b> <i class='arg'>columnDesc</i></a></td></tr>
 <tr valign=top ><td ><a href="#19"><i class='arg'>pathName</i> <b class='cmd'>column list</b> ?<i class='arg'>-visible</i>?</a></td></tr>
-<tr valign=top ><td ><a href="#20"><i class='arg'>pathName</i> <b class='cmd'>column move</b> <i class='arg'>column</i> <i class='arg'>before</i></a></td></tr>
-<tr valign=top ><td ><a href="#21"><i class='arg'>pathName</i> <b class='cmd'>column neededwidth</b> <i class='arg'>column</i></a></td></tr>
-<tr valign=top ><td ><a href="#22"><i class='arg'>pathName</i> <b class='cmd'>column order</b> <i class='arg'>column</i> ?<i class='arg'>-visible</i>?</a></td></tr>
-<tr valign=top ><td ><a href="#23"><i class='arg'>pathName</i> <b class='cmd'>column width</b> <i class='arg'>column</i></a></td></tr>
+<tr valign=top ><td ><a href="#20"><i class='arg'>pathName</i> <b class='cmd'>column move</b> <i class='arg'>columnDesc</i> <i class='arg'>beforeDesc</i></a></td></tr>
+<tr valign=top ><td ><a href="#21"><i class='arg'>pathName</i> <b class='cmd'>column neededwidth</b> <i class='arg'>columnDesc</i></a></td></tr>
+<tr valign=top ><td ><a href="#22"><i class='arg'>pathName</i> <b class='cmd'>column order</b> <i class='arg'>columnDesc</i> ?<i class='arg'>-visible</i>?</a></td></tr>
+<tr valign=top ><td ><a href="#23"><i class='arg'>pathName</i> <b class='cmd'>column width</b> <i class='arg'>columnDesc</i></a></td></tr>
 <tr valign=top ><td ><a href="#24"><i class='arg'>pathName</i> <b class='cmd'>compare</b> <i class='arg'>itemDesc1</i> <i class='arg'>op</i> <i class='arg'>itemDesc2</i></a></td></tr>
 <tr valign=top ><td ><a href="#25"><i class='arg'>pathName</i> <b class='cmd'>configure</b> ?<i class='arg'>option</i>? ?<i class='arg'>value option value ...</i>?</a></td></tr>
 <tr valign=top ><td ><a href="#26"><i class='arg'>pathName</i> <b class='cmd'>contentbox</b></a></td></tr>
@@ -765,41 +765,44 @@ The following forms of the command are supported:
 
 <br><br>
 <dl>
-<dt><a name="8"><i class='arg'>pathName</i> <b class='cmd'>column bbox</b> <i class='arg'>column</i></a><dd>
+<dt><a name="8"><i class='arg'>pathName</i> <b class='cmd'>column bbox</b> <i class='arg'>columnDesc</i></a><dd>
 
 Returns a list with four elements giving the bounding box
-for the column header specified by <i class='arg'>column</i>.
+of the header of the column specified by the
+<a href="#column_description">column description</a> <i class='arg'>columnDesc</i>.
 If the treectrl is configured not to display the column headers
 by means of the <strong>-showheader</strong> option, then
 an empty list is returned instead.
 
 <br><br>
-<dt><a name="9"><i class='arg'>pathName</i> <b class='cmd'>column cget</b> <i class='arg'>column</i> <i class='arg'>option</i></a><dd>
+<dt><a name="9"><i class='arg'>pathName</i> <b class='cmd'>column cget</b> <i class='arg'>columnDesc</i> <i class='arg'>option</i></a><dd>
 
 This command returns the current value of the option named <i class='arg'>option</i>
-for the column specified by <i class='arg'>column</i>,
-<i class='arg'>Column</i> may also be the string <strong>tail</strong> to specify the tail column.
+for the column specified by the
+<a href="#column_description">column description</a> <i class='arg'>columnDesc</i>,
+<i class='arg'>ColumnDesc</i> may also be the string <strong>tail</strong> to specify the tail column.
 <i class='arg'>Option</i> may have any of the values accepted by the
 <b class='cmd'>column configure</b> widget command.
 
 <br><br>
-<dt><a name="10"><i class='arg'>pathName</i> <b class='cmd'>column configure</b> <i class='arg'>column</i> ?<i class='arg'>option</i>? ?<i class='arg'>value</i>? ?<i class='arg'>option value ...</i>?</a><dd>
+<dt><a name="10"><i class='arg'>pathName</i> <b class='cmd'>column configure</b> <i class='arg'>columnDesc</i> ?<i class='arg'>option</i>? ?<i class='arg'>value</i>? ?<i class='arg'>option value ...</i>?</a><dd>
 
 This command is similar to the <b class='cmd'>configure</b> widget command except
-that it modifies options associated with the column specified by <i class='arg'>column</i>
+that it modifies options associated with the column specified by the
+<a href="#column_description">column description</a> <i class='arg'>columnDesc</i>
 instead of modifying options for the overall treectrl widget.
-<i class='arg'>Column</i> may be the string <strong>tail</strong> to specify the tail column.
-If <i class='arg'>column</i> is the string <strong>all</strong>, at least one option-value pair
+<i class='arg'>ColumnDesc</i> may be the string <strong>tail</strong> to specify the tail column.
+If <i class='arg'>columnDesc</i> is the string <strong>all</strong>, at least one option-value pair
 must be given; in this case all the columns are configured.
 If no <i class='arg'>option</i> is specified, the command returns a list describing
-all of the available options for <i class='arg'>column</i> (see <strong>Tk_ConfigureInfo</strong>
+all of the available options for <i class='arg'>columnDesc</i> (see <strong>Tk_ConfigureInfo</strong>
 for information on the format of this list).
 If <i class='arg'>option</i> is specified with no <i class='arg'>value</i>, 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 <i class='arg'>option</i>
 is specified).
 If one or more <i class='arg'>option</i>-<i class='arg'>value</i> pairs are specified, then the command
-modifies the given option(s) to have the given value(s) for <i class='arg'>column</i>;
+modifies the given option(s) to have the given value(s) for <i class='arg'>columnDesc</i>;
 in this case the command returns an empty string.
 <br><br>
 
@@ -808,7 +811,8 @@ See <a href="#columns">COLUMNS</a> below for details on the options available fo
 <br><br>
 <dt><a name="11"><i class='arg'>pathName</i> <b class='cmd'>column compare</b> <i class='arg'>column1</i> <i class='arg'>op</i> <i class='arg'>column2</i></a><dd>
 
-From both <i class='arg'>column</i>s the index is retrieved
+For both <a href="#column_description">column descriptions</a> <i class='arg'>column1</i>
+and <i class='arg'>column2</i> the index is retrieved
 (as returned from the <b class='cmd'>column order</b> widget command).
 Then these indexes are compared using the operator <i class='arg'>op</i>, which must
 be either <strong>&lt;</strong>,  <strong>&lt;=</strong>,  <strong>==</strong>, <strong>&gt;=</strong>, <strong>&gt;</strong>,
@@ -834,10 +838,14 @@ placed to the right of all other columns (except the <strong>tail</strong> colum
 of the new column.
 
 <br><br>
-<dt><a name="14"><i class='arg'>pathName</i> <b class='cmd'>column delete</b> <i class='arg'>column</i></a><dd>
+<dt><a name="14"><i class='arg'>pathName</i> <b class='cmd'>column delete</b> <i class='arg'>first</i> ?<i class='arg'>last</i>?</a><dd>
 
-Deletes the specified <i class='arg'>column</i> from the treectrl widget. If <i class='arg'>column</i>
-is the string <strong>all</strong>, all columns except the tail column are deleted.
+Deletes the specified column(s). <i class='arg'>First</i> and <i class='arg'>last</i> must be valid
+<a href="#column_description">column descriptions</a>. If either <i class='arg'>first</i>
+or <i class='arg'>last</i> is specified as <strong>all</strong>, then all columns are deleted.
+The <strong>tail</strong> column cannot be deleted and it is an error to specify it.
+The order of <i class='arg'>first</i> and <i class='arg'>last</i> doesn't matter, and <i class='arg'>first</i> may
+be equal to <i class='arg'>last</i>.
 
 <br><br>
 <dt><a name="15"><i class='arg'>pathName</i> <b class='cmd'>column dragcget</b> <i class='arg'>option</i></a><dd>
@@ -891,16 +899,16 @@ The 2-pixel-thick line will be drawn over the left edge of <i class='arg'>column
 
 </dl>
 
-<dt><a name="17"><i class='arg'>pathName</i> <b class='cmd'>column index</b> <i class='arg'>column</i></a><dd>
+<dt><a name="17"><i class='arg'>pathName</i> <b class='cmd'>column index</b> <i class='arg'>columnDesc</i></a><dd>
 
 Deprecated. Use <b class='cmd'>column id</b> instead.
 
 <br><br>
-<dt><a name="18"><i class='arg'>pathName</i> <b class='cmd'>column id</b> <i class='arg'>column</i></a><dd>
+<dt><a name="18"><i class='arg'>pathName</i> <b class='cmd'>column id</b> <i class='arg'>columnDesc</i></a><dd>
 
-This command resolves the column description <i class='arg'>column</i> into a unique column
-identifier (see <a href="#column_description">COLUMN DESCRIPTION</a> below).
-If the column described by <i class='arg'>column</i> doesn't exist, this command returns
+This command resolves the <a href="#column_description">column description</a>
+<i class='arg'>columnDesc</i> into a unique column identifier.
+If the column described by <i class='arg'>columnDesc</i> doesn't exist, this command returns
 an empty string.
 
 <br><br>
@@ -911,35 +919,40 @@ from left to right. If <i class='arg'>-visible</i> is given, only columns whose
 option is true are returned.
 
 <br><br>
-<dt><a name="20"><i class='arg'>pathName</i> <b class='cmd'>column move</b> <i class='arg'>column</i> <i class='arg'>before</i></a><dd>
+<dt><a name="20"><i class='arg'>pathName</i> <b class='cmd'>column move</b> <i class='arg'>columnDesc</i> <i class='arg'>beforeDesc</i></a><dd>
 
-Moves the specified <i class='arg'>column</i> to the left of the column
-specified by <i class='arg'>before</i>.
-If <i class='arg'>before</i> is the string <strong>tail</strong>,
-the column <i class='arg'>column</i> will become the last column.
+Moves the column specified by <i class='arg'>columnDesc</i> to the left of the column
+specified by <i class='arg'>beforeDesc</i>. Both <i class='arg'>columnDesc</i> and <i class='arg'>beforeDesc</i>
+must be valid <a href="#column_description">column descriptions</a>.
+If <i class='arg'>beforeDesc</i> is the string <strong>tail</strong>,
+the column <i class='arg'>columnDesc</i> will become the last column.
 
 <br><br>
-<dt><a name="21"><i class='arg'>pathName</i> <b class='cmd'>column neededwidth</b> <i class='arg'>column</i></a><dd>
+<dt><a name="21"><i class='arg'>pathName</i> <b class='cmd'>column neededwidth</b> <i class='arg'>columnDesc</i></a><dd>
 
 This command returns a decimal string giving the needed width
-of the column specified by <i class='arg'>column</i>.
+of the column specified by the <a href="#column_description">column description</a>
+<i class='arg'>columnDesc</i>.
 The needed width is the maximum of the width of the column header
-and the width of the <em>widest</em> currently visible item.
+and the width of the widest style in any visible item.
 
 <br><br>
-<dt><a name="22"><i class='arg'>pathName</i> <b class='cmd'>column order</b> <i class='arg'>column</i> ?<i class='arg'>-visible</i>?</a><dd>
+<dt><a name="22"><i class='arg'>pathName</i> <b class='cmd'>column order</b> <i class='arg'>columnDesc</i> ?<i class='arg'>-visible</i>?</a><dd>
 
-This command returns a decimal string giving the position of <i class='arg'>column</i>
+This command returns a decimal string giving the position of the column
+specified by the <a href="#column_description">column description</a>
+<i class='arg'>columnDesc</i>
 in the list of columns starting from zero for the leftmost column.
 If <i class='arg'>-visible</i> is given, only columns whose -visible
-option is true are considered, and -1 is returned if <i class='arg'>column</i>'s -visible
+option is true are considered, and -1 is returned if <i class='arg'>columnDesc</i>'s -visible
 option is false.
 
 <br><br>
-<dt><a name="23"><i class='arg'>pathName</i> <b class='cmd'>column width</b> <i class='arg'>column</i></a><dd>
+<dt><a name="23"><i class='arg'>pathName</i> <b class='cmd'>column width</b> <i class='arg'>columnDesc</i></a><dd>
 
 This command returns a decimal string giving the width in pixels
-of the column specified by <i class='arg'>column</i>,
+of the column specified by the <a href="#column_description">column description</a>
+<i class='arg'>columnDesc</i>,
 even if the treectrl is configured to not display the column headers
 by means of the <strong>-showheader</strong> option.
 </dl>
@@ -1451,14 +1464,15 @@ and b) each ancestor's <strong>-visible</strong> option is true
 <dt><a name="61"><i class='arg'>pathName</i> <b class='cmd'>item delete</b> <i class='arg'>first</i> ?<i class='arg'>last</i>?</a><dd>
 
 Deletes the specified item(s).
-<i class='arg'>First</i> and <i class='arg'>last</i> must be the string <strong>all</strong> or a valid
-<a href="#item_description">item description</a>.
+<i class='arg'>First</i> and <i class='arg'>last</i> must be valid
+<a href="#item_description">item descriptions</a>.
 If either <i class='arg'>first</i> or <i class='arg'>last</i> is specified as <strong>all</strong>, then all items are
 deleted. If <i class='arg'>first</i> is specified and <i class='arg'>last</i> isn't
 specified, the item described by <i class='arg'>first</i> is deleted.
 If both <i class='arg'>first</i> and <i class='arg'>last</i> are specified,
 they must decribe items with a common ancestor;
 then the range of items between <i class='arg'>first</i> and <i class='arg'>last</i> is deleted.
+The order of <i class='arg'>first</i> and <i class='arg'>last</i> doesn't matter.
 <br><br>
 Deleting an item deletes any child items of the deleted item recursively.
 If the current <strong>active</strong> item is deleted, the root item becomes the new active item.
diff --git a/doc/treectrl.man b/doc/treectrl.man
index 01dbc94..829f222 100644
--- a/doc/treectrl.man
+++ b/doc/treectrl.man
@@ -3,7 +3,7 @@
   See the file "license.terms" for information on usage and redistribution
   of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 
-  $Id: treectrl.man,v 1.31 2005/07/23 00:35:20 treectrl Exp $}
+  $Id: treectrl.man,v 1.32 2005/09/07 20:38:04 treectrl Exp $}
 ][manpage_begin treectrl n 2.1]
 [moddesc {Tk Commands}]
 [titledesc {Create and manipulate hierarchical multicolumn widgets}]
@@ -408,44 +408,48 @@ that follows the [cmd column] argument.
 The following forms of the command are supported:
 
 [list_begin definitions]
-[call [arg pathName] [cmd {column bbox}] [arg column]]
+[call [arg pathName] [cmd {column bbox}] [arg columnDesc]]
 Returns a list with four elements giving the bounding box
-for the column header specified by [arg column].
+of the header of the column specified by the
+[sectref {COLUMN DESCRIPTION} {column description}] [arg columnDesc].
 If the treectrl is configured not to display the column headers
 by means of the [option -showheader] option, then
 an empty list is returned instead.
 
-[call [arg pathName] [cmd {column cget}] [arg column] [arg option]]
+[call [arg pathName] [cmd {column cget}] [arg columnDesc] [arg option]]
 This command returns the current value of the option named [arg option]
-for the column specified by [arg column],
-[arg Column] may also be the string [const tail] to specify the tail column.
+for the column specified by the
+[sectref {COLUMN DESCRIPTION} {column description}] [arg columnDesc],
+[arg ColumnDesc] may also be the string [const tail] to specify the tail column.
 [arg Option] may have any of the values accepted by the
 [cmd {column configure}] widget command.
 
-[call [arg pathName] [cmd {column configure}] [arg column] \
+[call [arg pathName] [cmd {column configure}] [arg columnDesc] \
      [opt [arg option]] [opt [arg value]] [opt [arg {option value ...}]]]
 This command is similar to the [cmd configure] widget command except
-that it modifies options associated with the column specified by [arg column]
+that it modifies options associated with the column specified by the
+[sectref {COLUMN DESCRIPTION} {column description}] [arg columnDesc]
 instead of modifying options for the overall treectrl widget.
-[arg Column] may be the string [const tail] to specify the tail column.
-If [arg column] is the string [const all], at least one option-value pair
+[arg ColumnDesc] may be the string [const tail] to specify the tail column.
+If [arg columnDesc] is the string [const all], at least one option-value pair
 must be given; in this case all the columns are configured.
 If no [arg option] is specified, the command returns a list describing
-all of the available options for [arg column] (see [fun Tk_ConfigureInfo]
+all of the available options for [arg columnDesc] (see [fun Tk_ConfigureInfo]
 for information on the format of this list).
 If [arg option] is specified with no [arg 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 [arg option]
 is specified).
 If one or more [arg option]-[arg value] pairs are specified, then the command
-modifies the given option(s) to have the given value(s) for [arg column];
+modifies the given option(s) to have the given value(s) for [arg columnDesc];
 in this case the command returns an empty string.
 [nl]
 
 See [sectref COLUMNS] below for details on the options available for columns.
 
 [call [arg pathName] [cmd {column compare}] [arg column1] [arg op] [arg column2]]
-From both [arg column]s the index is retrieved
+For both [sectref {COLUMN DESCRIPTION} {column descriptions}] [arg column1]
+and [arg column2] the index is retrieved
 (as returned from the [cmd {column order}] widget command).
 Then these indexes are compared using the operator [arg op], which must
 be either [const <],  [const <=],  [const ==], [const >=], [const >],
@@ -466,9 +470,13 @@ placed to the right of all other columns (except the [const tail] column). Any
 [cmd "column configure"] command. The return value is the unique identifier
 of the new column.
 
-[call [arg pathName] [cmd {column delete}] [arg column]]
-Deletes the specified [arg column] from the treectrl widget. If [arg column]
-is the string [const all], all columns except the tail column are deleted.
+[call [arg pathName] [cmd {column delete}] [arg first] [opt [arg last]]]
+Deletes the specified column(s). [arg First] and [arg last] must be valid
+[sectref {COLUMN DESCRIPTION} {column descriptions}]. If either [arg first]
+or [arg last] is specified as [const all], then all columns are deleted.
+The [const tail] column cannot be deleted and it is an error to specify it.
+The order of [arg first] and [arg last] doesn't matter, and [arg first] may
+be equal to [arg last].
 
 [call [arg pathName] [cmd {column dragcget}] [arg option]]
 [call [arg pathName] [cmd {column dragconfigure}] \
@@ -513,13 +521,13 @@ The 2-pixel-thick line will be drawn over the left edge of [arg column].
 
 [list_end]
 
-[call [arg pathName] [cmd {column index}] [arg column]]
+[call [arg pathName] [cmd {column index}] [arg columnDesc]]
 Deprecated. Use [cmd {column id}] instead.
 
-[call [arg pathName] [cmd {column id}] [arg column]]
-This command resolves the column description [arg column] into a unique column
-identifier (see [sectref {COLUMN DESCRIPTION}] below).
-If the column described by [arg column] doesn't exist, this command returns
+[call [arg pathName] [cmd {column id}] [arg columnDesc]]
+This command resolves the [sectref {COLUMN DESCRIPTION} {column description}]
+[arg columnDesc] into a unique column identifier.
+If the column described by [arg columnDesc] doesn't exist, this command returns
 an empty string.
 
 [call [arg pathName] [cmd {column list}] [opt [arg -visible]]]
@@ -527,28 +535,33 @@ This command returns a list of identifiers for every column (except the tail)
 from left to right. If [arg -visible] is given, only columns whose -visible
 option is true are returned.
 
-[call [arg pathName] [cmd {column move}] [arg column] [arg before]]
-Moves the specified [arg column] to the left of the column
-specified by [arg before].
-If [arg before] is the string [const tail],
-the column [arg column] will become the last column.
+[call [arg pathName] [cmd {column move}] [arg columnDesc] [arg beforeDesc]]
+Moves the column specified by [arg columnDesc] to the left of the column
+specified by [arg beforeDesc]. Both [arg columnDesc] and [arg beforeDesc]
+must be valid [sectref {COLUMN DESCRIPTION} {column descriptions}].
+If [arg beforeDesc] is the string [const tail],
+the column [arg columnDesc] will become the last column.
 
-[call [arg pathName] [cmd {column neededwidth}] [arg column]]
+[call [arg pathName] [cmd {column neededwidth}] [arg columnDesc]]
 This command returns a decimal string giving the needed width
-of the column specified by [arg column].
+of the column specified by the [sectref {COLUMN DESCRIPTION} {column description}]
+[arg columnDesc].
 The needed width is the maximum of the width of the column header
-and the width of the [emph widest] currently visible item.
+and the width of the widest style in any visible item.
 
-[call [arg pathName] [cmd {column order}] [arg column] [opt [arg -visible]]]
-This command returns a decimal string giving the position of [arg column]
+[call [arg pathName] [cmd {column order}] [arg columnDesc] [opt [arg -visible]]]
+This command returns a decimal string giving the position of the column
+specified by the [sectref {COLUMN DESCRIPTION} {column description}]
+[arg columnDesc]
 in the list of columns starting from zero for the leftmost column.
 If [arg -visible] is given, only columns whose -visible
-option is true are considered, and -1 is returned if [arg column]'s -visible
+option is true are considered, and -1 is returned if [arg columnDesc]'s -visible
 option is false.
 
-[call [arg pathName] [cmd {column width}] [arg column]]
+[call [arg pathName] [cmd {column width}] [arg columnDesc]]
 This command returns a decimal string giving the width in pixels
-of the column specified by [arg column],
+of the column specified by the [sectref {COLUMN DESCRIPTION} {column description}]
+[arg columnDesc],
 even if the treectrl is configured to not display the column headers
 by means of the [option -showheader] option.
 [list_end]
@@ -985,14 +998,15 @@ and b) each ancestor's [option -visible] option is true
 
 [call [arg pathName] [cmd {item delete}] [arg first] [opt [arg last]]]
 Deletes the specified item(s).
-[arg First] and [arg last] must be the string [const all] or a valid
-[sectref {ITEM DESCRIPTION} {item description}].
+[arg First] and [arg last] must be valid
+[sectref {ITEM DESCRIPTION} {item descriptions}].
 If either [arg first] or [arg last] is specified as [const all], then all items are
 deleted. If [arg first] is specified and [arg last] isn't
 specified, the item described by [arg first] is deleted.
 If both [arg first] and [arg last] are specified,
 they must decribe items with a common ancestor;
 then the range of items between [arg first] and [arg last] is deleted.
+The order of [arg first] and [arg last] doesn't matter.
 [nl]
 Deleting an item deletes any child items of the deleted item recursively.
 If the current [const active] item is deleted, the root item becomes the new active item.
diff --git a/doc/treectrl.n b/doc/treectrl.n
index 2aac72e..facd4a2 100644
--- a/doc/treectrl.n
+++ b/doc/treectrl.n
@@ -6,7 +6,7 @@
 '\"   See the file "license.terms" for information on usage and redistribution
 '\"   of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\"
-'\"   $Id: treectrl.n,v 1.47 2005/07/23 00:35:21 treectrl Exp $
+'\"   $Id: treectrl.n,v 1.48 2005/09/07 20:38:05 treectrl Exp $
 .so man.macros
 .TH "treectrl" n 2.1 treectrl "Tk Commands"
 .BS
@@ -29,11 +29,11 @@ package require \fBtreectrl  2.1\fR
 .sp
 \fIpathName\fR \fBcolumn\fR \fIoption\fR \fIcolumn\fR ?\fIarg ...\fR?
 .sp
-\fIpathName\fR \fBcolumn bbox\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn bbox\fR \fIcolumnDesc\fR
 .sp
-\fIpathName\fR \fBcolumn cget\fR \fIcolumn\fR \fIoption\fR
+\fIpathName\fR \fBcolumn cget\fR \fIcolumnDesc\fR \fIoption\fR
 .sp
-\fIpathName\fR \fBcolumn configure\fR \fIcolumn\fR ?\fIoption\fR? ?\fIvalue\fR? ?\fIoption value ...\fR?
+\fIpathName\fR \fBcolumn configure\fR \fIcolumnDesc\fR ?\fIoption\fR? ?\fIvalue\fR? ?\fIoption value ...\fR?
 .sp
 \fIpathName\fR \fBcolumn compare\fR \fIcolumn1\fR \fIop\fR \fIcolumn2\fR
 .sp
@@ -41,25 +41,25 @@ package require \fBtreectrl  2.1\fR
 .sp
 \fIpathName\fR \fBcolumn create\fR ?\fIoption value ...\fR?
 .sp
-\fIpathName\fR \fBcolumn delete\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn delete\fR \fIfirst\fR ?\fIlast\fR?
 .sp
 \fIpathName\fR \fBcolumn dragcget\fR \fIoption\fR
 .sp
 \fIpathName\fR \fBcolumn dragconfigure\fR ?\fIoption\fR? ?\fIvalue\fR? ?\fIoption value ...\fR?
 .sp
-\fIpathName\fR \fBcolumn index\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn index\fR \fIcolumnDesc\fR
 .sp
-\fIpathName\fR \fBcolumn id\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn id\fR \fIcolumnDesc\fR
 .sp
 \fIpathName\fR \fBcolumn list\fR ?\fI-visible\fR?
 .sp
-\fIpathName\fR \fBcolumn move\fR \fIcolumn\fR \fIbefore\fR
+\fIpathName\fR \fBcolumn move\fR \fIcolumnDesc\fR \fIbeforeDesc\fR
 .sp
-\fIpathName\fR \fBcolumn neededwidth\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn neededwidth\fR \fIcolumnDesc\fR
 .sp
-\fIpathName\fR \fBcolumn order\fR \fIcolumn\fR ?\fI-visible\fR?
+\fIpathName\fR \fBcolumn order\fR \fIcolumnDesc\fR ?\fI-visible\fR?
 .sp
-\fIpathName\fR \fBcolumn width\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn width\fR \fIcolumnDesc\fR
 .sp
 \fIpathName\fR \fBcompare\fR \fIitemDesc1\fR \fIop\fR \fIitemDesc2\fR
 .sp
@@ -982,42 +982,46 @@ that follows the \fBcolumn\fR argument.
 The following forms of the command are supported:
 .RS
 .TP
-\fIpathName\fR \fBcolumn bbox\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn bbox\fR \fIcolumnDesc\fR
 Returns a list with four elements giving the bounding box
-for the column header specified by \fIcolumn\fR.
+of the header of the column specified by the
+\fBcolumn description\fR \fIcolumnDesc\fR.
 If the treectrl is configured not to display the column headers
 by means of the \fB-showheader\fR option, then
 an empty list is returned instead.
 .TP
-\fIpathName\fR \fBcolumn cget\fR \fIcolumn\fR \fIoption\fR
+\fIpathName\fR \fBcolumn cget\fR \fIcolumnDesc\fR \fIoption\fR
 This command returns the current value of the option named \fIoption\fR
-for the column specified by \fIcolumn\fR,
-\fIColumn\fR may also be the string \fBtail\fR to specify the tail column.
+for the column specified by the
+\fBcolumn description\fR \fIcolumnDesc\fR,
+\fIColumnDesc\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
-\fIpathName\fR \fBcolumn configure\fR \fIcolumn\fR ?\fIoption\fR? ?\fIvalue\fR? ?\fIoption value ...\fR?
+\fIpathName\fR \fBcolumn configure\fR \fIcolumnDesc\fR ?\fIoption\fR? ?\fIvalue\fR? ?\fIoption value ...\fR?
 This command is similar to the \fBconfigure\fR widget command except
-that it modifies options associated with the column specified by \fIcolumn\fR
+that it modifies options associated with the column specified by the
+\fBcolumn description\fR \fIcolumnDesc\fR
 instead of modifying options for the overall treectrl widget.
-\fIColumn\fR may be the string \fBtail\fR to specify the tail column.
-If \fIcolumn\fR is the string \fBall\fR, at least one option-value pair
+\fIColumnDesc\fR may be the string \fBtail\fR to specify the tail column.
+If \fIcolumnDesc\fR is the string \fBall\fR, at least one option-value pair
 must be given; in this case all the columns are configured.
 If no \fIoption\fR is specified, the command returns a list describing
-all of the available options for \fIcolumn\fR (see \fBTk_ConfigureInfo\fR
+all of the available options for \fIcolumnDesc\fR (see \fBTk_ConfigureInfo\fR
 for information on the format of this list).
 If \fIoption\fR is specified with no \fIvalue\fR, 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 \fIoption\fR
 is specified).
 If one or more \fIoption\fR-\fIvalue\fR pairs are specified, then the command
-modifies the given option(s) to have the given value(s) for \fIcolumn\fR;
+modifies the given option(s) to have the given value(s) for \fIcolumnDesc\fR;
 in this case the command returns an empty string.
 .sp
 See \fBCOLUMNS\fR below for details on the options available for columns.
 .TP
 \fIpathName\fR \fBcolumn compare\fR \fIcolumn1\fR \fIop\fR \fIcolumn2\fR
-From both \fIcolumn\fRs the index is retrieved
+For both \fBcolumn descriptions\fR \fIcolumn1\fR
+and \fIcolumn2\fR the index is retrieved
 (as returned from the \fBcolumn order\fR widget command).
 Then these indexes are compared using the operator \fIop\fR, which must
 be either \fB<\fR,  \fB<=\fR,  \fB==\fR, \fB>=\fR, \fB>\fR,
@@ -1038,9 +1042,13 @@ placed to the right of all other columns (except the \fBtail\fR column). Any
 \fBcolumn configure\fR command. The return value is the unique identifier
 of the new column.
 .TP
-\fIpathName\fR \fBcolumn delete\fR \fIcolumn\fR
-Deletes the specified \fIcolumn\fR from the treectrl widget. If \fIcolumn\fR
-is the string \fBall\fR, all columns except the tail column are deleted.
+\fIpathName\fR \fBcolumn delete\fR \fIfirst\fR ?\fIlast\fR?
+Deletes the specified column(s). \fIFirst\fR and \fIlast\fR must be valid
+\fBcolumn descriptions\fR. If either \fIfirst\fR
+or \fIlast\fR is specified as \fBall\fR, then all columns are deleted.
+The \fBtail\fR column cannot be deleted and it is an error to specify it.
+The order of \fIfirst\fR and \fIlast\fR doesn't matter, and \fIfirst\fR may
+be equal to \fIlast\fR.
 .TP
 \fIpathName\fR \fBcolumn dragcget\fR \fIoption\fR
 .TP
@@ -1083,13 +1091,13 @@ starting position.
 The 2-pixel-thick line will be drawn over the left edge of \fIcolumn\fR.
 .RE
 .TP
-\fIpathName\fR \fBcolumn index\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn index\fR \fIcolumnDesc\fR
 Deprecated. Use \fBcolumn id\fR instead.
 .TP
-\fIpathName\fR \fBcolumn id\fR \fIcolumn\fR
-This command resolves the column description \fIcolumn\fR into a unique column
-identifier (see \fBCOLUMN DESCRIPTION\fR below).
-If the column described by \fIcolumn\fR doesn't exist, this command returns
+\fIpathName\fR \fBcolumn id\fR \fIcolumnDesc\fR
+This command resolves the \fBcolumn description\fR
+\fIcolumnDesc\fR into a unique column identifier.
+If the column described by \fIcolumnDesc\fR doesn't exist, this command returns
 an empty string.
 .TP
 \fIpathName\fR \fBcolumn list\fR ?\fI-visible\fR?
@@ -1097,28 +1105,33 @@ This command returns a list of identifiers for every column (except the tail)
 from left to right. If \fI-visible\fR is given, only columns whose -visible
 option is true are returned.
 .TP
-\fIpathName\fR \fBcolumn move\fR \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.
+\fIpathName\fR \fBcolumn move\fR \fIcolumnDesc\fR \fIbeforeDesc\fR
+Moves the column specified by \fIcolumnDesc\fR to the left of the column
+specified by \fIbeforeDesc\fR. Both \fIcolumnDesc\fR and \fIbeforeDesc\fR
+must be valid \fBcolumn descriptions\fR.
+If \fIbeforeDesc\fR is the string \fBtail\fR,
+the column \fIcolumnDesc\fR will become the last column.
 .TP
-\fIpathName\fR \fBcolumn neededwidth\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn neededwidth\fR \fIcolumnDesc\fR
 This command returns a decimal string giving the needed width
-of the column specified by \fIcolumn\fR.
+of the column specified by the \fBcolumn description\fR
+\fIcolumnDesc\fR.
 The needed width is the maximum of the width of the column header
-and the width of the \fIwidest\fR currently visible item.
+and the width of the widest style in any visible item.
 .TP
-\fIpathName\fR \fBcolumn order\fR \fIcolumn\fR ?\fI-visible\fR?
-This command returns a decimal string giving the position of \fIcolumn\fR
+\fIpathName\fR \fBcolumn order\fR \fIcolumnDesc\fR ?\fI-visible\fR?
+This command returns a decimal string giving the position of the column
+specified by the \fBcolumn description\fR
+\fIcolumnDesc\fR
 in the list of columns starting from zero for the leftmost column.
 If \fI-visible\fR is given, only columns whose -visible
-option is true are considered, and -1 is returned if \fIcolumn\fR's -visible
+option is true are considered, and -1 is returned if \fIcolumnDesc\fR's -visible
 option is false.
 .TP
-\fIpathName\fR \fBcolumn width\fR \fIcolumn\fR
+\fIpathName\fR \fBcolumn width\fR \fIcolumnDesc\fR
 This command returns a decimal string giving the width in pixels
-of the column specified by \fIcolumn\fR,
+of the column specified by the \fBcolumn description\fR
+\fIcolumnDesc\fR,
 even if the treectrl is configured to not display the column headers
 by means of the \fB-showheader\fR option.
 .RE
@@ -1542,14 +1555,15 @@ and b) each ancestor's \fB-visible\fR option is true
 .TP
 \fIpathName\fR \fBitem delete\fR \fIfirst\fR ?\fIlast\fR?
 Deletes the specified item(s).
-\fIFirst\fR and \fIlast\fR must be the string \fBall\fR or a valid
-\fBitem description\fR.
+\fIFirst\fR and \fIlast\fR must be valid
+\fBitem descriptions\fR.
 If either \fIfirst\fR or \fIlast\fR is specified as \fBall\fR, then all items are
 deleted. If \fIfirst\fR is specified and \fIlast\fR isn't
 specified, the item described by \fIfirst\fR is deleted.
 If both \fIfirst\fR and \fIlast\fR are specified,
 they must decribe items with a common ancestor;
 then the range of items between \fIfirst\fR and \fIlast\fR is deleted.
+The order of \fIfirst\fR and \fIlast\fR doesn't matter.
 .sp
 Deleting an item deletes any child items of the deleted item recursively.
 If the current \fBactive\fR item is deleted, the root item becomes the new active item.
author	treectrl <treectrl>	2005-09-07 20:38:04 (GMT)
committer	treectrl <treectrl>	2005-09-07 20:38:04 (GMT)
commit	ff8c0cd7c0e0954908661171d562467ed5ffcbed (patch)
tree	95c17d14db670aed3a576d1197a15475cd6985a5 /doc
parent	9332eca77a4688d640554af94b1323a72275e33d (diff)
download	tktreectrl-ff8c0cd7c0e0954908661171d562467ed5ffcbed.zip tktreectrl-ff8c0cd7c0e0954908661171d562467ed5ffcbed.tar.gz tktreectrl-ff8c0cd7c0e0954908661171d562467ed5ffcbed.tar.bz2