home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _f736623a6b65b87346e2f9fda49f318f < prev    next >
Text File  |  2000-03-23  |  11KB  |  234 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::Button - Create and manipulate Button 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::Button - Create and manipulate Button 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::Button - Create and manipulate Button 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>$button</EM> = <EM>$parent</EM>-><STRONG>Button</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_command">Name:    <STRONG>command</STRONG></A></STRONG><BR>
  63. <DD>
  64. <DT><STRONG><A NAME="item_Class%3A_Command">Class:    <STRONG>Command</STRONG></A></STRONG><BR>
  65. <DD>
  66. <DT><STRONG><A NAME="item_Switch%3A_%2Dcommand">Switch:    <STRONG>-command</STRONG></A></STRONG><BR>
  67. <DD>
  68. Specifies a <A HREF="../../../site/lib/Tk/callbacks.html">perl/Tk callback</A> to associate with the button.  This command
  69. is typically invoked when mouse button 1 is released over the button
  70. window.
  71. <P></P>
  72. <DT><STRONG><A NAME="item_Name%3A_default">Name:    <STRONG>default</STRONG></A></STRONG><BR>
  73. <DD>
  74. <DT><STRONG><A NAME="item_Class%3A_Default">Class:    <STRONG>Default</STRONG></A></STRONG><BR>
  75. <DD>
  76. <DT><STRONG><A NAME="item_Switch%3A_%2Ddefault">Switch:    <STRONG>-default</STRONG></A></STRONG><BR>
  77. <DD>
  78. Specifies one of three states for the default ring: <STRONG>normal</STRONG>,
  79. <STRONG>active</STRONG>, or <STRONG>disabled</STRONG>.  In active state, the button is drawn
  80. with the platform specific appearance for a default button.  In normal
  81. state, the button is drawn with the platform specific appearance for a
  82. non-default button, leaving enough space to draw the default button
  83. appearance.  The normal and active states will result in buttons of
  84. the same size.  In disabled state, the button is drawn with the
  85. non-default button appearance without leaving space for the default
  86. appearance.  The disabled state may result in a smaller button than
  87. the active state.
  88. ring.
  89. <P></P>
  90. <DT><STRONG><A NAME="item_Name%3A_height">Name:    <STRONG>height</STRONG></A></STRONG><BR>
  91. <DD>
  92. <DT><STRONG><A NAME="item_Class%3A_Height">Class:    <STRONG>Height</STRONG></A></STRONG><BR>
  93. <DD>
  94. <DT><STRONG><A NAME="item_Switch%3A_%2Dheight">Switch:    <STRONG>-height</STRONG></A></STRONG><BR>
  95. <DD>
  96. Specifies a desired height for the button.
  97. If an image or bitmap is being displayed in the button then the value is in
  98. screen units (i.e. any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>);
  99. for text it is in lines of text.
  100. If this option isn't specified, the button's desired height is computed
  101. from the size of the image or bitmap or text being displayed in it.
  102. <P></P>
  103. <DT><STRONG><A NAME="item_Name%3A_state">Name:    <STRONG>state</STRONG></A></STRONG><BR>
  104. <DD>
  105. <DT><STRONG><A NAME="item_Class%3A_State">Class:    <STRONG>State</STRONG></A></STRONG><BR>
  106. <DD>
  107. <DT><STRONG><A NAME="item_Switch%3A_%2Dstate">Switch:    <STRONG>-state</STRONG></A></STRONG><BR>
  108. <DD>
  109. Specifies one of three states for the button:  <STRONG>normal</STRONG>, <STRONG>active</STRONG>,
  110. or <STRONG>disabled</STRONG>.  In normal state the button is displayed using the
  111. <STRONG>foreground</STRONG> and <STRONG>background</STRONG> options.  The active state is
  112. typically used when the pointer is over the button.  In active state
  113. the button is displayed using the <STRONG>activeForeground</STRONG> and
  114. <STRONG>activeBackground</STRONG> options.  Disabled state means that the button
  115. should be insensitive:  the default bindings will refuse to activate
  116. the widget and will ignore mouse button presses.
  117. In this state the <STRONG>disabledForeground</STRONG> and
  118. <STRONG>background</STRONG> options determine how the button is displayed.
  119. <P></P>
  120. <DT><STRONG><A NAME="item_Name%3A_width">Name:    <STRONG>width</STRONG></A></STRONG><BR>
  121. <DD>
  122. <DT><STRONG><A NAME="item_Class%3A_Width">Class:    <STRONG>Width</STRONG></A></STRONG><BR>
  123. <DD>
  124. <DT><STRONG><A NAME="item_Switch%3A_%2Dwidth">Switch:    <STRONG>-width</STRONG></A></STRONG><BR>
  125. <DD>
  126. Specifies a desired width for the button.
  127. If an image or bitmap is being displayed in the button then the value is in
  128. screen units (i.e. any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>);
  129. for text it is in characters.
  130. If this option isn't specified, the button's desired width is computed
  131. from the size of the image or bitmap or text being displayed in it.
  132. <P></P></DL>
  133. <P>
  134. <HR>
  135. <H1><A NAME="description">DESCRIPTION</A></H1>
  136. <P>The <STRONG>Button</STRONG> method creates a new window (given by the
  137. $widget argument) and makes it into a button widget.
  138. Additional
  139. options, described above, may be specified on the command line
  140. or in the option database
  141. to configure aspects of the button such as its colors, font,
  142. text, and initial relief.  The <STRONG>button</STRONG> command returns its
  143. $widget argument.  At the time this command is invoked,
  144. there must not exist a window named $widget, but
  145. $widget's parent must exist.</P>
  146. <P>A button is a widget that displays a textual string, bitmap or image.
  147. If text is displayed, it must all be in a single font, but it
  148. can occupy multiple lines on the screen (if it contains newlines
  149. or if wrapping occurs because of the <STRONG>-wraplength</STRONG> option) and
  150. one of the characters may optionally be underlined using the
  151. <STRONG>-underline</STRONG> option.
  152. It can display itself in either of three different ways, according
  153. to
  154. the <STRONG>-state</STRONG> option;
  155. it can be made to appear raised, sunken, or flat;
  156. and it can be made to flash.  When a user invokes the
  157. button (by pressing mouse button 1 with the cursor over the
  158. button), then the <A HREF="../../../site/lib/Tk/callbacks.html">perl/Tk callback</A> specified in the <STRONG>-command</STRONG>
  159. option is invoked.</P>
  160. <P>
  161. <HR>
  162. <H1><A NAME="widget methods">WIDGET METHODS</A></H1>
  163. <P>The <STRONG>Button</STRONG> method creates a widget object.
  164. This object supports the <STRONG>configure</STRONG> and <STRONG>cget</STRONG> methods
  165. described in <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> which can be used to enquire and
  166. modify the options described above.
  167. The widget also inherits all the methods provided by the generic
  168. <A HREF="../../../site/lib/Tk/Widget.html">Tk::Widget</A> class.</P>
  169. <P>The following additional methods are available for button widgets:</P>
  170. <DL>
  171. <DT><STRONG><A NAME="item_flash"><EM>$button</EM>-><STRONG>flash</STRONG></A></STRONG><BR>
  172. <DD>
  173. Flash the button.  This is accomplished by redisplaying the button
  174. several times, alternating between active and normal colors.  At
  175. the end of the flash the button is left in the same normal/active
  176. state as when the command was invoked.
  177. This command is ignored if the button's state is <STRONG>disabled</STRONG>.
  178. <P></P>
  179. <DT><STRONG><A NAME="item_invoke"><EM>$button</EM>-><STRONG>invoke</STRONG></A></STRONG><BR>
  180. <DD>
  181. Invoke the <A HREF="../../../site/lib/Tk/callbacks.html">callback</A> associated with the buttons
  182. <STRONG>-command</STRONG> option, if there is one.
  183. The return value is the return value from the callback, or the
  184. undefined value if there is no callback associated with the button.
  185. This command is ignored if the button's state is <STRONG>disabled</STRONG>.
  186. <P></P></DL>
  187. <P>
  188. <HR>
  189. <H1><A NAME="default bindings">DEFAULT BINDINGS</A></H1>
  190. <P>Tk automatically creates class bindings for buttons that give them
  191. default behavior:</P>
  192. <DL>
  193. <DT><STRONG><A NAME="item_%5B1%5D">[1]</A></STRONG><BR>
  194. <DD>
  195. A button activates whenever the mouse passes over it and deactivates
  196. whenever the mouse leaves the button.
  197. Under Windows, this binding is only active when mouse button 1 has
  198. been pressed over the button.
  199. <P></P>
  200. <DT><STRONG><A NAME="item_%5B2%5D">[2]</A></STRONG><BR>
  201. <DD>
  202. A button's relief is changed to sunken whenever mouse button 1 is
  203. pressed over the button, and the relief is restored to its original
  204. value when button 1 is later released.
  205. <P></P>
  206. <DT><STRONG><A NAME="item_%5B3%5D">[3]</A></STRONG><BR>
  207. <DD>
  208. If mouse button 1 is pressed over a button and later released over
  209. the button, the button is invoked.  However, if the mouse is not
  210. over the button when button 1 is released, then no invocation occurs.
  211. <P></P>
  212. <DT><STRONG><A NAME="item_%5B4%5D">[4]</A></STRONG><BR>
  213. <DD>
  214. When a button has the input focus, the space key causes the button
  215. to be invoked.
  216. <P>If the button's state is <STRONG>disabled</STRONG> then none of the above
  217. actions occur:  the button is completely non-responsive.</P>
  218. <P>The behavior of buttons can be changed by defining new bindings for
  219. individual widgets or by redefining the class bindings.</P>
  220. <P></P></DL>
  221. <P>
  222. <HR>
  223. <H1><A NAME="keywords">KEYWORDS</A></H1>
  224. <P>button, widget</P>
  225. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  226. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  227. <STRONG><P CLASS=block> Tk::Button - Create and manipulate Button widgets</P></STRONG>
  228. </TD></TR>
  229. </TABLE>
  230.  
  231. </BODY>
  232.  
  233. </HTML>
  234.