From 3dbc48209501735842fdfc0ed683c61c675cabbf Mon Sep 17 00:00:00 2001 From: "peter.spjuth@gmail.com" Date: Thu, 21 Apr 2011 21:01:11 +0000 Subject: Document all variable options as global. --- ChangeLog | 8 ++++++++ doc/checkbutton.n | 2 +- doc/listbox.n | 2 +- doc/menu.n | 2 +- doc/options.n | 2 +- doc/radiobutton.n | 2 +- 6 files changed, 13 insertions(+), 5 deletions(-) diff --git a/ChangeLog b/ChangeLog index 3b0ab53..2729e5d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2011-04-21 Peter Spjuth + + * doc/checkbutton.n: Document all variable options as global. + * doc/radiobutton.n: + * doc/listbox.n: + * doc/menu.n: + * doc/options.n: + 2011-03-28 Jan Nijtmans * generic/tkTextBTree.c: [Bug 3129527]: Fix buffer overflow w/ GCC 4.5 and diff --git a/doc/checkbutton.n b/doc/checkbutton.n index 089c21b..86e91ff 100644 --- a/doc/checkbutton.n +++ b/doc/checkbutton.n @@ -96,7 +96,7 @@ the widget and will ignore mouse button presses. In this state the \fBdisabledForeground\fR and \fBbackground\fR options determine how the checkbutton is displayed. .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 e3dcb4f..e134414 100644 --- a/doc/listbox.n +++ b/doc/listbox.n @@ -39,7 +39,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 6d630cd..b8c0726 100644 --- a/doc/menu.n +++ b/doc/menu.n @@ -545,7 +545,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 42e54e3..c7e9ef3 100644 --- a/doc/options.n +++ b/doc/options.n @@ -285,7 +285,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 ee64e1e..d18a5c1 100644 --- a/doc/radiobutton.n +++ b/doc/radiobutton.n @@ -93,7 +93,7 @@ In this state the \fBdisabledForeground\fR and 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. -- cgit v0.12