summaryrefslogtreecommitdiffstats
path: root/doc/GetRelief.3
diff options
context:
space:
mode:
authordonal.k.fellows@manchester.ac.uk <dkf>2007-10-29 16:04:11 (GMT)
committerdonal.k.fellows@manchester.ac.uk <dkf>2007-10-29 16:04:11 (GMT)
commit4a790ebd42e3ba4a893b31d0491ac478c4abb3dd (patch)
treef1b13d0b63bdcb785dc2718534eb209b9796d50b /doc/GetRelief.3
parentef2f8a1261ee6fcabf5a88b9b099a93fb7eaeed6 (diff)
downloadtk-4a790ebd42e3ba4a893b31d0491ac478c4abb3dd.zip
tk-4a790ebd42e3ba4a893b31d0491ac478c4abb3dd.tar.gz
tk-4a790ebd42e3ba4a893b31d0491ac478c4abb3dd.tar.bz2
Lots more GOOBE stuff. Now works with 'make html'!
Diffstat (limited to 'doc/GetRelief.3')
-rw-r--r--doc/GetRelief.323
1 files changed, 14 insertions, 9 deletions
diff --git a/doc/GetRelief.3 b/doc/GetRelief.3
index 8531393..074e526 100644
--- a/doc/GetRelief.3
+++ b/doc/GetRelief.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: GetRelief.3,v 1.9 2007/10/26 20:13:22 dgp Exp $
+'\" RCS: @(#) $Id: GetRelief.3,v 1.10 2007/10/29 16:04:12 dkf Exp $
'\"
.so man.macros
.TH Tk_GetReliefFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -29,9 +29,15 @@ const char *
.AP Tcl_Interp *interp in
Interpreter to use for error reporting.
.AP Tcl_Obj *objPtr in/out
-String value contains name of relief (one of \fBflat\fR, \fBgroove\fR,
-\fBraised\fR, \fBridge\fR, \fBsolid\fR, or \fBsunken\fR);
-internal rep will be modified to cache corresponding relief value.
+String value contains name of relief, one of
+.QW flat ,
+.QW groove ,
+.QW raised ,
+.QW ridge ,
+.QW solid ,
+or
+.QW sunken ;
+the internal rep will be modified to cache corresponding relief value.
.AP char *string in
Same as \fIobjPtr\fR except description of relief is passed as
a string.
@@ -45,7 +51,6 @@ Relief value (one of \fBTK_RELIEF_FLAT\fR, \fBTK_RELIEF_RAISED\fR,
\fBTK_RELIEF_SUNKEN\fR, \fBTK_RELIEF_GROOVE\fR, \fBTK_RELIEF_SOLID\fR,
or \fBTK_RELIEF_RIDGE\fR).
.BE
-
.SH DESCRIPTION
.PP
\fBTk_GetReliefFromObj\fR places in \fI*reliefPtr\fR the relief value
@@ -54,10 +59,10 @@ corresponding to the value of \fIobjPtr\fR. This value will be one of
\fBTK_RELIEF_GROOVE\fR, \fBTK_RELIEF_SOLID\fR, or \fBTK_RELIEF_RIDGE\fR.
Under normal circumstances the return value is \fBTCL_OK\fR and
\fIinterp\fR is unused.
-If \fIobjPtr\fR doesn't contain one of the valid relief names
+If \fIobjPtr\fR does not contain one of the valid relief names
or an abbreviation of one of them, then \fBTCL_ERROR\fR is returned,
\fI*reliefPtr\fR is unmodified, and an error message
-is stored in \fIinterp\fR's result if \fIinterp\fR isn't NULL.
+is stored in \fIinterp\fR's result if \fIinterp\fR is not NULL.
\fBTk_GetReliefFromObj\fR caches information about the return
value in \fIobjPtr\fR, which speeds up future calls to
\fBTk_GetReliefFromObj\fR with the same \fIobjPtr\fR.
@@ -71,8 +76,8 @@ return value, so \fBTk_GetRelief\fR is less efficient than
\fBTk_NameOfRelief\fR is the logical inverse of \fBTk_GetRelief\fR.
Given a relief value it returns the corresponding string (\fBflat\fR,
\fBraised\fR, \fBsunken\fR, \fBgroove\fR, \fBsolid\fR, or \fBridge\fR).
-If \fIrelief\fR isn't a legal relief value, then ``unknown relief''
+If \fIrelief\fR is not a legal relief value, then
+.QW "unknown relief"
is returned.
-
.SH KEYWORDS
name, relief, string