summaryrefslogtreecommitdiffstats
path: root/doc/SetOptions.3
diff options
context:
space:
mode:
authorericm <ericm>2000-08-10 00:21:05 (GMT)
committerericm <ericm>2000-08-10 00:21:05 (GMT)
commitd1c711f1d22a1524af5994cfa3f8888e5bc4dc9e (patch)
tree3acd79b0de2739be7bffae01ae70436c029d98a9 /doc/SetOptions.3
parent33dfdb962c35a1f9a9c1b61e10ab8bd93b1704b6 (diff)
downloadtk-d1c711f1d22a1524af5994cfa3f8888e5bc4dc9e.zip
tk-d1c711f1d22a1524af5994cfa3f8888e5bc4dc9e.tar.gz
tk-d1c711f1d22a1524af5994cfa3f8888e5bc4dc9e.tar.bz2
* doc/SetOptions.3: Updated documentation to reflect support for
TK_OPTION_NULL_OK for TK_OPTION_DOUBLE and TK_OPTION_PIXELS. * generic/tkConfig.c: Added for TK_OPTION_NULL_OK support for TK_OPTION_DOUBLE and TK_OPTION_PIXELS. * doc/place.n: Updated, reformatted manual entry. * tests/place.test: Added many tests. * generic/tkPlace.c (Tk_PlaceObjCmd): Updated to use Tk widget-option management facilities to manage place options (-x, -y, etc.), which simplifies the placer code. Added support for [place configure pathName] and [place configure pathName -option], similar to the behavior of the configure subcommand supported by widgets.
Diffstat (limited to 'doc/SetOptions.3')
-rw-r--r--doc/SetOptions.313
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/SetOptions.3 b/doc/SetOptions.3
index 8393085..29f6e72 100644
--- a/doc/SetOptions.3
+++ b/doc/SetOptions.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: SetOptions.3,v 1.3 2000/05/17 21:17:19 ericm Exp $
+'\" RCS: @(#) $Id: SetOptions.3,v 1.4 2000/08/10 00:21:06 ericm Exp $
'\"
.so man.macros
.TH Tk_SetOptions 3 8.1 Tk "Tk Library Procedures"
@@ -311,8 +311,8 @@ The \fIflags\fR field consists of one or more bits ORed together. At
present only a single flag is supported: TK_OPTION_NULL_OK. If
this bit is set for an option then an empty string will be accepted as
the value for the option and the resulting internal form will be a
-NULL pointer or \fBNone\fR, depending on the type of the option.
-If the flag is not set then empty strings will result
+NULL pointer, a zero value, or \fBNone\fR, depending on the type of
+the option. If the flag is not set then empty strings will result
in errors.
TK_OPTION_NULL_OK is typically used to allow a
feature to be turned off entirely, e.g. set a cursor value to
@@ -371,7 +371,8 @@ option type also supports the TK_OPTION_NULL_OK flag.
\fBTK_OPTION_DOUBLE\fR
The string value must be a floating-point number in
the format accepted by \fBstrtol\fR. The internal form is a C
-\fBdouble\fR value.
+\fBdouble\fR value. This option type supports the TK_OPTION_NULL_OK
+flag; if a NULL value is set, the internal representation is set to zero.
.TP
\fBTK_OPTION_END\fR
Marks the end of the template. There must be a Tk_OptionSpec structure
@@ -406,7 +407,9 @@ The internal form is an integer value giving a
distance in pixels, like the values returned by
\fBTk_GetPixelsFromObj\fR. Note: if the \fIobjOffset\fR field isn't
used then information about the original value of this option will be lost.
-See \fBOBJOFFSET VS. INTERNALOFFSET\fR below for details.
+See \fBOBJOFFSET VS. INTERNALOFFSET\fR below for details. This option
+type supports the TK_OPTION_NULL_OK flag; if a NULL value is set, the
+internal representation is set to zero.
.TP
\fBTK_OPTION_RELIEF\fR
The value must be standard relief such as \fBraised\fR.