home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / GetOption.3 < prev    next >
Encoding:
Text File  |  1993-04-01  |  2.2 KB  |  60 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/GetOption.3,v 1.5 93/04/01 09:41:30 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS Tk_GetOption tkc
  25. .BS
  26. .SH NAME
  27. Tk_GetOption \- retrieve an option from the option database
  28. .SH SYNOPSIS
  29. .nf
  30. \fB#include <tk.h>\fR
  31. .sp
  32. Tk_Uid
  33. \fBTk_GetOption\fR(\fItkwin, name, class\fR)
  34. .SH ARGUMENTS
  35. .AS Tk_Window *class
  36. .AP Tk_Window tkwin in
  37. Token for window.
  38. .AP char *name in
  39. Name of desired option.
  40. .AP char *class in
  41. Class of desired option.  Null means there is no class for
  42. this option;  do lookup based on name only.
  43. .BE
  44.  
  45. .SH DESCRIPTION
  46. .PP
  47. This procedure is invoked to retrieve an option from the database
  48. associated with \fItkwin\fR's main window.  If there is an option
  49. for \fItkwin\fR that matches the given \fIname\fR or \fIclass\fR,
  50. then it is returned in the form of a Tk_Uid.  If multiple options
  51. match \fIname\fR and \fIclass\fR, then the highest-priority one
  52. is returned.  If no option matches, then NULL is returned.
  53. .PP
  54. \fBTk_GetOption\fR caches options related to \fItkwin\fR so that
  55. successive calls for the same \fItkwin\fR will execute much more
  56. quickly than successive calls for different windows.
  57.  
  58. .SH KEYWORDS
  59. class, name, option, retrieve
  60.