option.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:4k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1990 The Regents of the University of California.
  3. '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
  4. '"
  5. '" See the file "license.terms" for information on usage and redistribution
  6. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  7. '" 
  8. '" RCS: @(#) $Id: option.n,v 1.2.26.1 2004/10/28 12:25:22 dkf Exp $
  9. '" 
  10. .so man.macros
  11. .TH option n "" Tk "Tk Built-In Commands"
  12. .BS
  13. '" Note:  do not modify the .SH NAME line immediately below!
  14. .SH NAME
  15. option - Add/retrieve window options to/from the option database
  16. .SH SYNOPSIS
  17. .nf
  18. fBoption add fIpattern value fR?fIpriorityfR?
  19. fBoption clearfR
  20. fBoption get fIwindow name classfR
  21. fBoption readfile fIfileName fR?fIpriorityfR?
  22. .fi
  23. .BE
  24. .SH DESCRIPTION
  25. .PP
  26. The fBoptionfR command allows you to add entries to the Tk option
  27. database or to retrieve options from the database.  The fBaddfR
  28. form of the command adds a new option to the database.
  29. fIPatternfR contains
  30. the option being specified, and consists of names and/or classes
  31. separated by asterisks or dots, in the usual X format.  fIValuefR
  32. contains a text string to associate with fIpatternfR;  this is the
  33. value that will be returned in calls to fBTk_GetOptionfR or by
  34. invocations of the fBoption getfR command.  If fIpriorityfR
  35. is specified, it indicates the priority level for this option (see
  36. below for legal values);  it defaults to fBinteractivefR.
  37. This command always returns an empty string.
  38. .PP
  39. The fBoption clearfR command clears the option database.  Default
  40. options (from the
  41. fBRESOURCE_MANAGERfR property or the fB.XdefaultsfR
  42. file) will be reloaded automatically the next time an
  43. option is added to the database or removed from it.  This command
  44. always returns an empty string.
  45. .PP
  46. The fBoption getfR command returns the value of the option
  47. specified for fIwindowfR
  48. under fInamefR and fIclassfR.  If several entries in the option
  49. database match fIwindowfR, fInamefR, and fIclassfR, then
  50. the command returns whichever was created with highest
  51. fIpriorityfR level.  If there are several matching
  52. entries at the same priority level, then it returns whichever entry
  53. was most recently entered into the option database.  If there are
  54. no matching entries, then the empty string is returned.
  55. .PP
  56. The fBreadfilefR form of the command reads fIfileNamefR,
  57. which should have the standard format for an
  58. X resource database such as fB.XdefaultsfR, and adds all the
  59. options specified in that file to the option database.  If fIpriorityfR
  60. is specified, it indicates the priority level at which to enter the
  61. options;  fIpriorityfR defaults to fBinteractivefR.
  62. .PP
  63. The fIpriorityfR arguments to the fBoptionfR command are
  64. normally specified symbolically using one of the following values:
  65. .TP
  66. fBwidgetDefaultfR
  67. Level 20.  Used for default values hard-coded into widgets.
  68. .TP
  69. fBstartupFilefR
  70. Level 40.  Used for options specified in application-specific
  71. startup files.
  72. .TP
  73. fBuserDefaultfR
  74. Level 60.  Used for options specified in user-specific defaults
  75. files, such as fB.XdefaultsfR, resource databases loaded into
  76. the X server, or user-specific startup files.
  77. .TP
  78. fBinteractivefR
  79. Level 80.  Used for options specified interactively after the application
  80. starts running.  If fIpriorityfR isn't specified, it defaults to
  81. this level.
  82. .LP
  83. Any of the above keywords may be abbreviated.  In addition, priorities
  84. may be specified numerically using integers between 0 and 100,
  85. inclusive.  The numeric form is probably a bad idea except for new priority
  86. levels other than the ones given above.
  87. .SH EXAMPLES
  88. Instruct every button in the application to have red text on it unless
  89. explicitly overridden:
  90. .CS
  91. fBoption addfR *button.foreground red startupFile
  92. .CE
  93. .PP
  94. Allow users to control what happens in an entry widget when the Return
  95. key is pressed by specifying a script in the option database and add a
  96. default option for that which rings the bell:
  97. .CS
  98. entry .e
  99. bind .e <Return> [fBoption getfR .e returnCommand Command]
  100. fBoption addfR *.e.returnCommand bell widgetDefault
  101. .CE
  102. .SH KEYWORDS
  103. database, option, priority, retrieve