OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [tk/] [doc/] [GetRelief.3] - Blame information for rev 1765

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
'\"
2
'\" Copyright (c) 1990 The Regents of the University of California.
3
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
4
'\"
5
'\" See the file "license.terms" for information on usage and redistribution
6
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7
'\"
8
'\" RCS: @(#) $Id: GetRelief.3,v 1.1.1.1 2002-01-16 10:25:48 markom Exp $
9
'\"
10
.so man.macros
11
.TH Tk_GetRelief 3 "" Tk "Tk Library Procedures"
12
.BS
13
.SH NAME
14
Tk_GetRelief, Tk_NameOfRelief \- translate between strings and relief values
15
.SH SYNOPSIS
16
.nf
17
\fB#include \fR
18
.sp
19
int
20
\fBTk_GetRelief(\fIinterp, name, reliefPtr\fB)\fR
21
.sp
22
char *
23
\fBTk_NameOfRelief(\fIrelief\fB)\fR
24
.SH ARGUMENTS
25
.AS "Tcl_Interp" *reliefPtr
26
.AP Tcl_Interp *interp in
27
Interpreter to use for error reporting.
28
.AP char *name in
29
String containing relief name (one of ``flat'', ``groove'',
30
``raised'', ``ridge'', ``solid'', or ``sunken'').
31
.AP int *reliefPtr out
32
Pointer to location in which to store relief value corresponding to
33
\fIname\fR.
34
.AP int relief in
35
Relief value (one of TK_RELIEF_FLAT, TK_RELIEF_RAISED, TK_RELIEF_SUNKEN,
36
TK_RELIEF_GROOVE, TK_RELIEF_SOLID, or TK_RELIEF_RIDGE).
37
.BE
38
 
39
.SH DESCRIPTION
40
.PP
41
\fBTk_GetRelief\fR places in \fI*reliefPtr\fR the relief value
42
corresponding to \fIname\fR.  This value will be one of
43
TK_RELIEF_FLAT, TK_RELIEF_RAISED, TK_RELIEF_SUNKEN,
44
TK_RELIEF_GROOVE, TK_RELIEF_SOLID, or TK_RELIEF_RIDGE.
45
Under normal circumstances the return value is TCL_OK and
46
\fIinterp\fR is unused.
47
If \fIname\fR doesn't contain one of the valid relief names
48
or an abbreviation of one of them, then an error message
49
is stored in \fIinterp->result\fR,
50
TCL_ERROR is returned, and \fI*reliefPtr\fR is unmodified.
51
.PP
52
\fBTk_NameOfRelief\fR is the logical inverse of \fBTk_GetRelief\fR.
53
Given a relief value it returns the corresponding string (``flat'',
54
``raised'', ``sunken'', ``groove'', ``solid'', or ``ridge'').
55
If \fIrelief\fR isn't a legal relief value, then ``unknown relief''
56
is returned.
57
 
58
.SH KEYWORDS
59
name, relief, string

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.