diff options
author | dgp <dgp@noemail.net> | 2007-10-26 20:13:21 (GMT) |
---|---|---|
committer | dgp <dgp@noemail.net> | 2007-10-26 20:13:21 (GMT) |
commit | 4064529ba9703e507a2b41d4cccbec2b661d1d48 (patch) | |
tree | 8355bd802491be2c1de242e0598914b0bb36fca5 /doc/ConfigWidg.3 | |
parent | 67ef9220fa871ce137f6e2cbb4fe3784396e1ff3 (diff) | |
download | tk-4064529ba9703e507a2b41d4cccbec2b661d1d48.zip tk-4064529ba9703e507a2b41d4cccbec2b661d1d48.tar.gz tk-4064529ba9703e507a2b41d4cccbec2b661d1d48.tar.bz2 |
* doc/*.1: Revert doc changes that broke
* doc/*.3: `make html` so we can get the release
* doc/*.n: out the door.
FossilOrigin-Name: 4fe4274467a1800529131c86ff155c4c0b03db8a
Diffstat (limited to 'doc/ConfigWidg.3')
-rw-r--r-- | doc/ConfigWidg.3 | 38 |
1 files changed, 9 insertions, 29 deletions
diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3 index bb4c6cf..102394f 100644 --- a/doc/ConfigWidg.3 +++ b/doc/ConfigWidg.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ConfigWidg.3,v 1.17 2007/10/24 14:32:56 dkf Exp $ +'\" RCS: @(#) $Id: ConfigWidg.3,v 1.18 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures" @@ -118,10 +118,7 @@ The \fItype\fR field indicates what type of configuration option this is (e.g. \fBTK_CONFIG_COLOR\fR for a color value, or \fBTK_CONFIG_INT\fR for an integer value). The \fItype\fR field indicates how to use the value of the option (more on this below). -The \fIargvName\fR field is a string such as -.QW \-font -or -.QW \-bg , +The \fIargvName\fR field is a string such as ``\-font'' or ``\-bg'', which is compared with the values in \fIargv\fR (if \fIargvName\fR is NULL it means this is a grouped entry; see GROUPED ENTRIES below). The \fIdbName\fR and \fIdbClass\fR fields are used to look up a value @@ -165,8 +162,7 @@ of each \fIspecs\fR entry indicates where in \fIwidgRec\fR to store the information about this configuration option. You should use the \fBTk_Offset\fR macro to generate \fIoffset\fR values (see below for a description of \fBTk_Offset\fR). The location indicated by -\fIwidgRec\fR and \fIoffset\fR will be referred to as the -.QW target +\fIwidgRec\fR and \fIoffset\fR will be referred to as the ``target'' in the descriptions below. .PP The \fItype\fR field of each entry in \fIspecs\fR determines what @@ -205,20 +201,10 @@ wasn't \fBNone\fR, then it is freed by passing it to \fBTk_FreeBitmap\fR. .TP \fBTK_CONFIG_BOOLEAN\fR The value must be an ASCII string specifying a boolean value. Any -of the values -.QW true , -.QW yes , -.QW on , -or -.QW 1, +of the values ``true'', ``yes'', ``on'', or ``1'', or an abbreviation of one of these values, means true; -any of the values -.QW false , -.QW no , -.QW off , -or -.QW 0 , -or an abbreviation of one of these values, means false. +any of the values ``false'', ``no'', ``off'', or ``0'', or an abbreviation of +one of these values, means false. The target is expected to be an integer; for true values it will be set to 1 and for false values it will be set to 0. .TP @@ -283,11 +269,8 @@ wasn't NULL, then it is freed by passing it to \fBTk_FreeFont\fR. .TP \fBTK_CONFIG_INT\fR The value must be an ASCII integer string -in the format accepted by \fBstrtol\fR (e.g. -.QW 0 -and -.QW 0x -prefixes may be used to specify octal or hexadecimal +in the format accepted by \fBstrtol\fR (e.g. ``0'' +and ``0x'' prefixes may be used to specify octal or hexadecimal numbers, respectively). The string is converted to an integer value and the integer is stored in the target. .TP @@ -343,10 +326,7 @@ for another entry whose \fIargvName\fR is the same as the \fIdbName\fR field in the \fBTK_CONFIG_SYNONYM\fR entry; this new entry is used just as if its \fIargvName\fR had matched the \fIargv\fR value. The synonym mechanism allows multiple \fIargv\fR values to be used for -a single configuration option, such as -.QW \-background -and -.QW \-bg . +a single configuration option, such as ``\-background'' and ``\-bg''. .TP \fBTK_CONFIG_UID\fR The value is translated to a \fBTk_Uid\fR |