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

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1990-1994 The Regents of the University of California.
  3. '" Copyright (c) 1994-1997 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: menubutton.n,v 1.4.4.1 2004/10/28 10:19:29 dkf Exp $
  9. '" 
  10. .so man.macros
  11. .TH menubutton n 4.0 Tk "Tk Built-In Commands"
  12. .BS
  13. '" Note:  do not modify the .SH NAME line immediately below!
  14. .SH NAME
  15. menubutton - Create and manipulate menubutton widgets
  16. .SH SYNOPSIS
  17. fBmenubuttonfR fIpathName fR?fIoptionsfR?
  18. .SO
  19. -activebackground -disabledforeground -padx
  20. -activeforeground -font -pady
  21. -anchor -foreground -relief
  22. -background -highlightbackground -takefocus
  23. -bitmap -highlightcolor -text
  24. -borderwidth -highlightthickness -textvariable
  25. -cursor -image -underline
  26. -compound -justify -wraplength
  27. .SE
  28. .SH "WIDGET-SPECIFIC OPTIONS"
  29. .OP -direction direction Height
  30. Specifies where the menu is going to be popup up. fBabovefR tries to
  31. pop the menu above the menubutton. fBbelowfR tries to pop the menu
  32. below the menubutton. fBleftfR tries to pop the menu to the left of
  33. the menubutton. fBrightfR tries to pop the menu to the right of the
  34. menu button. fBflushfR pops the menu directly over the menubutton.
  35. In the case of fBabovefR or fBbelowfR, the direction will be
  36. reversed if the menu would show offscreen.
  37. .OP -height height Height
  38. Specifies a desired height for the menubutton.
  39. If an image or bitmap is being displayed in the menubutton then the value is in
  40. screen units (i.e. any of the forms acceptable to fBTk_GetPixelsfR);
  41. for text it is in lines of text.
  42. If this option isn't specified, the menubutton's desired height is computed
  43. from the size of the image or bitmap or text being displayed in it.
  44. .OP -indicatoron indicatorOn IndicatorOn
  45. The value must be a proper boolean value.  If it is true then
  46. a small indicator rectangle will be displayed on the right side
  47. of the menubutton and the default menu bindings will treat this
  48. as an option menubutton.  If false then no indicator will be
  49. displayed.
  50. .OP -menu menu MenuName
  51. Specifies the path name of the menu associated with this menubutton.
  52. The menu must be a child of the menubutton.
  53. .OP -state state State
  54. Specifies one of three states for the menubutton:  fBnormalfR, fBactivefR,
  55. or fBdisabledfR.  In normal state the menubutton is displayed using the
  56. fBforegroundfR and fBbackgroundfR options.  The active state is
  57. typically used when the pointer is over the menubutton.  In active state
  58. the menubutton is displayed using the fBactiveForegroundfR and
  59. fBactiveBackgroundfR options.  Disabled state means that the menubutton
  60. should be insensitive:  the default bindings will refuse to activate
  61. the widget and will ignore mouse button presses.
  62. In this state the fBdisabledForegroundfR and
  63. fBbackgroundfR options determine how the button is displayed.
  64. .OP -width width Width
  65. Specifies a desired width for the menubutton.
  66. If an image or bitmap is being displayed in the menubutton then the value is in
  67. screen units (i.e. any of the forms acceptable to fBTk_GetPixelsfR);
  68. for text it is in characters.
  69. If this option isn't specified, the menubutton's desired width is computed
  70. from the size of the image or bitmap or text being displayed in it.
  71. .BE
  72. .SH INTRODUCTION
  73. .PP
  74. The fBmenubuttonfR command creates a new window (given by the
  75. fIpathNamefR argument) and makes it into a menubutton widget.
  76. Additional
  77. options, described above, may be specified on the command line
  78. or in the option database
  79. to configure aspects of the menubutton such as its colors, font,
  80. text, and initial relief.  The fBmenubuttonfR command returns its
  81. fIpathNamefR argument.  At the time this command is invoked,
  82. there must not exist a window named fIpathNamefR, but
  83. fIpathNamefR's parent must exist.
  84. .PP
  85. A menubutton is a widget that displays a textual string, bitmap, or image
  86. and is associated with a menu widget.
  87. If text is displayed, it must all be in a single font, but it
  88. can occupy multiple lines on the screen (if it contains newlines
  89. or if wrapping occurs because of the fBwrapLengthfR option) and
  90. one of the characters may optionally be underlined using the
  91. fBunderlinefR option.  In normal usage, pressing
  92. mouse button 1 over the menubutton causes the associated menu to
  93. be posted just underneath the menubutton.  If the mouse is moved over
  94. the menu before releasing the mouse button, the button release
  95. causes the underlying menu entry to be invoked.  When the button
  96. is released, the menu is unposted.
  97. .PP
  98. Menubuttons are typically organized into groups called menu bars
  99. that allow scanning:
  100. if the mouse button is pressed over one menubutton (causing it
  101. to post its menu) and the mouse is moved over another menubutton
  102. in the same menu bar without releasing the mouse button, then the
  103. menu of the first menubutton is unposted and the menu of the
  104. new menubutton is posted instead.
  105. .PP
  106. There are several interactions between menubuttons and menus;  see
  107. the fBmenufR manual entry for information on various menu configurations,
  108. such as pulldown menus and option menus.
  109. .SH "WIDGET COMMAND"
  110. .PP
  111. The fBmenubuttonfR 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 menubutton 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 fBmenubuttonfR
  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 fBmenubuttonfR
  140. command.
  141. .SH "DEFAULT BINDINGS"
  142. .PP
  143. Tk automatically creates class bindings for menubuttons that give them
  144. the following default behavior:
  145. .IP [1]
  146. A menubutton activates whenever the mouse passes over it and deactivates
  147. whenever the mouse leaves it.
  148. .IP [2]
  149. Pressing mouse button 1 over a menubutton posts the menubutton:
  150. its relief changes to raised and its associated menu is posted
  151. under the menubutton.  If the mouse is dragged down into the menu
  152. with the button still down, and if the mouse button is then
  153. released over an entry in the menu, the menubutton is unposted
  154. and the menu entry is invoked.
  155. .IP [3]
  156. If button 1 is pressed over a menubutton and then released over that
  157. menubutton, the menubutton stays posted: you can still move the mouse
  158. over the menu and click button 1 on an entry to invoke it.
  159. Once a menu entry has been invoked, the menubutton unposts itself.
  160. .IP [4]
  161. If button 1 is pressed over a menubutton and then dragged over some
  162. other menubutton, the original menubutton unposts itself and the
  163. new menubutton posts.
  164. .IP [5]
  165. If button 1 is pressed over a menubutton and released outside
  166. any menubutton or menu, the menubutton unposts without invoking
  167. any menu entry.
  168. .IP [6]
  169. When a menubutton is posted, its associated menu claims the input
  170. focus to allow keyboard traversal of the menu and its submenus.
  171. See the fBmenufR manual entry for details on these bindings.
  172. .IP [7]
  173. If the fBunderlinefR option has been specified for a menubutton
  174. then keyboard traversal may be used to post the menubutton:
  175. Alt+fIxfR, where fIxfR is the underlined character (or its
  176. lower-case or upper-case equivalent), may be typed in any window
  177. under the menubutton's toplevel to post the menubutton.
  178. .IP [8]
  179. The F10 key may be typed in any window to post the first menubutton
  180. under its toplevel window that isn't disabled.
  181. .IP [9]
  182. If a menubutton has the input focus, the space and return keys
  183. post the menubutton.
  184. .PP
  185. If the menubutton's state is fBdisabledfR then none of the above
  186. actions occur:  the menubutton is completely non-responsive.
  187. .PP
  188. The behavior of menubuttons can be changed by defining new bindings for
  189. individual widgets or by redefining the class bindings.
  190. .SH KEYWORDS
  191. menubutton, widget