About Us Documentation

Contact Site Map
 

  

WinPak
Documentation

Tk_GetRelief





Tk_GetRelief(3)       Tk 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'', ``groove'', ``raised'', ``ridge'', ``solid'', or ``sunken''). int *reliefPtr (out) Pointer to location in which to store relief value corresponding to name. 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). _________________________________________________________________

DESCRIPTION

Tk_GetRelief places in *reliefPtr the relief value corresponding to name. 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 interp is unused. If name doesn't contain one of the valid relief names or an abbreviation of one of them, then an error message is stored in interp->result, TCL_ERROR is returned, and *reliefPtr is unmodified. Tk 1 Tk_GetRelief(3) Tk Library Procedures Tk_NameOfRelief is the logical inverse of Tk_GetRelief. Given a relief value it returns the corresponding string (``flat'', ``raised'', ``sunken'', ``groove'', ``solid'', or ``ridge''). If relief isn't a legal relief value, then ``unknown relief'' is returned.

KEYWORDS

name, relief, string Tk 2 Prepared by Ready-to-Run Software, Inc.

 

Email addresses listed on this site may  NOT be used for unsolicited commercial email.

Ready-to-Run Software, Inc Privacy Statement

Portions (c)Copyright, 1996-2005 by Ready-to-Run Software, Inc
(All rights reserved.)
212 Cedar Cove
Lansing, NY 14882
Phone: 607 533 UNIX (8649)
Fax: 607 533 4002


To return to the Ready-to-Run Software WinPak Table of contents please presshere