summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpspjuth <pspjuth@noemail.net>2011-04-21 21:18:33 (GMT)
committerpspjuth <pspjuth@noemail.net>2011-04-21 21:18:33 (GMT)
commit5c1865fd4d04b9e1f658684f3f1e8ef1fa1de3ef (patch)
treeadc56cc5a2c5a2adaf468bceb6760ab706e0b6be
parenteab4dc20e8dfcb9f64fe6c795b7214812b950f1d (diff)
parenteb253e8c012e7ee690be9b4d4771f3c5de5e31c0 (diff)
downloadtk-5c1865fd4d04b9e1f658684f3f1e8ef1fa1de3ef.zip
tk-5c1865fd4d04b9e1f658684f3f1e8ef1fa1de3ef.tar.gz
tk-5c1865fd4d04b9e1f658684f3f1e8ef1fa1de3ef.tar.bz2
Document all variable options as global.
FossilOrigin-Name: 826dd8fde70e2aed15224dc812da23eb4be86877
-rw-r--r--ChangeLog12
-rw-r--r--doc/checkbutton.n2
-rw-r--r--doc/listbox.n2
-rw-r--r--doc/menu.n2
-rw-r--r--doc/options.n2
-rw-r--r--doc/radiobutton.n2
-rw-r--r--doc/ttk_combobox.n2
-rw-r--r--doc/ttk_entry.n2
-rw-r--r--doc/ttk_progressbar.n2
-rw-r--r--doc/ttk_widget.n2
10 files changed, 21 insertions, 9 deletions
diff --git a/ChangeLog b/ChangeLog
index d7b9eb8..7c17319 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2011-04-21 Peter Spjuth <peter.spjuth@gmail.com>
+
+ * doc/checkbutton.n: Document all variable options as global.
+ * doc/radiobutton.n:
+ * doc/listbox.n:
+ * doc/menu.n:
+ * doc/options.n:
+ * doc/ttk_combobox.n:
+ * doc/ttk_entry.n:
+ * doc/ttk_progressbar.n:
+ * doc/ttk_widget.n:
+
2011-04-04 Peter Spjuth <peter.spjuth@gmail.com>
* tests/grid.test:
diff --git a/doc/checkbutton.n b/doc/checkbutton.n
index d204336..d51c32d 100644
--- a/doc/checkbutton.n
+++ b/doc/checkbutton.n
@@ -110,7 +110,7 @@ selection, also known as the tri-state mode. Defaults to
.QW "" .
.VE 8.5
.OP \-variable variable Variable
-Specifies name of global variable to set to indicate whether
+Specifies the name of a global variable to set to indicate whether
or not this button is selected. Defaults to the name of the
button within its parent (i.e. the last element of the button
window's path name).
diff --git a/doc/listbox.n b/doc/listbox.n
index e818f3c..55c06ac 100644
--- a/doc/listbox.n
+++ b/doc/listbox.n
@@ -35,7 +35,7 @@ Specifies the desired height for the window, in lines.
If zero or less, then the desired height for the window is made just
large enough to hold all the elements in the listbox.
.OP \-listvariable listVariable Variable
-Specifies the name of a variable. The value of the variable is a list to
+Specifies the name of a global variable. The value of the variable is a list to
be displayed inside the widget; if the variable value changes then the
widget will automatically update itself to reflect the new value. Attempts
to assign a variable with an invalid list value to \fB\-listvariable\fR
diff --git a/doc/menu.n b/doc/menu.n
index 32d2d54..9584937 100644
--- a/doc/menu.n
+++ b/doc/menu.n
@@ -512,7 +512,7 @@ for the entry as the value to store in the variable.
.TP
\fB\-variable \fIvalue\fR
Available only for checkbutton and radiobutton entries. Specifies
-the name of a global value to set when the entry is selected.
+the name of a global variable to set when the entry is selected.
For checkbutton entries the variable is also set when the entry
is deselected. For radiobutton entries, changing the variable
causes the currently-selected entry to deselect itself.
diff --git a/doc/options.n b/doc/options.n
index 60a6e40..d8d3439 100644
--- a/doc/options.n
+++ b/doc/options.n
@@ -293,7 +293,7 @@ Specifies a string to be displayed inside the widget. The way in which
the string is displayed depends on the particular widget and may be
determined by other options, such as \fBanchor\fR or \fBjustify\fR.
.OP \-textvariable textVariable Variable
-Specifies the name of a variable. The value of the variable is a text
+Specifies the name of a global variable. The value of the variable is a text
string to be displayed inside the widget; if the variable value changes
then the widget will automatically update itself to reflect the new value.
The way in which the string is displayed in the widget depends on the
diff --git a/doc/radiobutton.n b/doc/radiobutton.n
index cf06f57..12ff87c 100644
--- a/doc/radiobutton.n
+++ b/doc/radiobutton.n
@@ -106,7 +106,7 @@ selection, also known as the tri-state mode. Defaults to
Specifies value to store in the button's associated variable whenever
this button is selected.
.OP \-variable variable Variable
-Specifies name of global variable to set whenever this button is
+Specifies the name of a global variable to set whenever this button is
selected. Changes in this variable also cause the button to select
or deselect itself.
Defaults to the value \fBselectedButton\fR.
diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n
index d8603e1..6083fab 100644
--- a/doc/ttk_combobox.n
+++ b/doc/ttk_combobox.n
@@ -46,7 +46,7 @@ In the \fBnormal\fR state,
the text field is directly editable.
In the \fBdisabled\fR state, no interaction is possible.
.OP \-textvariable textVariable TextVariable
-Specifies the name of a variable whose value is linked
+Specifies the name of a global variable whose value is linked
to the widget value.
Whenever the variable changes value the widget value is updated,
and vice versa.
diff --git a/doc/ttk_entry.n b/doc/ttk_entry.n
index 6184fa6..eb2a5a8 100644
--- a/doc/ttk_entry.n
+++ b/doc/ttk_entry.n
@@ -68,7 +68,7 @@ Specifies one of three states for the entry,
\fBnormal\fR, \fBdisabled\fR, or \fBreadonly\fR.
See \fBWIDGET STATES\fR, below.
.OP \-textvariable textVariable Variable
-Specifies the name of a variable whose value is linked
+Specifies the name of a global variable whose value is linked
to the entry widget's contents.
Whenever the variable changes value, the widget's contents are updated,
and vice versa.
diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n
index af3e312..2afc951 100644
--- a/doc/ttk_progressbar.n
+++ b/doc/ttk_progressbar.n
@@ -45,7 +45,7 @@ that is, the progress bar completes one
.QW cycle
when the \fB\-value\fR increases by \fB\-maximum\fR.
.OP \-variable variable Variable
-The name of a Tcl variable which is linked to the \fB\-value\fR.
+The name of a global Tcl variable which is linked to the \fB\-value\fR.
If specified, the \fB\-value\fR of the progress bar is
automatically set to the value of the variable whenever
the latter is modified.
diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n
index 7c0ba88..b559de4 100644
--- a/doc/ttk_widget.n
+++ b/doc/ttk_widget.n
@@ -77,7 +77,7 @@ and other button-like widgets:
Specifies a text string to be displayed inside the widget
(unless overridden by \fB\-textvariable\fR).
.OP \-textvariable textVariable Variable
-Specifies the name of variable whose value will be used
+Specifies the name of a global variable whose value will be used
in place of the \fB\-text\fR resource.
.OP \-underline underline Underline
If set, specifies the integer index (0-based) of a character to underline