<?xml version="1.0" encoding="Windows-1255" ?><Interface name="KitHotkeys" alias="$ENV" id="core.env:KitHotkeys" sort="23" urn="core.env:extensions.KitHotkeys.js" toc="\Extension Points"><Summary>Extension point for defining kit hot keys.</Summary><Copyright>(c) SAP AG 2003-2006. All rights reserved.</Copyright>
<Topics>
<Method name="defineHotkey" sortGroup="true" scope="public" id="core.env:KitHotkeys!defineHotkey" sort="35" group="Methods" seq="0000"><Summary>Defines a new hotkey.</Summary><Parameters label="Form 1" descr="Define Hotkey by &lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;" signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;defineHotkey&lt;/b&gt;(&lt;i&gt;scope&lt;/i&gt;, &lt;i&gt;code&lt;/i&gt;, &lt;i&gt;cmd&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;"><Param name="scope" type="String">The hotkey scope (e.g., 'STUDIO').</Param><Param name="code" type="String">The hotkey code (e.g., 'CS65' for Ctrl+shift+A).</Param><Param name="cmd" type="KitCommands!COMMAND_DEF" typeRef="&lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;">The command to invoke when the hotkey is pressed.</Param></Parameters><Parameters label="Form 2" descr="Define Hotkey by command id." signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;defineHotkey&lt;/b&gt;(&lt;i&gt;scope&lt;/i&gt;, &lt;i&gt;code&lt;/i&gt;, &lt;i&gt;cmd&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;"><Param name="scope" type="String">The hotkey scope (e.g., 'STUDIO').</Param><Param name="code" type="String">The hotkey code (e.g., 'CS65' for Ctrl+shift+A).</Param><Param name="cmd" type="String">Id of an existing command to invoke when the hotkey is pressed.</Param></Parameters><Return type="KitCommands!COMMAND_DEF" typeRef="&lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;">The newly defined hotkey command.</Return><Remarks>&lt;h2&gt;Xml definition of a hotkey in a configuration file&lt;/h2&gt;
      &lt;pre&gt;
      &amp;lt;CONFIGURE type=&amp;quot;HOTKEYS&amp;quot;&amp;gt;
      ?  &amp;lt;HEADER&amp;gt;
      ?     &amp;lt;PRAGMA&amp;gt;# Pragmas section&amp;lt;/PRAGMA&amp;gt;
      ?     &amp;lt;SCRIPT&amp;gt;# Code section. Place here functions\variables
                      which you want to address from within the hotkey tags
            &amp;lt;/SCRIPT&amp;gt;
         &amp;lt;/HEADER&amp;gt;
         &amp;lt;HOTKEYS&amp;gt;
      +     &amp;lt;HOTKEY&amp;gt;
               &amp;lt;PROPERTIES&amp;gt;
                  &amp;lt;scope&amp;gt; # The hotkey scope &amp;lt;/scope&amp;gt;
                  &amp;lt;code&amp;gt; # The hotkey code &amp;lt;/code&amp;gt;
               &amp;lt;/PROPERTIES&amp;gt;
               &amp;lt;COMMAND&amp;gt;
                  # See &amp;quot;&lt;q ref=&quot;core.env:KitCommands!defineCommand&quot;&gt;defineCommand&lt;/q&gt;&amp;quot;
              &amp;lt;/COMMAND&amp;gt;
            &amp;lt;/HOTKEY&amp;gt;
         &amp;lt;/HOTKEYS&amp;gt;
      &amp;lt;/CONFIGURE&amp;gt;
      &lt;/pre&gt;
      &lt;h2&gt;Example&lt;/h2&gt;
      &lt;pre&gt;
      &amp;lt;CONFIGURE type=&amp;quot;HOTKEYS&amp;quot;&amp;gt;
         &amp;lt;HOTKEYS&amp;gt;
            &amp;lt;HOTKEY&amp;gt;
               &amp;lt;PROPERTIES&amp;gt;
                  &amp;lt;scope&amp;gt;GmlDrawing&amp;lt;/scope&amp;gt;
                  &amp;lt;code&amp;gt;113&amp;lt;/code&amp;gt;
               &amp;lt;/PROPERTIES&amp;gt;
               &amp;lt;COMMAND id=&amp;quot;EDIT_RENAME&amp;quot;&amp;gt;&amp;lt;/COMMAND&amp;gt;
            &amp;lt;/HOTKEY&amp;gt;
         &amp;lt;/HOTKEYS&amp;gt;
      &amp;lt;/CONFIGURE&amp;gt;
      &lt;/pre&gt;</Remarks></Method>
<Method name="getHotkey" sortGroup="true" scope="public" id="core.env:KitHotkeys!getHotkey" sort="35" group="Methods" seq="0001"><Summary>Returns the command associated with a specified hotkey.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getHotkey&lt;/b&gt;(&lt;i&gt;scope&lt;/i&gt;, &lt;i&gt;code&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;"><Param name="scope" type="String">The hotkey scope.</Param><Param name="code" type="String">The hotkey code.</Param></Parameters><Return type="KitCommands!COMMAND_DEF" typeRef="&lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;">The command associated with the requested hotkey.</Return></Method>
<Method name="getHotkeysByScope" sortGroup="true" scope="public" id="core.env:KitHotkeys!getHotkeysByScope" sort="35" group="Methods" seq="0002"><Summary>Returns the table of hotkeys in a specified scope.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getHotkeysByScope&lt;/b&gt;(&lt;i&gt;scope&lt;/i&gt;) &amp;rarr; &lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;[code]"><Param name="scope" type="String">The hotkeys table scope.</Param></Parameters><Return type="KitCommands!COMMAND_DEF[code]" typeRef="&lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;[code]">Table of command objects, indexed by hotkey code.</Return></Method>
<Method name="getHotkeysTable" sortGroup="true" scope="public" id="core.env:KitHotkeys!getHotkeysTable" sort="35" group="Methods" seq="0003"><Summary>Returns the complete hotkeys table.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;getHotkeysTable&lt;/b&gt;() &amp;rarr; &lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;[scope][code]"></Parameters><Return type="KitCommands!COMMAND_DEF[scope][code]" typeRef="&lt;q ref=&quot;core.env:KitCommands!COMMAND_DEF&quot;&gt;COMMAND_DEF&lt;/q&gt;[scope][code]">Table of command objects, indexed by hotkey scope and code.</Return><Remarks>Hotkey scope id's are stored in uppercase. Use &lt;q ref=&quot;core.lib:Basic!UPPER&quot;&gt;UPPER&lt;/q&gt; macro to convert the Hotkey scope id to uppercase
before using it as the index in this table.</Remarks></Method>
<Method name="removeHotkey" sortGroup="true" scope="public" id="core.env:KitHotkeys!removeHotkey" sort="35" group="Methods" seq="0004"><Summary>Removes a specified hotkey definition.</Summary><Parameters signature="method:: &lt;i&gt;$ENV&lt;/i&gt;.&lt;b&gt;removeHotkey&lt;/b&gt;(&lt;i&gt;scope&lt;/i&gt;, &lt;i&gt;code&lt;/i&gt;) &amp;rarr; void"><Param name="scope" type="String">The hotkey scope.</Param><Param name="code" type="String">The code of the hotkey to remove.</Param></Parameters><Return></Return></Method>
</Topics>
</Interface>