home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / GetRelief.3 < prev    next >
Encoding:
Text File  |  1993-04-01  |  2.7 KB  |  79 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/GetRelief.3,v 1.5 93/04/01 09:41:37 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS Tk_GetRelief tkc
  25. .BS
  26. .SH NAME
  27. Tk_GetRelief, Tk_NameOfRelief \- translate between strings and relief values
  28. .SH SYNOPSIS
  29. .nf
  30. \fB#include <tk.h>\fR
  31. .sp
  32. int
  33. \fBTk_GetRelief(\fIinterp, name, reliefPtr\fB)\fR
  34. .sp
  35. char *
  36. \fBTk_NameOfRelief(\fIrelief\fB)\fR
  37. .SH ARGUMENTS
  38. .AS "Tcl_Interp" *reliefPtr
  39. .AP Tcl_Interp *interp in
  40. Interpreter to use for error reporting.
  41. .AP char *name in
  42. String containing relief name (one of ``flat'', ``groove'',
  43. ``raised'', ``ridge'', or ``sunken'').
  44. .AP int *reliefPtr out
  45. Pointer to location in which to store relief value corresponding to
  46. \fIname\fR.
  47. .AP int relief in
  48. Relief value (one of TK_RELIEF_FLAT, TK_RELIEF_RAISED, TK_RELIEF_SUNKEN,
  49. .VS
  50. TK_RELIEF_GROOVE, or TK_RELIEF_RIDGE).
  51. .VE
  52. .BE
  53.  
  54. .SH DESCRIPTION
  55. .PP
  56. \fBTk_GetRelief\fR places in \fI*reliefPtr\fR the relief value
  57. corresponding to \fIname\fR.  This value will be one of
  58. TK_RELIEF_FLAT, TK_RELIEF_RAISED, TK_RELIEF_SUNKEN,
  59. .VS
  60. TK_RELIEF_GROOVE, or TK_RELIEF_RIDGE.
  61. .VE
  62. Under normal circumstances the return value is TCL_OK and
  63. \fIinterp\fR is unused.
  64. If \fIname\fR doesn't contain one of the valid relief names
  65. or an abbreviation of one of them, then an error message
  66. is stored in \fIinterp->result\fR,
  67. TCL_ERROR is returned, and \fI*reliefPtr\fR is unmodified.
  68. .PP
  69. \fBTk_NameOfRelief\fR is the logical inverse of \fBTk_GetRelief\fR.
  70. Given a relief value it returns the corresponding string (``flat'',
  71. .VS
  72. ``raised'', ``sunken'', ``groove'', or ``ridge'').
  73. .VE
  74. If \fIrelief\fR isn't a legal relief value, then ``unknown relief''
  75. is returned.
  76.  
  77. .SH KEYWORDS
  78. name, relief, string
  79.