<doc>
  <legacy_id>2364</legacy_id>
  <name>acceleratorKey</name>
  <type>property</type>
  <syntax>
    <example>set the accel[erator]Key of <i>button</i> to {empty | <i>letterChar</i>}</example>
  </syntax>
  <library></library>
  <objects>
    <button/>
  </objects>
  <synonyms>
    <synonym>accelKey</synonym>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <property tag="default">default Property</property>
    <property tag="acceleratorText">acceleratorText Property</property>
    <property tag="commandChar">commandChar Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>Specifies a shortcut <glossary tag="key combination">key combination</glossary> for a <glossary tag="button">button's</glossary> <message tag="mouseUp">mouseUp</message> <glossary tag="handler">handler</glossary>.</summary>
  <examples>
    <example>set the acceleratorKey of button 1 to "a"</example>
    <example>set the acceleratorKey of button "Switch Order" to "F8"</example>
    <example>set the accelKey of button "Calc" to field "Key"</example>
  </examples>
  <description>
    <p>Use the <b>acceleratorKey</b> <glossary tag="property">property</glossary> to give users a shortcut <glossary tag="key combination">key combination</glossary> for often-used <glossary tag="button">buttons</glossary>, or to provide a <glossary tag="keyboard equivalent">keyboard shortcut</glossary> to a <keyword tag="button">button</keyword> that's used as a <glossary tag="menu item">menu item</glossary> in a <glossary tag="stack menu">stack menu</glossary>.</p><p/><p><b>Value:</b></p><p>The <b>acceleratorKey</b> of a <keyword tag="button">button</keyword> is a single lowercase letter from a to z, or a key name. Setting the <b>acceleratorKey</b> to empty removes the shortcut.</p><p/><p>By default, the <b>acceleratorKey</b> of a newly created <keyword tag="button">button</keyword> is empty.</p><p/><p><b>Comments:</b></p><p>Press the key combination defined in a button's <b>acceleratorKey</b> <glossary tag="property">property</glossary> to send a <message tag="mouseUp">mouseUp</message> message to the <keyword tag="button">button</keyword>, instead of clicking.</p><p/><p>The key(s) specified in the <b>acceleratorModifiers</b> <glossary tag="property">property</glossary> must be pressed along with the <b>acceleratorKey</b>.</p><p/><p><img src="202653"/> <b>Important!</b> The <b>acceleratorKey</b> <glossary tag="property">property</glossary> is <href tag="../glossary/casedashsensitive.xml">case-sensitive</href>. You must specify a lowercase letter as the <i>letterChar</i>; the uppercase letter is not equivalent.</p><p/><p>If the insertion point is in a field, the keypress is sent to the field, and the button does not receive it.</p><p/><p>On Unix systems, the key names are listed in the file "/usr/include/X11/keysymdef.h". Don't include the "XK_" prefix in these key names; for example, use "F8" for the key designated as "XK_F8" in the file.</p>
  </description>
</doc>