TkGetReliefFromObj(3) Tk Library Procedures TkGetReliefFromObj(3)

NAME
       TkGetReliefFromObj,  TkGetRelief, TkNameOfRelief - translate between
       strings and relief values

SYNOPSIS
       ##iinncclluuddee <>

       int                                                                     |
       TTkkGGeettRReelliieeffFFrroommOObbjj((interp, objPtr, reliefPtr))                          |

       int
       TTkkGGeettRReelliieeff((interp, name, reliefPtr))

       CONST char *
       TTkkNNaammeeOOffRReelliieeff((relief))

AARRGGUUMMEENNTTSS
       TclInterp   *interp      (in)      Interpreter  to   use   for   error
                                           reporting.

       TclObj      *objPtr      (in/out)                                      ||
                                           String  value  contains   name   of |
                                           relief   (one   of   ffllaatt,  ggrroooovvee, |
                                           rraaiisseedd, rriiddggee, ssoolliidd,  or  ssuunnkkeenn); |
                                           internal  rep  will  be modified to |
                                           cache corresponding relief value.   |

       char         *string      (in)                                          ||
                                           Same  as  objPtr except description |
                                           of relief is passed as a string.

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

       CONST char   *name                  Name of the relief.

       int          relief       (in)      Relief      value      (one      of
                                           TKRELIEFFLAT,   TKRELIEFRAISED,
                                           TKRELIEFSUNKEN, TKRELIEFGROOVE,
                                           TKRELIEFSOLID,                 or
                                           TKRELIEFRIDGE).



DESCRIPTION
       TTkkGGeettRReelliieeffFFrroommOObbjj places in *reliefPtr the relief value corresponding |
       to  the  value  of  objPtr.   This value will be one of TKRELIEFFLAT, |
       TKRELIEFRAISED, TKRELIEFSUNKEN, TKRELIEFGROOVE,  TKRELIEFSOLID, |
       or  TKRELIEFRIDGE.   Under  normal  circumstances the return value is |
       TCLOK and interp is unused.  If objPtr  doesn't  contain  one  of  the |
       valid relief names or an abbreviation of one of them, then TCLERROR is |
       returned, *reliefPtr is unmodified, and an error message is  stored  in |
       interp's  result  if  interp  isn't  NULL.   TTkkGGeettRReelliieeffFFrroommOObbjj caches |
       information about the return value in objPtr, which  speeds  up  future |
       calls to TTkkGGeettRReelliieeffFFrroommOObbjj with the same objPtr.                      |

       TTkkGGeettRReelliieeff  is  identical  to  TTkkGGeettRReelliieeffFFrroommOObbjj  except  that  the |
       description of the relief is specified with  a  string  instead  of  an |
       object.   This  prevents TTkkGGeettRReelliieeff from caching the return value, so |
       TTkkGGeettRReelliieeff is less efficient than TTkkGGeettRReelliieeffFFrroommOObbjj.

       TTkkNNaammeeOOffRReelliieeff is the logical inverse of TTkkGGeettRReelliieeff.  Given a relief
       value  it  returns  the  corresponding  string  (ffllaatt,  rraaiisseedd, ssuunnkkeenn,
       ggrroooovvee, ssoolliidd, or rriiddggee).  If relief isn't a legal relief  value,  then
       ``unknown relief'' is returned.


KKEEYYWWOORRDDSS
       name, relief, string



Tk                                    8.1               TkGetReliefFromObj(3)