Copyright (C) 2000-2012 |
Manpages Tk_GetReliefFromObjSection: Tk Library Procedures (3)Updated: 8.1 Index Return to Main Contents NAMETk_GetReliefFromObj, Tk_GetRelief, Tk_NameOfRelief - translate between strings and relief valuesSYNOPSIS#include <tk.h> int Tk_GetReliefFromObj(interp, objPtr, reliefPtr) int Tk_GetRelief(interp, name, reliefPtr) char * Tk_NameOfRelief(relief) ARGUMENTS
DESCRIPTIONTk_GetReliefFromObj places in *reliefPtr the relief value corresponding to the value of objPtr. 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 objPtr doesn't contain one of the valid relief names or an abbreviation of one of them, then TCL_ERROR is returned, *reliefPtr is unmodified, and an error message is stored in interp's result if interp isn't NULL. Tk_GetReliefFromObj caches information about the return value in objPtr, which speeds up future calls to Tk_GetReliefFromObj with the same objPtr. Tk_GetRelief is identical to Tk_GetReliefFromObj except that the description of the relief is specified with a string instead of an object. This prevents Tk_GetRelief from caching the return value, so Tk_GetRelief is less efficient than Tk_GetReliefFromObj. 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. KEYWORDSname, relief, string
IndexThis document was created by man2html, using the manual pages. Time: 10:33:51 GMT, March 29, 2024 |