diff options
| author | treectrl <treectrl> | 2007-11-12 04:15:52 (GMT) |
|---|---|---|
| committer | treectrl <treectrl> | 2007-11-12 04:15:52 (GMT) |
| commit | 57144e2bfb02605656bca16e178ce18b91f97eb4 (patch) | |
| tree | 886c9cacc833d9bcc6456992280adcf8ac55db69 /doc | |
| parent | a144c6bd8081a7aea7751dbf82b56e551bfc9d0a (diff) | |
| download | tktreectrl-57144e2bfb02605656bca16e178ce18b91f97eb4.zip tktreectrl-57144e2bfb02605656bca16e178ce18b91f97eb4.tar.gz tktreectrl-57144e2bfb02605656bca16e178ce18b91f97eb4.tar.bz2 | |
Added -columntagexpr and -itemtagexpr options. [Patch 1684169]
Documented use of double-quoted tag names in tag expressions.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/treectrl.html | 37 | ||||
| -rw-r--r-- | doc/treectrl.man | 27 | ||||
| -rw-r--r-- | doc/treectrl.n | 45 |
3 files changed, 105 insertions, 4 deletions
diff --git a/doc/treectrl.html b/doc/treectrl.html index bee1e6f..bc441d5 100644 --- a/doc/treectrl.html +++ b/doc/treectrl.html @@ -1,10 +1,10 @@ -<! -- Copyright (c) 2002-2003 Christian Krone. -- -- See the file "license.terms" for information on usage and redistribution -- of this file, and for a DISCLAIMER OF ALL WARRANTIES. -- -- $Id: treectrl.html,v 1.51 2007/10/23 23:04:33 treectrl Exp $ +<! -- Copyright (c) 2002-2003 Christian Krone. -- -- See the file "license.terms" for information on usage and redistribution -- of this file, and for a DISCLAIMER OF ALL WARRANTIES. -- -- $Id: treectrl.html,v 1.52 2007/11/12 04:15:52 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.51 2007/10/23 23:04:33 treectrl Exp $ treectrl.n +<! -- CVS: $Id: treectrl.html,v 1.52 2007/11/12 04:15:52 treectrl Exp $ treectrl.n --> <body> @@ -394,6 +394,14 @@ be after resizing. For <strong>realtime</strong>, the column's size is changed w the user is dragging the right edge of the column. <br><br> +<dt>Command-Line Switch: <strong>-columntagexpr</strong><br> +Database Name: <strong>columnTagExpr</strong><br> +Database Class: <strong>ColumnTagExpr</strong><br> +<dd> +Specifies a boolean that enables or disables tag expressions in column +descriptions. See <a href="#item_and_column_tags">ITEM AND COLUMN TAGS</a>. + +<br><br> <dt>Command-Line Switch: <strong>-defaultstyle</strong><br> Database Name: <strong>defaultStyle</strong><br> Database Class: <strong>DefaultStyle</strong><br> @@ -464,6 +472,14 @@ but it is important your code doesn't assume item ids are integers if you use it. <br><br> +<dt>Command-Line Switch: <strong>-itemtagexpr</strong><br> +Database Name: <strong>itemTagExpr</strong><br> +Database Class: <strong>ItemTagExpr</strong><br> +<dd> +Specifies a boolean that enables or disables tag expressions in item +descriptions. See <a href="#item_and_column_tags">ITEM AND COLUMN TAGS</a>. + +<br><br> <dt>Command-Line Switch: <strong>-itemwidth</strong><br> Database Name: <strong>itemWidth</strong><br> Database Class: <strong>ItemWidth</strong><br> @@ -763,6 +779,23 @@ or equivalently: .t item id "tag {a ^ b}" </pre></td></tr></table></p> will return the unique ids of any items with either "a" or "b" tags, but not both. +<p> +Within a tag expression a tag name may be enclosed in double quotes to avoid special +processing of the operator characters. For example: +<p><table><tr><td bgcolor=black> </td><td><pre class='sample'> +.t item id {tag {"a&&b"||c}} +</pre></td></tr></table></p> +will return the unique ids of any items with either "a&&b" or "c" tags; in this +example the && is not treated as an operator. A double-quote may be escaped within +a quoted tag name using a backslash '\'. +<p> +Tag operators may be bypassed completely by setting the <strong>-columntagexpr</strong> and +<strong>-itemtagexpr</strong> options. This can be useful if your application has column +or item tags containing arbitrary text. +<p><table><tr><td bgcolor=black> </td><td><pre class='sample'> +.t configure -itemtagexpr false +.t item delete "tag a&&b" +</pre></td></tr></table></p> <h2><a name="widget_command">WIDGET COMMAND</a></h2> <p> diff --git a/doc/treectrl.man b/doc/treectrl.man index a1ce326..71a66b1 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.51 2007/10/23 23:04:33 treectrl Exp $} + $Id: treectrl.man,v 1.52 2007/11/12 04:15:52 treectrl Exp $} ][manpage_begin treectrl n 2.2.3] [moddesc {Tk Commands}] [titledesc {Create and manipulate hierarchical multicolumn widgets}] @@ -144,6 +144,10 @@ vertical line is drawn representing where the right edge of the column will be after resizing. For [const realtime], the column's size is changed while the user is dragging the right edge of the column. +[tkoption_def -columntagexpr columnTagExpr ColumnTagExpr] +Specifies a boolean that enables or disables tag expressions in column +descriptions. See [sectref {ITEM AND COLUMN TAGS}]. + [tkoption_def -defaultstyle defaultStyle DefaultStyle] This option is deprecated; use the column option [option -itemstyle] instead. Specifies a list of styles, one per column, to apply to each item created by @@ -190,6 +194,10 @@ of an item id is prefixed with the given string. This can aid debugging but it is important your code doesn't assume item ids are integers if you use it. +[tkoption_def -itemtagexpr itemTagExpr ItemTagExpr] +Specifies a boolean that enables or disables tag expressions in item +descriptions. See [sectref {ITEM AND COLUMN TAGS}]. + [tkoption_def -itemwidth itemWidth ItemWidth] Specifies a fixed width for every item in any of the forms acceptable to [fun Tk_GetPixels]. If more than one column is visible, then this option has no effect. @@ -393,6 +401,23 @@ or equivalently: .t item id "tag {a ^ b}" [example_end] will return the unique ids of any items with either "a" or "b" tags, but not both. +[para] +Within a tag expression a tag name may be enclosed in double quotes to avoid special +processing of the operator characters. For example: +[example_begin] +.t item id {tag {"a&&b"||c}} +[example_end] +will return the unique ids of any items with either "a&&b" or "c" tags; in this +example the && is not treated as an operator. A double-quote may be escaped within +a quoted tag name using a backslash '\'. +[para] +Tag operators may be bypassed completely by setting the [option -columntagexpr] and +[option -itemtagexpr] options. This can be useful if your application has column +or item tags containing arbitrary text. +[example_begin] +.t configure -itemtagexpr false +.t item delete "tag a&&b" +[example_end] [section {WIDGET COMMAND}] The [cmd treectrl] command creates a new Tcl command whose diff --git a/doc/treectrl.n b/doc/treectrl.n index 932421f..9724c28 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.68 2007/10/23 23:04:33 treectrl Exp $ +'\" $Id: treectrl.n,v 1.69 2007/11/12 04:15:52 treectrl Exp $ .so man.macros .TH "treectrl" n 2.2.3 treectrl "Tk Commands" .BS @@ -565,6 +565,17 @@ the user is dragging the right edge of the column. .LP .nf .ta 6c +Command-Line Switch: \fB-columntagexpr\fR +Database Name: \fBcolumnTagExpr\fR +Database Class: \fBColumnTagExpr\fR + +.fi +.IP +Specifies a boolean that enables or disables tag expressions in column +descriptions. See \fBITEM AND COLUMN TAGS\fR. +.LP +.nf +.ta 6c Command-Line Switch: \fB-defaultstyle\fR Database Name: \fBdefaultStyle\fR Database Class: \fBDefaultStyle\fR @@ -653,6 +664,17 @@ use it. .LP .nf .ta 6c +Command-Line Switch: \fB-itemtagexpr\fR +Database Name: \fBitemTagExpr\fR +Database Class: \fBItemTagExpr\fR + +.fi +.IP +Specifies a boolean that enables or disables tag expressions in item +descriptions. See \fBITEM AND COLUMN TAGS\fR. +.LP +.nf +.ta 6c Command-Line Switch: \fB-itemwidth\fR Database Name: \fBitemWidth\fR Database Class: \fBItemWidth\fR @@ -1020,6 +1042,27 @@ or equivalently: .fi will return the unique ids of any items with either "a" or "b" tags, but not both. +.PP +Within a tag expression a tag name may be enclosed in double quotes to avoid special +processing of the operator characters. For example: +.nf + +.t item id {tag {"a&&b"||c}} + +.fi +will return the unique ids of any items with either "a&&b" or "c" tags; in this +example the && is not treated as an operator. A double-quote may be escaped within +a quoted tag name using a backslash '\\'. +.PP +Tag operators may be bypassed completely by setting the \fB-columntagexpr\fR and +\fB-itemtagexpr\fR options. This can be useful if your application has column +or item tags containing arbitrary text. +.nf + +.t configure -itemtagexpr false +.t item delete "tag a&&b" + +.fi .SH "WIDGET COMMAND" The \fBtreectrl\fR command creates a new Tcl command whose name is the same as the path name of the treectrl's window. |