Tk_GetRelief — C Library Procedures

NAME

Tk_GetRelief, Tk_NameOfRelief − translate between strings and relief values

SYNOPSIS

#include <tk.h>
int
Tk_GetRelief(interp, name, reliefPtr)
char ∗
Tk_NameOfRelief(relief)

ARGUMENTS

Tcl_Interp∗interp(in) Interpreter to use for error reporting.

char∗name(in) String containing relief name (one of “flat”, “raised”, or “sunken”).

int∗reliefPtr(out) Pointer to location in which to store relief value corresponding to name.

intrelief(in) Relief value (one of TK_RELIEF_FLAT, TK_RELIEF_RAISED, or TK_RELIEF_SUNKEN).

DESCRIPTION

Tk_GetRelief places in ∗reliefPtr the relief value corresponding to name. This value will be one of TK_RELIEF_FLAT, TK_RELIEF_RAISED, or TK_RELIEF_SUNKEN. Under normal circumstances the return value is TCL_OK and interp is unused. If name doesn’t contain one of the three valid relief names (“flat”, “raised”, or “sunken”) or an abbreviation of one of these names, then an error message is stored in interp->result, TCL_ERROR is returned, and ∗reliefPtr is unmodified.

Tk_NameOfRelief is the logical inverse of Tk_GetRelief. Given a relief value (one of TK_RELIEF_FLAT, TK_RELIEF_RAISED, or TK_RELIEF_SUNKEN) it returns the corresponding string (“flat”, “raised”, or “sunken”, respectively). If relief isn’t a legal relief value, then “unknown relief” is returned.

KEYWORDS

name, relief, string