Updated the descriptions of various style layout options.

Added the new min/max width/height style layout options. Added "-draw" option to the "window" element type.
author: treectrl <treectrl> 2005-06-13 23:30:42 (GMT)
committer: treectrl <treectrl> 2005-06-13 23:30:42 (GMT)
commit: 5f6a81b594033e8a4020976c0b87e29faf444522 (patch)
tree: e0693113e5270693624ae56bffdc0380c5943914 /doc
parent: 70237ff0e774ef87a57ff543a1bf1dd2333c41a9 (diff)
download: tktreectrl-5f6a81b594033e8a4020976c0b87e29faf444522.zip
tktreectrl-5f6a81b594033e8a4020976c0b87e29faf444522.tar.gz
tktreectrl-5f6a81b594033e8a4020976c0b87e29faf444522.tar.bz2
3 files changed, 174 insertions, 56 deletions
diff --git a/doc/treectrl.html b/doc/treectrl.html
index 6d4f2dd..360a522 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.22 2005/06/08 01:30: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.23 2005/06/13 23:30:42 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.22 2005/06/08 01:30:20 treectrl Exp $ treectrl.n
+<! -- CVS: $Id: treectrl.html,v 1.23 2005/06/13 23:30:42 treectrl Exp $ treectrl.n
    -->
 
 <body>
@@ -2236,20 +2236,36 @@ Specifies whether the element should be positioned by itself,
 i.e. independent from the other elements.
 
 <br><br>
-<dt><strong><strong>-expand</strong></strong> <i class='arg'>style</i><dd>
-<dt><strong><strong>-iexpand</strong></strong> <i class='arg'>style</i><dd>
-It can happen that the element's space is larger than its requested dimensions.
-These options may be used to position (or stretch) the slave within its cell.
-<i class='arg'>Style</i>  is a string that contains zero or more of the characters
-<strong>n</strong>, <strong>s</strong>, <strong>e</strong> or <strong>w</strong>.
-Each letter refers to a side (north, south,
-east, or west) in which direction the element will grow in.
+<dt><strong><strong>-expand</strong></strong> <i class='arg'>flags</i><dd>
+This option allows the external padding around the element
+to increase when a style has more screen space than it needs.
+<i class='arg'>Flags</i> is a string that contains zero or more of the characters
+<strong>n</strong>, <strong>s</strong>, <strong>w</strong> or <strong>e</strong>.
+Each letter refers to the padding on the top, bottom,
+left, or right that should be allowed to increase.
+This option is typically used to justify an element.
+
+<br><br>
+<dt><strong><strong>-iexpand</strong></strong> <i class='arg'>flags</i><dd>
+This option allows the internal padding of the element
+and the display area of the element to increase
+when a style has more screen space than it needs.
+<i class='arg'>Flags</i>  is a string that contains zero or more of the characters
+<strong>x</strong>, <strong>y</strong>, <strong>n</strong>, <strong>s</strong>, <strong>w</strong> or <strong>e</strong>.
+For <strong>n</strong>, <strong>s</strong>, <strong>w</strong> and <strong>e</strong>, each letter refers to the
+padding on the top, bottom, left, or right that should be allowed to increase.
+For <strong>x</strong> and <strong>y</strong>, each letter refers to the horizontal and
+vertical screen space the element can display itself in (i.e., the space
+between the padding). Note that if the
+<strong>-union</strong> option is specified for this element, then the <strong>x</strong> and
+<strong>y</strong> flags have no effect, since the size of an element with
+<strong>-union</strong> layout is determined by the elements it surrounds.
 
 <br><br>
 <dt><strong><strong>-indent</strong></strong> <i class='arg'>boolean</i><dd>
 Specifies whether the element should be positioned to the right of the
 button/line area in the tree column. This option is ignored unless the
--detach option is true.
+<strong>-detach</strong> option is true.
 
 <br><br>
 <dt><strong><strong>-ipadx</strong></strong> <i class='arg'>amount</i><dd>
@@ -2262,6 +2278,18 @@ of two values to specify padding for the two sides separately,
 it defaults to 0.
 
 <br><br>
+<dt><strong><strong>-minheight</strong></strong> <i class='arg'>pixels</i><dd>
+<dt><strong><strong>-height</strong></strong> <i class='arg'>pixels</i><dd>
+<dt><strong><strong>-maxheight</strong></strong> <i class='arg'>pixels</i><dd>
+Specifies the minimum, fixed, and maximum height of the element.
+
+<br><br>
+<dt><strong><strong>-minwidth</strong></strong> <i class='arg'>pixels</i><dd>
+<dt><strong><strong>-width</strong></strong> <i class='arg'>pixels</i><dd>
+<dt><strong><strong>-maxwidth</strong></strong> <i class='arg'>pixels</i><dd>
+Specifies the minimum, fixed, and maximum width of the element.
+
+<br><br>
 <dt><strong><strong>-padx</strong></strong> <i class='arg'>amount</i><dd>
 <dt><strong><strong>-pady</strong></strong> <i class='arg'>amount</i><dd>
 <i class='arg'>Amount</i> specifies how much external padding to
@@ -2272,18 +2300,25 @@ of two values to specify padding for the two sides separately,
 it defaults to 0.
 
 <br><br>
-<dt><strong><strong>-squeeze</strong></strong> <i class='arg'>style</i><dd>
-If an element's area is smaller than its requested dimensions, this
-option may be used to allow shrinking of the element.
-<i class='arg'>Style</i> is a string that contains zero or more of the characters
+<dt><strong><strong>-squeeze</strong></strong> <i class='arg'>flags</i><dd>
+This option allows the display area of an element to decrease when a
+style has less space than it needs.
+<i class='arg'>Flags</i> is a string that contains zero or more of the characters
 <strong>x</strong> or <strong>y</strong>.
-<strong>x</strong> shrinks the element horizontally,
-<strong>y</strong> shrinks it vertically.
+<strong>x</strong> allows display area to decrease horizontally,
+<strong>y</strong> allows display area to decrease vertically.
+This option is typically used for <strong>text</strong> elements and will cause
+the text element to display an ellipsis (...) and/or wrap lines.
 
 <br><br>
 <dt><strong><strong>-union</strong></strong> <i class='arg'>elementList</i><dd>
-Specifies a list of other <i class='arg'>element</i>s, which should be layed out
-inside the space of this element.
+Specifies a list of other elements which this element will surround.
+The size of an element with <strong>-union</strong> layout is determined by the
+size and position of the elements in <i class='arg'>elementList</i>.
+The <strong>-ipadx</strong> and <strong>-ipady</strong> options in this case refer to the
+distance of the edges of the display area of this element from those elements
+it surrounds. This option is typically used to display a selection rectangle
+around a piece of text.
 
 </dl>
 
@@ -3070,6 +3105,12 @@ element is deleted, when the column containing the element is deleted,
 or when the style associated with the item's column is changed.
 
 <br><br>
+<dt><strong><strong>-draw</strong></strong> <i class='arg'>boolean</i><dd>
+Specifies as a per-state option
+whether to draw the element. If the value is unspecified (the default),
+the element will be drawn.
+
+<br><br>
 <dt><strong><strong>-window</strong></strong> <i class='arg'>pathName</i><dd>
 Specifies the window to associate with this element. The window specified by
 <i class='arg'>pathName</i> must either be a child of the treectrl widget or a child of
diff --git a/doc/treectrl.man b/doc/treectrl.man
index 3535080..23d2175 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.23 2005/06/08 01:30:20 treectrl Exp $}
+  $Id: treectrl.man,v 1.24 2005/06/13 23:30:42 treectrl Exp $}
 ][manpage_begin treectrl n 2.0]
 [moddesc {Tk Commands}]
 [titledesc {Create and manipulate hierarchical multicolumn widgets}]
@@ -1696,19 +1696,34 @@ The following options are supported:
 Specifies whether the element should be positioned by itself,
 i.e. independent from the other elements.
 
-[opt_def [option -expand] [arg style]]
-[opt_def [option -iexpand] [arg style]]
-It can happen that the element's space is larger than its requested dimensions.
-These options may be used to position (or stretch) the slave within its cell.
-[arg Style]  is a string that contains zero or more of the characters
-[const n], [const s], [const e] or [const w].
-Each letter refers to a side (north, south,
-east, or west) in which direction the element will grow in.
+[opt_def [option -expand] [arg flags]]
+This option allows the external padding around the element
+to increase when a style has more screen space than it needs.
+[arg Flags] is a string that contains zero or more of the characters
+[const n], [const s], [const w] or [const e].
+Each letter refers to the padding on the top, bottom,
+left, or right that should be allowed to increase.
+This option is typically used to justify an element.
+
+[opt_def [option -iexpand] [arg flags]]
+This option allows the internal padding of the element
+and the display area of the element to increase
+when a style has more screen space than it needs.
+[arg Flags]  is a string that contains zero or more of the characters
+[const x], [const y], [const n], [const s], [const w] or [const e].
+For [const n], [const s], [const w] and [const e], each letter refers to the
+padding on the top, bottom, left, or right that should be allowed to increase.
+For [const x] and [const y], each letter refers to the horizontal and
+vertical screen space the element can display itself in (i.e., the space
+between the padding). Note that if the
+[option -union] option is specified for this element, then the [const x] and
+[const y] flags have no effect, since the size of an element with
+[option -union] layout is determined by the elements it surrounds.
 
 [opt_def [option -indent] [arg boolean]]
 Specifies whether the element should be positioned to the right of the
 button/line area in the tree column. This option is ignored unless the
--detach option is true.
+[option -detach] option is true.
 
 [opt_def [option -ipadx] [arg amount]]
 [opt_def [option -ipady] [arg amount]]
@@ -1719,6 +1734,16 @@ or top and bottom (for [option -ipady]) side of the element.
 of two values to specify padding for the two sides separately,
 it defaults to 0.
 
+[opt_def [option -minheight] [arg pixels]]
+[opt_def [option -height] [arg pixels]]
+[opt_def [option -maxheight] [arg pixels]]
+Specifies the minimum, fixed, and maximum height of the element.
+
+[opt_def [option -minwidth] [arg pixels]]
+[opt_def [option -width] [arg pixels]]
+[opt_def [option -maxwidth] [arg pixels]]
+Specifies the minimum, fixed, and maximum width of the element.
+
 [opt_def [option -padx] [arg amount]]
 [opt_def [option -pady] [arg amount]]
 [arg Amount] specifies how much external padding to
@@ -1728,17 +1753,24 @@ or top and bottom (for [option -pady]) side of the element.
 of two values to specify padding for the two sides separately,
 it defaults to 0.
 
-[opt_def [option -squeeze] [arg style]]
-If an element's area is smaller than its requested dimensions, this
-option may be used to allow shrinking of the element.
-[arg Style] is a string that contains zero or more of the characters
+[opt_def [option -squeeze] [arg flags]]
+This option allows the display area of an element to decrease when a
+style has less space than it needs.
+[arg Flags] is a string that contains zero or more of the characters
 [const x] or [const y].
-[const x] shrinks the element horizontally,
-[const y] shrinks it vertically.
+[const x] allows display area to decrease horizontally,
+[const y] allows display area to decrease vertically.
+This option is typically used for [const text] elements and will cause
+the text element to display an ellipsis (...) and/or wrap lines.
 
 [opt_def [option -union] [arg elementList]]
-Specifies a list of other [arg element]s, which should be layed out
-inside the space of this element.
+Specifies a list of other elements which this element will surround.
+The size of an element with [option -union] layout is determined by the
+size and position of the elements in [arg elementList].
+The [option -ipadx] and [option -ipady] options in this case refer to the
+distance of the edges of the display area of this element from those elements
+it surrounds. This option is typically used to display a selection rectangle
+around a piece of text.
 
 [list_end]
 
@@ -2423,6 +2455,11 @@ element is deleted. The element is deleted when the item containing the
 element is deleted, when the column containing the element is deleted,
 or when the style associated with the item's column is changed.
 
+[opt_def [option -draw] [arg boolean]]
+Specifies as a per-state option
+whether to draw the element. If the value is unspecified (the default),
+the element will be drawn.
+
 [opt_def [option -window] [arg pathName]]
 Specifies the window to associate with this element. The window specified by
 [arg pathName] must either be a child of the treectrl widget or a child of
diff --git a/doc/treectrl.n b/doc/treectrl.n
index 6d91e50..a169823 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.39 2005/06/08 01:30:20 treectrl Exp $
+'\"   $Id: treectrl.n,v 1.40 2005/06/13 23:30:42 treectrl Exp $
 .so man.macros
 .TH "treectrl" n 2.0  "Tk Commands"
 .BS
@@ -2140,20 +2140,34 @@ The following options are supported:
 Specifies whether the element should be positioned by itself,
 i.e. independent from the other elements.
 .TP
-\fB\fB-expand\fR\fR \fIstyle\fR
-.TP
-\fB\fB-iexpand\fR\fR \fIstyle\fR
-It can happen that the element's space is larger than its requested dimensions.
-These options may be used to position (or stretch) the slave within its cell.
-\fIStyle\fR  is a string that contains zero or more of the characters
-\fBn\fR, \fBs\fR, \fBe\fR or \fBw\fR.
-Each letter refers to a side (north, south,
-east, or west) in which direction the element will grow in.
+\fB\fB-expand\fR\fR \fIflags\fR
+This option allows the external padding around the element
+to increase when a style has more screen space than it needs.
+\fIFlags\fR is a string that contains zero or more of the characters
+\fBn\fR, \fBs\fR, \fBw\fR or \fBe\fR.
+Each letter refers to the padding on the top, bottom,
+left, or right that should be allowed to increase.
+This option is typically used to justify an element.
+.TP
+\fB\fB-iexpand\fR\fR \fIflags\fR
+This option allows the internal padding of the element
+and the display area of the element to increase
+when a style has more screen space than it needs.
+\fIFlags\fR  is a string that contains zero or more of the characters
+\fBx\fR, \fBy\fR, \fBn\fR, \fBs\fR, \fBw\fR or \fBe\fR.
+For \fBn\fR, \fBs\fR, \fBw\fR and \fBe\fR, each letter refers to the
+padding on the top, bottom, left, or right that should be allowed to increase.
+For \fBx\fR and \fBy\fR, each letter refers to the horizontal and
+vertical screen space the element can display itself in (i.e., the space
+between the padding). Note that if the
+\fB-union\fR option is specified for this element, then the \fBx\fR and
+\fBy\fR flags have no effect, since the size of an element with
+\fB-union\fR layout is determined by the elements it surrounds.
 .TP
 \fB\fB-indent\fR\fR \fIboolean\fR
 Specifies whether the element should be positioned to the right of the
 button/line area in the tree column. This option is ignored unless the
--detach option is true.
+\fB-detach\fR option is true.
 .TP
 \fB\fB-ipadx\fR\fR \fIamount\fR
 .TP
@@ -2165,6 +2179,20 @@ or top and bottom (for \fB-ipady\fR) side of the element.
 of two values to specify padding for the two sides separately,
 it defaults to 0.
 .TP
+\fB\fB-minheight\fR\fR \fIpixels\fR
+.TP
+\fB\fB-height\fR\fR \fIpixels\fR
+.TP
+\fB\fB-maxheight\fR\fR \fIpixels\fR
+Specifies the minimum, fixed, and maximum height of the element.
+.TP
+\fB\fB-minwidth\fR\fR \fIpixels\fR
+.TP
+\fB\fB-width\fR\fR \fIpixels\fR
+.TP
+\fB\fB-maxwidth\fR\fR \fIpixels\fR
+Specifies the minimum, fixed, and maximum width of the element.
+.TP
 \fB\fB-padx\fR\fR \fIamount\fR
 .TP
 \fB\fB-pady\fR\fR \fIamount\fR
@@ -2175,17 +2203,24 @@ or top and bottom (for \fB-pady\fR) side of the element.
 of two values to specify padding for the two sides separately,
 it defaults to 0.
 .TP
-\fB\fB-squeeze\fR\fR \fIstyle\fR
-If an element's area is smaller than its requested dimensions, this
-option may be used to allow shrinking of the element.
-\fIStyle\fR is a string that contains zero or more of the characters
+\fB\fB-squeeze\fR\fR \fIflags\fR
+This option allows the display area of an element to decrease when a
+style has less space than it needs.
+\fIFlags\fR is a string that contains zero or more of the characters
 \fBx\fR or \fBy\fR.
-\fBx\fR shrinks the element horizontally,
-\fBy\fR shrinks it vertically.
+\fBx\fR allows display area to decrease horizontally,
+\fBy\fR allows display area to decrease vertically.
+This option is typically used for \fBtext\fR elements and will cause
+the text element to display an ellipsis (...) and/or wrap lines.
 .TP
 \fB\fB-union\fR\fR \fIelementList\fR
-Specifies a list of other \fIelement\fRs, which should be layed out
-inside the space of this element.
+Specifies a list of other elements which this element will surround.
+The size of an element with \fB-union\fR layout is determined by the
+size and position of the elements in \fIelementList\fR.
+The \fB-ipadx\fR and \fB-ipady\fR options in this case refer to the
+distance of the edges of the display area of this element from those elements
+it surrounds. This option is typically used to display a selection rectangle
+around a piece of text.
 .RE
 .TP
 \fIpathName\fR \fBstyle names\fR\fR
@@ -2825,6 +2860,11 @@ element is deleted. The element is deleted when the item containing the
 element is deleted, when the column containing the element is deleted,
 or when the style associated with the item's column is changed.
 .TP
+\fB\fB-draw\fR\fR \fIboolean\fR
+Specifies as a per-state option
+whether to draw the element. If the value is unspecified (the default),
+the element will be drawn.
+.TP
 \fB\fB-window\fR\fR \fIpathName\fR
 Specifies the window to associate with this element. The window specified by
 \fIpathName\fR must either be a child of the treectrl widget or a child of
author	treectrl <treectrl>	2005-06-13 23:30:42 (GMT)
committer	treectrl <treectrl>	2005-06-13 23:30:42 (GMT)
commit	5f6a81b594033e8a4020976c0b87e29faf444522 (patch)
tree	e0693113e5270693624ae56bffdc0380c5943914 /doc
parent	70237ff0e774ef87a57ff543a1bf1dd2333c41a9 (diff)
download	tktreectrl-5f6a81b594033e8a4020976c0b87e29faf444522.zip tktreectrl-5f6a81b594033e8a4020976c0b87e29faf444522.tar.gz tktreectrl-5f6a81b594033e8a4020976c0b87e29faf444522.tar.bz2