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

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1990-1994 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: button.n,v 1.6.8.1 2004/10/28 10:19:29 dkf Exp $
  9. '" 
  10. .so man.macros
  11. .TH button n 4.4 Tk "Tk Built-In Commands"
  12. .BS
  13. '" Note:  do not modify the .SH NAME line immediately below!
  14. .SH NAME
  15. button - Create and manipulate button widgets
  16. .SH SYNOPSIS
  17. fBbuttonfR fIpathName fR?fIoptionsfR?
  18. .SO
  19. -activebackground -font -relief
  20. -activeforeground -foreground -repeatdelay
  21. -anchor -highlightbackground -repeatinterval
  22. -background -highlightcolor -takefocus
  23. -bitmap -highlightthickness -text
  24. -borderwidth -image -textvariable
  25. -compound -justify -underline
  26. -cursor -padx -wraplength
  27. -disabledforeground -pady
  28. .SE
  29. .SH "WIDGET-SPECIFIC OPTIONS"
  30. .OP -command command Command
  31. Specifies a Tcl command to associate with the button.  This command
  32. is typically invoked when mouse button 1 is released over the button
  33. window.
  34. .OP -default default Default
  35. .VS
  36. Specifies one of three states for the default ring: fBnormalfR,
  37. fBactivefR, or fBdisabledfR.  In active state, the button is drawn
  38. with the platform specific appearance for a default button.  In normal
  39. state, the button is drawn with the platform specific appearance for a
  40. non-default button, leaving enough space to draw the default button
  41. appearance.  The normal and active states will result in buttons of
  42. the same size.  In disabled state, the button is drawn with the
  43. non-default button appearance without leaving space for the default
  44. appearance.  The disabled state may result in a smaller button than
  45. the active state.
  46. .VE
  47. .OP -height height Height
  48. Specifies a desired height for the button.
  49. If an image or bitmap is being displayed in the button then the value is in
  50. screen units (i.e. any of the forms acceptable to fBTk_GetPixelsfR);
  51. for text it is in lines of text.
  52. If this option isn't specified, the button's desired height is computed
  53. from the size of the image or bitmap or text being displayed in it.
  54. .VS 8.4
  55. .OP -overrelief overRelief OverRelief
  56. Specifies an alternative relief for the button, to be used when the
  57. mouse cursor is over the widget.  This option can be used to make
  58. toolbar buttons, by configuring fB-relief flat -overrelief
  59. raisedfR.  If the value of this option is the empty string, then no
  60. alternative relief is used when the mouse cursor is over the button.
  61. The empty string is the default value.
  62. .VE 8.4
  63. .OP -state state State
  64. Specifies one of three states for the button:  fBnormalfR, fBactivefR,
  65. or fBdisabledfR.  In normal state the button is displayed using the
  66. fBforegroundfR and fBbackgroundfR options.  The active state is
  67. typically used when the pointer is over the button.  In active state
  68. the button is displayed using the fBactiveForegroundfR and
  69. fBactiveBackgroundfR options.  Disabled state means that the button
  70. should be insensitive:  the default bindings will refuse to activate
  71. the widget and will ignore mouse button presses.
  72. In this state the fBdisabledForegroundfR and
  73. fBbackgroundfR options determine how the button is displayed.
  74. .OP -width width Width
  75. Specifies a desired width for the button.
  76. If an image or bitmap is being displayed in the button then the value is in
  77. screen units (i.e. any of the forms acceptable to fBTk_GetPixelsfR);
  78. for text it is in characters.
  79. If this option isn't specified, the button's desired width is computed
  80. from the size of the image or bitmap or text being displayed in it.
  81. .BE
  82. .SH DESCRIPTION
  83. .PP
  84. The fBbuttonfR command creates a new window (given by the
  85. fIpathNamefR argument) and makes it into a button widget.
  86. Additional
  87. options, described above, may be specified on the command line
  88. or in the option database
  89. to configure aspects of the button such as its colors, font,
  90. text, and initial relief.  The fBbuttonfR command returns its
  91. fIpathNamefR argument.  At the time this command is invoked,
  92. there must not exist a window named fIpathNamefR, but
  93. fIpathNamefR's parent must exist.
  94. .PP
  95. A button is a widget that displays a textual string, bitmap or image.
  96. If text is displayed, it must all be in a single font, but it
  97. can occupy multiple lines on the screen (if it contains newlines
  98. or if wrapping occurs because of the fBwrapLengthfR option) and
  99. one of the characters may optionally be underlined using the
  100. fBunderlinefR option.
  101. It can display itself in either of three different ways, according
  102. to
  103. the fBstatefR option; 
  104. it can be made to appear raised, sunken, or flat;
  105. and it can be made to flash.  When a user invokes the
  106. button (by pressing mouse button 1 with the cursor over the
  107. button), then the Tcl command specified in the fB-commandfR
  108. option is invoked.
  109. .SH "WIDGET COMMAND"
  110. .PP
  111. The fBbuttonfR command creates a new Tcl command whose
  112. name is fIpathNamefR.  This
  113. command may be used to invoke various
  114. operations on the widget.  It has the following general form:
  115. .CS
  116. fIpathName option fR?fIarg arg ...fR?
  117. .CE
  118. fIOptionfR and the fIargfRs
  119. determine the exact behavior of the command.  The following
  120. commands are possible for button widgets:
  121. .TP
  122. fIpathName fBcgetfR fIoptionfR
  123. Returns the current value of the configuration option given
  124. by fIoptionfR.
  125. fIOptionfR may have any of the values accepted by the fBbuttonfR
  126. command.
  127. .TP
  128. fIpathName fBconfigurefR ?fIoptionfR? ?fIvalue option value ...fR?
  129. Query or modify the configuration options of the widget.
  130. If no fIoptionfR is specified, returns a list describing all of
  131. the available options for fIpathNamefR (see fBTk_ConfigureInfofR for
  132. information on the format of this list).  If fIoptionfR is specified
  133. with no fIvaluefR, then the command returns a list describing the
  134. one named option (this list will be identical to the corresponding
  135. sublist of the value returned if no fIoptionfR is specified).  If
  136. one or more fIoption-valuefR pairs are specified, then the command
  137. modifies the given widget option(s) to have the given value(s);  in
  138. this case the command returns an empty string.
  139. fIOptionfR may have any of the values accepted by the fBbuttonfR
  140. command.
  141. .TP
  142. fIpathName fBflashfR
  143. Flash the button.  This is accomplished by redisplaying the button
  144. several times, alternating between active and normal colors.  At
  145. the end of the flash the button is left in the same normal/active
  146. state as when the command was invoked.
  147. This command is ignored if the button's state is fBdisabledfR.
  148. .TP
  149. fIpathName fBinvokefR
  150. Invoke the Tcl command associated with the button, if there is one.
  151. The return value is the return value from the Tcl command, or an
  152. empty string if there is no command associated with the button.
  153. This command is ignored if the button's state is fBdisabledfR.
  154. .SH "DEFAULT BINDINGS"
  155. .PP
  156. Tk automatically creates class bindings for buttons that give them
  157. default behavior:
  158. .IP [1]
  159. A button activates whenever the mouse passes over it and deactivates
  160. whenever the mouse leaves the button.
  161. .VS
  162. Under Windows, this binding is only active when mouse button 1 has
  163. been pressed over the button.
  164. .VE
  165. .IP [2]
  166. A button's relief is changed to sunken whenever mouse button 1 is
  167. pressed over the button, and the relief is restored to its original
  168. value when button 1 is later released.
  169. .IP [3]
  170. If mouse button 1 is pressed over a button and later released over
  171. the button, the button is invoked.  However, if the mouse is not
  172. over the button when button 1 is released, then no invocation occurs.
  173. .IP [4]
  174. When a button has the input focus, the space key causes the button
  175. to be invoked.
  176. .PP
  177. If the button's state is fBdisabledfR then none of the above
  178. actions occur:  the button is completely non-responsive.
  179. .PP
  180. The behavior of buttons can be changed by defining new bindings for
  181. individual widgets or by redefining the class bindings.
  182. .SH KEYWORDS
  183. button, widget