home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _15d0b77da8e3bb0bc5e070e9a6a58cac < prev    next >
Text File  |  2000-03-23  |  12KB  |  263 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::Menubutton - Create and manipulate Menubutton widgets</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Tk::Menubutton - Create and manipulate Menubutton widgets</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#standard options">STANDARD OPTIONS</A></LI>
  25.     <LI><A HREF="#widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></LI>
  26.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  27.     <LI><A HREF="#widget methods">WIDGET METHODS</A></LI>
  28.     <LI><A HREF="#default bindings">DEFAULT BINDINGS</A></LI>
  29.     <LI><A HREF="#keywords">KEYWORDS</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>Tk::Menubutton - Create and manipulate Menubutton widgets</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <P><EM>$menubutton</EM> = <EM>$parent</EM>-><STRONG>Menubutton</STRONG>(?<EM>options</EM>?);</P>
  48. <P>
  49. <HR>
  50. <H1><A NAME="standard options">STANDARD OPTIONS</A></H1>
  51. <P><TABLE CELLSPACING=0 CELLPADDING=0><TR><TD><STRONG>-activebackground</STRONG><TD><STRONG>-cursor</STRONG><TD><STRONG>-highlightthickness</STRONG><TD><STRONG>-takefocus</STRONG>
  52. <TR><TD><STRONG>-activeforeground</STRONG><TD><STRONG>-disabledforeground</STRONG><TD><STRONG>-image</STRONG><TD><STRONG>-text</STRONG>
  53. <TR><TD><STRONG>-anchor</STRONG><TD><STRONG>-font</STRONG><TD><STRONG>-justify</STRONG><TD><STRONG>-textvariable</STRONG>
  54. <TR><TD><STRONG>-background</STRONG><TD><STRONG>-foreground</STRONG><TD><STRONG>-padx</STRONG><TD><STRONG>-underline</STRONG>
  55. <TR><TD><STRONG>-bitmap</STRONG><TD><STRONG>-highlightbackground</STRONG><TD><STRONG>-pady</STRONG><TD><STRONG>-wraplength</STRONG>
  56. <TR><TD><STRONG>-borderwidth</STRONG><TD><STRONG>-highlightcolor</STRONG><TD><STRONG>-relief</STRONG></TABLE></P>
  57. <P>See <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> for details of the standard options.</P>
  58. <P>
  59. <HR>
  60. <H1><A NAME="widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></H1>
  61. <DL>
  62. <DT><STRONG><A NAME="item_Name%3A_direction">Name:    <STRONG>direction</STRONG></A></STRONG><BR>
  63. <DD>
  64. <DT><STRONG><A NAME="item_Class%3A_Height">Class:    <STRONG>Height</STRONG></A></STRONG><BR>
  65. <DD>
  66. <DT><STRONG><A NAME="item_Switch%3A_%2Ddirection">Switch:    <STRONG>-direction</STRONG></A></STRONG><BR>
  67. <DD>
  68. Specifies where the menu is going to be popup up. <STRONG>above</STRONG> tries to
  69. pop the menu above the menubutton. <STRONG>below</STRONG> tries to pop the menu
  70. below the menubutton. <STRONG>left</STRONG> tries to pop the menu to the left of
  71. the menubutton. <STRONG>right</STRONG> tries to pop the menu to the right of the
  72. menu button. <STRONG>flush</STRONG> pops the menu directly over the menubutton.
  73. <P></P>
  74. <DT><STRONG><A NAME="item_Name%3A_height">Name:    <STRONG>height</STRONG></A></STRONG><BR>
  75. <DD>
  76. <DT><STRONG>Class:    <STRONG>Height</STRONG></STRONG><BR>
  77. <DD>
  78. <DT><STRONG><A NAME="item_Switch%3A_%2Dheight">Switch:    <STRONG>-height</STRONG></A></STRONG><BR>
  79. <DD>
  80. Specifies a desired height for the menubutton.
  81. If an image or bitmap is being displayed in the menubutton then the value is in
  82. screen units (i.e. any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>);
  83. for text it is in lines of text.
  84. If this option isn't specified, the menubutton's desired height is computed
  85. from the size of the image or bitmap or text being displayed in it.
  86. <P></P>
  87. <DT><STRONG><A NAME="item_Name%3A_indicatorOn">Name:    <STRONG>indicatorOn</STRONG></A></STRONG><BR>
  88. <DD>
  89. <DT><STRONG><A NAME="item_Class%3A_IndicatorOn">Class:    <STRONG>IndicatorOn</STRONG></A></STRONG><BR>
  90. <DD>
  91. <DT><STRONG><A NAME="item_Switch%3A_%2Dindicatoron">Switch:    <STRONG>-indicatoron</STRONG></A></STRONG><BR>
  92. <DD>
  93. The value must be a proper boolean value.  If it is true then
  94. a small indicator rectangle will be displayed on the right side
  95. of the menubutton and the default menu bindings will treat this
  96. as an option menubutton.  If false then no indicator will be
  97. displayed.
  98. <P></P>
  99. <DT><STRONG><A NAME="item_Name%3A_menu">Name:    <STRONG>menu</STRONG></A></STRONG><BR>
  100. <DD>
  101. <DT><STRONG><A NAME="item_Class%3A_MenuName">Class:    <STRONG>MenuName</STRONG></A></STRONG><BR>
  102. <DD>
  103. <DT><STRONG><A NAME="item_Switch%3A_%2Dmenu">Switch:    <STRONG>-menu</STRONG></A></STRONG><BR>
  104. <DD>
  105. Specifies the path name of the menu associated with this menubutton.
  106. The menu must be a child of the menubutton.
  107. <P></P>
  108. <DT><STRONG><A NAME="item_Name%3A_state">Name:    <STRONG>state</STRONG></A></STRONG><BR>
  109. <DD>
  110. <DT><STRONG><A NAME="item_Class%3A_State">Class:    <STRONG>State</STRONG></A></STRONG><BR>
  111. <DD>
  112. <DT><STRONG><A NAME="item_Switch%3A_%2Dstate">Switch:    <STRONG>-state</STRONG></A></STRONG><BR>
  113. <DD>
  114. Specifies one of three states for the menubutton:  <STRONG>normal</STRONG>, <STRONG>active</STRONG>,
  115. or <STRONG>disabled</STRONG>.  In normal state the menubutton is displayed using the
  116. <STRONG>foreground</STRONG> and <STRONG>background</STRONG> options.  The active state is
  117. typically used when the pointer is over the menubutton.  In active state
  118. the menubutton is displayed using the <STRONG>activeForeground</STRONG> and
  119. <STRONG>activeBackground</STRONG> options.  Disabled state means that the menubutton
  120. should be insensitive:  the default bindings will refuse to activate
  121. the widget and will ignore mouse button presses.
  122. In this state the <STRONG>disabledForeground</STRONG> and
  123. <STRONG>background</STRONG> options determine how the button is displayed.
  124. <P></P>
  125. <DT><STRONG><A NAME="item_Name%3A_width">Name:    <STRONG>width</STRONG></A></STRONG><BR>
  126. <DD>
  127. <DT><STRONG><A NAME="item_Class%3A_Width">Class:    <STRONG>Width</STRONG></A></STRONG><BR>
  128. <DD>
  129. <DT><STRONG><A NAME="item_Switch%3A_%2Dwidth">Switch:    <STRONG>-width</STRONG></A></STRONG><BR>
  130. <DD>
  131. Specifies a desired width for the menubutton.
  132. If an image or bitmap is being displayed in the menubutton then the value is in
  133. screen units (i.e. any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>);
  134. for text it is in characters.
  135. If this option isn't specified, the menubutton's desired width is computed
  136. from the size of the image or bitmap or text being displayed in it.
  137. <P></P></DL>
  138. <P>
  139. <HR>
  140. <H1><A NAME="description">DESCRIPTION</A></H1>
  141. <P>The <STRONG>Menubutton</STRONG> method creates a new window (given by the
  142. $widget argument) and makes it into a menubutton widget.
  143. Additional
  144. options, described above, may be specified on the command line
  145. or in the option database
  146. to configure aspects of the menubutton such as its colors, font,
  147. text, and initial relief.  The <STRONG>menubutton</STRONG> command returns its
  148. $widget argument.  At the time this command is invoked,
  149. there must not exist a window named $widget, but
  150. $widget's parent must exist.</P>
  151. <P>A menubutton is a widget that displays a textual string, bitmap, or image
  152. and is associated with a menu widget.
  153. If text is displayed, it must all be in a single font, but it
  154. can occupy multiple lines on the screen (if it contains newlines
  155. or if wrapping occurs because of the <STRONG>wrapLength</STRONG> option) and
  156. one of the characters may optionally be underlined using the
  157. <STRONG>underline</STRONG> option.  In normal usage, pressing
  158. mouse button 1 over the menubutton causes the associated menu to
  159. be posted just underneath the menubutton.  If the mouse is moved over
  160. the menu before releasing the mouse button, the button release
  161. causes the underlying menu entry to be invoked.  When the button
  162. is released, the menu is unposted.</P>
  163. <P>Menubuttons are typically organized into groups called menu bars
  164. that allow scanning:
  165. if the mouse button is pressed over one menubutton (causing it
  166. to post its menu) and the mouse is moved over another menubutton
  167. in the same menu bar without releasing the mouse button, then the
  168. menu of the first menubutton is unposted and the menu of the
  169. new menubutton is posted instead.</P>
  170. <P>There are several interactions between menubuttons and menus;  see
  171. the <STRONG>menu</STRONG> manual entry for information on various menu configurations,
  172. such as pulldown menus and option menus.</P>
  173. <P>
  174. <HR>
  175. <H1><A NAME="widget methods">WIDGET METHODS</A></H1>
  176. <P>The <STRONG>Menubutton</STRONG> method creates a widget object.
  177. This object supports the <STRONG>configure</STRONG> and <STRONG>cget</STRONG> methods
  178. described in <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> which can be used to enquire and
  179. modify the options described above.
  180. The <STRONG>menu</STRONG> method returns the menu associated with the widget.
  181. The widget also inherits all the methods provided by the generic
  182. <A HREF="../../../site/lib/Tk/Widget.html">Tk::Widget</A> class.</P>
  183. <P>
  184. <HR>
  185. <H1><A NAME="default bindings">DEFAULT BINDINGS</A></H1>
  186. <P>Tk automatically creates class bindings for menubuttons that give them
  187. the following default behavior:</P>
  188. <DL>
  189. <DT><STRONG><A NAME="item_%5B1%5D">[1]</A></STRONG><BR>
  190. <DD>
  191. A menubutton activates whenever the mouse passes over it and deactivates
  192. whenever the mouse leaves it.
  193. <P></P>
  194. <DT><STRONG><A NAME="item_%5B2%5D">[2]</A></STRONG><BR>
  195. <DD>
  196. Pressing mouse button 1 over a menubutton posts the menubutton:
  197. its relief changes to raised and its associated menu is posted
  198. under the menubutton.  If the mouse is dragged down into the menu
  199. with the button still down, and if the mouse button is then
  200. released over an entry in the menu, the menubutton is unposted
  201. and the menu entry is invoked.
  202. <P></P>
  203. <DT><STRONG><A NAME="item_%5B3%5D">[3]</A></STRONG><BR>
  204. <DD>
  205. If button 1 is pressed over a menubutton and then released over that
  206. menubutton, the menubutton stays posted: you can still move the mouse
  207. over the menu and click button 1 on an entry to invoke it.
  208. Once a menu entry has been invoked, the menubutton unposts itself.
  209. <P></P>
  210. <DT><STRONG><A NAME="item_%5B4%5D">[4]</A></STRONG><BR>
  211. <DD>
  212. If button 1 is pressed over a menubutton and then dragged over some
  213. other menubutton, the original menubutton unposts itself and the
  214. new menubutton posts.
  215. <P></P>
  216. <DT><STRONG><A NAME="item_%5B5%5D">[5]</A></STRONG><BR>
  217. <DD>
  218. If button 1 is pressed over a menubutton and released outside
  219. any menubutton or menu, the menubutton unposts without invoking
  220. any menu entry.
  221. <P></P>
  222. <DT><STRONG><A NAME="item_%5B6%5D">[6]</A></STRONG><BR>
  223. <DD>
  224. When a menubutton is posted, its associated menu claims the input
  225. focus to allow keyboard traversal of the menu and its submenus.
  226. See the <STRONG>menu</STRONG> documentation for details on these bindings.
  227. <P></P>
  228. <DT><STRONG><A NAME="item_%5B7%5D">[7]</A></STRONG><BR>
  229. <DD>
  230. If the <STRONG>underline</STRONG> option has been specified for a menubutton
  231. then keyboard traversal may be used to post the menubutton:
  232. Alt+<EM>x</EM>, where <EM>x</EM> is the underlined character (or its
  233. lower-case or upper-case equivalent), may be typed in any window
  234. under the menubutton's toplevel to post the menubutton.
  235. <P></P>
  236. <DT><STRONG><A NAME="item_%5B8%5D">[8]</A></STRONG><BR>
  237. <DD>
  238. The F10 key may be typed in any window to post the first menubutton
  239. under its toplevel window that isn't disabled.
  240. <P></P>
  241. <DT><STRONG><A NAME="item_%5B9%5D">[9]</A></STRONG><BR>
  242. <DD>
  243. If a menubutton has the input focus, the space and return keys
  244. post the menubutton.
  245. <P>If the menubutton's state is <STRONG>disabled</STRONG> then none of the above
  246. actions occur:  the menubutton is completely non-responsive.</P>
  247. <P>The behavior of menubuttons can be changed by defining new bindings for
  248. individual widgets or by redefining the class bindings.</P>
  249. <P></P></DL>
  250. <P>
  251. <HR>
  252. <H1><A NAME="keywords">KEYWORDS</A></H1>
  253. <P>menubutton, widget</P>
  254. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  255. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  256. <STRONG><P CLASS=block> Tk::Menubutton - Create and manipulate Menubutton widgets</P></STRONG>
  257. </TD></TR>
  258. </TABLE>
  259.  
  260. </BODY>
  261.  
  262. </HTML>
  263.