<doc>

<legacy_id>1231</legacy_id>

<name>controlKeyDown</name>

<type>message</type>

<syntax>

<example>controlKeyDown <i>keyName</i></example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

<function tag="keysDown">keysDown Function</function>

<message tag="commandKeyDown">commandKeyDown Message</message>

<message tag="keyDown">keyDown Message</message>

<message tag="optionKeyDown">optionKeyDown Message</message>

</references>

<history>

<introduced version="1.0">Added.</introduced>

</history>

<platforms>

<mac/>

<linux/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

</classes>

<security>

</security>

<summary>Sent when a Control <glossary tag="key combination">key combination</glossary> is pressed.</summary>

<examples>

<example>on controlKeyDown pKey <i>-- make Control-D delete the current card</i></p><p> if pKey is "D" then </p><p> delete this card</p><p> else </p><p> pass controlKeyDown</p><p> end if</p><p>end controlKeyDown</example>

</examples>

<description>

<p>Handle the <b>controlKeyDown</b> <keyword tag="message box">message</keyword> if you want to provide Control-key shortcuts on <glossary tag="Mac OS">Mac OS systems</glossary>.</p><p/><p><b>Parameters:</b></p><p>The <i>keyName</i> is the actual <keyword tag="character">character</keyword> of the pressed key.</p><p/><p><b>Comments:</b></p><p>The message is sent to the active (focused) control, or to the current card if no control is focused.</p><p/><p>If the Control key is pressed along with the Return key, Tab key, or Enter key, or with an arrow key, no <b>controlKeyDown</b> <keyword tag="message box">message</keyword> is sent. Instead, the <message tag="returnKey">returnKey</message>, <message tag="tabKey">tabKey</message>, <message tag="enterKey">enterKey</message>, or <message tag="arrowKey">arrowKey</message> <keyword tag="message box">message</keyword> is sent. To trap a combination such as Control-Return, use a <message tag="returnKey">returnKey</message> <glossary tag="handler">handler</glossary> and check the <function tag="controlKey">controlKey</function> <control_st tag="function">function</control_st> inside the <glossary tag="handler">handler</glossary>.</p><p/><p><img src="202652"/> <b>Cross-platform note:</b> On <glossary tag="Mac OS">Mac OS systems</glossary>, the <b>controlKeyDown</b> <keyword tag="message box">message</keyword> is sent when a control <glossary tag="key combination">key combination</glossary> is pressed. On <glossary tag="Windows">Windows systems</glossary>, a control <glossary tag="key combination">key combination</glossary> sends a <message tag="commandKeyDown">commandKeyDown</message> message instead, and the <b>controlKeyDown</b> <keyword tag="message box">message</keyword> is never sent. On <glossary tag="Unix">Unix systems</glossary>, the <b>controlKeyDown</b> <keyword tag="message box">message</keyword> is sent only if Mod2 has been defined.</p>

</description>

</doc>