summaryrefslogtreecommitdiffstats
path: root/doc/GetRelief.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-09-19 16:05:34 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-09-19 16:05:34 (GMT)
commit9d13fb1cb472be80ac1cea698fcc91be991b0ac4 (patch)
tree83898b60ed6e9f9dd9a2b525a9ad32172a88d4fc /doc/GetRelief.3
parent50324a159a264c9d34c81d447b4926ea75e2cb45 (diff)
downloadtk-9d13fb1cb472be80ac1cea698fcc91be991b0ac4.zip
tk-9d13fb1cb472be80ac1cea698fcc91be991b0ac4.tar.gz
tk-9d13fb1cb472be80ac1cea698fcc91be991b0ac4.tar.bz2
Standardize style of section refs & public symbols. Remove displayed tabs
Diffstat (limited to 'doc/GetRelief.3')
-rw-r--r--doc/GetRelief.315
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/GetRelief.3 b/doc/GetRelief.3
index f75bdaa..0b7b2cb 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.4 2002/08/05 04:30:38 dgp Exp $
+'\" RCS: @(#) $Id: GetRelief.3,v 1.5 2004/09/19 16:05:36 dkf Exp $
'\"
.so man.macros
.TH Tk_GetReliefFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -45,8 +45,9 @@ Pointer to location in which to store relief value corresponding to
.AP "CONST char" *name
Name of the relief.
.AP int relief in
-Relief value (one of TK_RELIEF_FLAT, TK_RELIEF_RAISED, TK_RELIEF_SUNKEN,
-TK_RELIEF_GROOVE, TK_RELIEF_SOLID, or TK_RELIEF_RIDGE).
+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
@@ -54,12 +55,12 @@ TK_RELIEF_GROOVE, TK_RELIEF_SOLID, or TK_RELIEF_RIDGE).
.VS 8.1
\fBTk_GetReliefFromObj\fR places in \fI*reliefPtr\fR the relief value
corresponding to the value of \fIobjPtr\fR. This value will be one of
-TK_RELIEF_FLAT, TK_RELIEF_RAISED, TK_RELIEF_SUNKEN,
-TK_RELIEF_GROOVE, TK_RELIEF_SOLID, or TK_RELIEF_RIDGE.
-Under normal circumstances the return value is TCL_OK and
+\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.
+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
-or an abbreviation of one of them, then TCL_ERROR is returned,
+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.
\fBTk_GetReliefFromObj\fR caches information about the return