Ξ
Δ
◄
►
¬
Ѕ
过滤筛选
指令
内置变量
内置函数
控制流语句
运算符
声明
内置类
内置方法/属性
Ahk2Exe 编译器
高亮关键词
</head> <body> <h1>Hotkey</h1> <p>在脚本运行时创建, 修改, 启用或禁用热键.</p> <pre class="Syntax"> <span class="func">Hotkey</span> KeyName <span class="optional">, Action, Options</span> </pre> <h2 id="Parameters">参数</h2> <dl> <dt>KeyName</dt> <dd> <p>类型: <a href="../Concepts.htm#strings">字符串</a></p> <p>热键的按键的名称, 包括所有<a href="../Hotkeys.htm#Symbols">修饰符</a>. 例如, 指定 <code>#c</code> 来触发 <kbd>Win</kbd>+<kbd>C</kbd> 热键.</p> <p>如果 <em>KeyName</em> 是已经存在的热键 -- 通过 Hotkey 函数或脚本中的<a href="../Hotkeys.htm">双冒号语法</a> -- 那么将使用此函数的其他参数值更新原有的热键.</p> <p>指定 <em>现有的</em> 热键, <em>KeyName</em> 是不区分大小写的. 但是, 按键名称必须和现有的热键拼写相同(例如在这种情况下 Esc 与 Escape 是不同的). 此外, <a href="../Hotkeys.htm#Symbols">修饰符</a>(如 <code>^!+#</code>) 的顺序是无关紧要的. <a href="GetKeyName.htm">GetKeyName</a> 可用于获取标准的按键名称.</p> <p>热键首次创建时 -- 无论是通过 Hotkey 函数还是脚本中的<a href="../Hotkeys.htm">双冒号语法</a> -- 其键名以及修饰符的顺序成为此热键的固定名称, 正如 <a href="../Hotkeys.htm#ThisHotkey">ThisHotkey</a> 所反映的那样. 这个名称由热键的所有<a href="_HotIf.htm#variant">变体</a>共享, 并且即使之后 Hotkey 函数使用不同的修饰符顺序操作此热键, 此名称也不会改变.</p> <p>如果热键变体已经存在, 则根据 <em>KeyName</em> 是否包含<a href="../Hotkeys.htm#Tilde">颚化符前缀(~)</a> 更新它的行为.</p> <p>使用<a href="../Hotkeys.htm#prefixdollar">钩子前缀($)</a> 可添加到现有热键上. 这个前缀影响所有热键的变体且不能被删除.</p> </dd> <dt>Action</dt> <dd> <p>类型: <a href="../misc/Functor.htm">函数对象</a>或<a href="../Concepts.htm#strings">字符串</a></p> <p>如果省略, 并且 <em>KeyName</em> 已经作为热键存在, 则不会更改其操作. 这用于只更改热键的 <em>Options</em>. 否则, 指定回调, 不带冒号的<a href="../Hotkeys.htm">热键</a>名称, 或下面列出的特殊值之一.</p> <hr> <p>指定在按下热键时要调用的函数(作为新<a href="../misc/Threads.htm">线程</a>).</p> <p>回调函数接受一个参数, <a href="../Functions.htm#intro">定义</a>如下:</p> <pre class="NoIndent">MyCallback(HotkeyName) { ...</pre> <p>尽管您给参数的名称并不重要, 但它被赋值为<a href="../Hotkeys.htm#ThisHotkey">热键名称</a>.</p> <p>如果不需要相应的信息, 可以省略回调参数, 但在这种情况下必须指定星号, 例如 <code>MyCallback(*)</code>.</p> <p><a href="../Hotkeys.htm">双冒号语法</a>定义的热键自动使用参数名称 <code>ThisHotkey</code>. 也可以在没有 Hotkey 函数的情况下, 为热键<a href="../Hotkeys.htm#Function">指定一个函数名</a>.</p> <p class="note"><strong>注意:</strong> 如果指定了回调, 但是由于之前使用 Hotkey 函数而禁用了热键, 那么热键仍将继续禁用. 为了避免这种情况, 请在 <em>Options</em> 中包含单词 ON.</p> <hr> <p>指定热键名称以使用其原始函数; 具体来说, 热键变体的原始函数对应于当前的 <a href="HotIf.htm">HotIf</a> 条件. 这通常用于在更改热键后恢复热键的原始函数, 但也可以用于分配不同热键的函数, 提是两个热键使用相同的 HotIf 条件.</p> <hr> <p>指定以下特殊值之一:</p> <p><strong>On:</strong> 启用热键. 如果热键已经处于启用状态, 则不进行操作.</p> <p><strong>Off:</strong> 禁用热键. 如果热键已经处于禁用状态, 则不进行操作.</p> <p><strong>Toggle:</strong> 设置热键到相反的状态(启用或禁用).</p> <p><strong>AltTab</strong>(及其他): <a href="../Hotkeys.htm#alttab">这里</a>描述的特殊的 Alt-Tab 热键动作.</p> </dd> <dt id="Options">Options</dt> <dd> <p>类型: <a href="../Concepts.htm#strings">字符串</a></p> <p>由零个或多个下列选项组成的字符串, 字母间可以用空格分隔. 例如: <code>"On B0"</code>.</p> <p><strong>On:</strong> 如果热键当前是禁用的, 则启用它.</p> <p><strong>Off:</strong> 如果热键当前是启用的, 则禁用它. 此选项常用来创建初始状态为禁用的热键.</p> <p><strong>B</strong> 或 <strong>B0:</strong> 指定字母 B 将按照 <a href="_MaxThreadsBuffer.htm">#MaxThreadsBuffer</a> 中描述的方法缓冲热键. 指定 <code>B0</code>(B 后跟着数字 0) 来禁用这种类型的缓冲.</p> <p><strong>P</strong><em>n</em>: 指定字母 P 后面跟着热键的<a href="../misc/Threads.htm">线程优先级</a>. 如果创建热键时省略 P 选项, 则设置优先级为 0.</p> <p id="SuspendExempt"><strong>S</strong> 或 <strong>S0:</strong> 指定字母 S 热键<a href="_SuspendExempt.htm">免于</a><a href="Suspend.htm">挂起</a>, 这允许使用热键来关闭挂起. 指定 S0(S 和数字 0) 来移除该豁免, 允许热键被挂起.</p> <p><strong>T</strong><em>n</em>: 指定字母 T 后面跟着一个表示此热键允许的线程数, 如同 <a href="_MaxThreadsPerHotkey.htm">#MaxThreadsPerHotkey</a> 中描述的那样. 例如: <code>T5</code>.</p> <p><strong>I</strong><em>n</em>(InputLevel): 指定字母 I(或 i) 后跟随热键的<a href="_InputLevel.htm">输入级别</a>. 例如: <code>I1</code>.</p> <p>如果任一选项字母被忽略并且热键已经存在, 这些选项将不会被更改. 但是, 如果热键还不存在 -- 也就是说, 它将由这个函数创建 -- 这些选项将默认为最近生效的那些. 例如, 如果 <a href="_MaxThreadsBuffer.htm">#MaxThreadsBuffer</a> 出现在脚本的最底部, 也会被使用. 如果脚本中没有出现 <a href="_MaxThreadsBuffer.htm">#MaxThreadsBuffer</a>, 那么将使用它的默认设置(在本例中为 OFF).</p> </dd> </dl> <h2 id="Error_Handling">错误处理</h2> <p>如果参数无效或内存分配失败, 则抛出异常.</p> <p>如果热键无效或无法创建, 则会抛出以下异常:</p> <table class="info"> <tr> <th abbr="Class">错误类</th> <th>.Message</th> <th style="width: 50%;" abbr="Descr">说明</th> </tr> <tr> <td rowspan="4"><a href="Error.htm#ValueError">ValueError</a></td> <td>Invalid key name.(无效的按键名称.)</td> <td><em>KeyName</em> 参数指定一个或多个当前键盘布局/语言不识别或不支持的键. <a href="Error.htm#Extra">Exception.Extra</a> 包含键名; 例如 <code>!Entre</code> 中的 "Entre".</td> </tr> <tr> <td>Unsupported prefix key.(不支持的前缀键.)</td> <td>例如, 不支持将鼠标滚轮作为热键 <code>WheelDown & Enter</code> 的前缀. <a href="Error.htm#Extra">Exception.Extra</a> 包含前缀键.</td> </tr> <tr> <td>This AltTab hotkey must have exactly one modifier/prefix.</td> <td rowspan="2"><em>KeyName</em> 参数不适合与 <a href="../Hotkeys.htm#alttab">AltTab 或 ShiftAltTab</a> 动作一起使用. 需要两个键(至多) 的组合. 例如: <code>RControl & RShift::AltTab</code>. <a href="Error.htm#Extra">Exception.Extra</a> 包含 <em>KeyName</em>.</td> </tr> <tr> <td>This AltTab hotkey must specify which key (L or R).</td> </tr> <tr> <td rowspan="2"><a href="Error.htm#TargetError">TargetError</a></td> <td>Nonexistent hotkey.(不存在的热键.)</td> <td>该函数试图修改一个不存在的热键. <a href="Error.htm#Extra">Exception.Extra</a> 包含 <em>KeyName</em>.</td> </tr> <tr> <td>Nonexistent hotkey variant (IfWin).</td> <td>该函数试图修改一个不存在的现有热键<a href="#variant">变体</a>. 要解决这个问题, 请使用 <a href="HotIf.htm">HotIf</a> 设置条件使其与要修改的热键的条件相匹配. <a href="Error.htm#Extra">Exception.Extra</a> 包含 <em>KeyName</em>.</td> </tr> <tr> <td><a href="Error.htm">Error</a></td> <td>Max hotkeys.</td> <td>创建这个热键将超过每个脚本 32762 个热键的限制(不过, 每个热键可以有无限数量的<a href="#variant">变体</a>, 而且也没有对<a href="../Hotstrings.htm">热字串</a>数量的限制).</td> </tr> </table> <p>提示: <a href="Try.htm">Try</a>-<a href="Catch.htm">Catch</a> 可以用来测试是否存在热键变体. 例如:</p> <pre> try Hotkey "^!p" catch TargetError MsgBox "The hotkey does not exist or it has no variant for the current HotIf criteria." </pre> <h2 id="Remarks">备注</h2> <p><a href="HotIf.htm">当前的 HotIf 设置</a>决定了 Hotkey 函数将操作热键的哪个<a href="#variant">变体</a>.</p> <p>如果需要根据活动窗口的类型来自动禁用选择的热键或热字串, 使用 <code>Hotkey "^!c", "Off"</code> 通常不如 <a href="_HotIf.htm">#HotIf</a> 带有 <a href="WinActive.htm">WinActive</a>/<a href="WinExist.htm">WinExist</a>(或它们的动态副本 <a href="HotIf.htm#IfWin">HotIfWinActive/Exist</a>) 来的方便.</p> <p>通过<a href="../Hotkeys.htm">双冒号语法</a>创建的热键比使用 Hotkey 函数执行地更好, 因为在脚本启动时会批量启用它们(而非一个一个地启用). 因此, 最好使用此函数仅创建那些在脚本开始运行后才知道其键名的热键. 一种此类情况是, 当通过 <a href="IniRead.htm">INI 文件</a>来配置脚本各种操作的热键时使用此函数.</p> <p>如果脚本被<a href="Suspend.htm">挂起了</a>, 那么新增加/启用的热键也将是挂起的, 直到挂起状态被关闭(除非它们像 <a href="Suspend.htm">Suspend</a> 页面中描述的那样进行了豁免).</p> <p>如果由这个函数所做的更改是合理的将会安装或移除<a href="InstallKeybdHook.htm">键盘</a>和/或<a href="InstallMouseHook.htm">鼠标</a>钩子.</p> <p>尽管 Hotkey 函数不能直接启用或禁用其他脚本中的热键, 但在大多数情况下它可以通过创建或启用相同的热键来<a href="../misc/Override.htm">覆盖</a>它们. 这样是否有效取决于下列因素: 1) 在其他脚本中需要被覆盖的热键是否为<a href="ListHotkeys.htm">钩子热键</a>(非钩子热键总是可以成功覆盖); 2) 最近启动的热键通常优先于其他脚本中的相同热键(因此, 如果脚本是最近启动的, 那么它的覆盖应该总是会成功); 3) 此热键的启用或创建是否会重新激活<a href="InstallKeybdHook.htm">键盘</a>或<a href="InstallMouseHook.htm">鼠标</a>钩子(如果是, 那么覆盖总是会成功).</p> <p>脚本中至少有一个热键时, 它会变成<a href="../Scripts.htm#persistent">持续运行的</a>, 这意味着应该使用 <a href="ExitApp.htm">ExitApp</a> 而不是 <a href="Exit.htm">Exit</a> 来终止它.</p> <h2 id="variant">变体(副本) 热键</h2> <p>一个特定的热键可以被创建多次, 如果每个定义有不同的 <a href="HotIf.htm">HotIf</a> 条件. 这被称为 <em>热键变体</em>. 例如:</p> <pre>HotIfWinActive "ahk_class Notepad" Hotkey "^!c", MyFuncForNotepad HotIfWinActive "ahk_class WordPadClass" Hotkey "^!c", MyFuncForWordPad HotIfWinActive Hotkey "^!c", MyFuncForAllOtherWindows</pre> <p>如果有多个变体符合触发条件, 那么仅触发最早创建的那个. 这种情况的例外是全局变体(不带 HotIf 条件的那个): 它的优先级总是最低的, 仅当其他变体都不触发时它才会被触发.</p> <p>创建重复热键时, <a href="../Hotkeys.htm#Symbols">修饰符</a>的顺序(如 <code>^!+#</code>) 没有关系. 例如, <code>"^!c"</code> 等同于 <code>"!^c"</code>. 但是, 按键必须拼写一致. 例如, 用于此目的时, <em>Esc</em> 不同于 <em>Escape</em>(尽管大小写无关). 最后, 任何带有<a href="../Hotkeys.htm#wildcard">通配符前缀(*)</a> 的热键和不带通配符的热键是完全独立的; 例如, <code>"*F1"</code> 和 <code>"F1"</code> 都有他们各自的变体.</p> <p>有关详情, 请参阅 <a href="HotIf.htm">HotIf</a> 和 <a href="_HotIf.htm#general-remarks">#HotIf 的备注</a>.</p> <h2 id="Related">相关</h2> <p><a href="../Hotkeys.htm">Hotkey</a>, <a href="HotIf.htm">HotIf</a>, <a href="../Variables.htm#ThisHotkey">A_ThisHotkey</a>, <a href="_MaxThreadsBuffer.htm">#MaxThreadsBuffer</a>, <a href="_MaxThreadsPerHotkey.htm">#MaxThreadsPerHotkey</a>, <a href="Suspend.htm">Suspend</a>, <a href="../misc/Threads.htm">线程</a>, <a href="Thread.htm">Thread</a>, <a href="Critical.htm">Critical</a>, <a href="Return.htm">Return</a>, <a href="Menu.htm">Menu 对象</a>, <a href="SetTimer.htm">SetTimer</a>, <a href="Hotstring.htm">Hotstring function</a></p> <h2 id="Examples">示例</h2> <div class="ex" id="ExBasic"> <p><a class="ex_number" href="#ExBasic"></a> 创建 Ctrl-Alt-Z 热键.</p> <pre>Hotkey "^!z", MyFunc MyFunc(ThisHotkey) { MsgBox "You pressed " ThisHotkey }</pre> </div> <div class="ex" id="ExAltTab"> <p><a class="ex_number" href="#ExAltTab"></a> 让 RCtrl & RShift 执行 Alt-Tab 的功能.</p> <pre>Hotkey "RCtrl & RShift", "AltTab"</pre> </div> <div class="ex" id="ExOff"> <p><a class="ex_number" href="#ExOff"></a> 禁用 Shift-Win-C 热键.</p> <pre>Hotkey "$+#c", "Off"</pre> </div> <div class="ex" id="ExT"> <p><a class="ex_number" href="#ExT"></a> 改变热键为允许 5 个线程.</p> <pre>Hotkey "^!a",, "T5"</pre> </div> <div class="ex" id="ExIfWin"> <p><a class="ex_number" href="#ExIfWin"></a> 创建仅在记事本中有效的热键 <kbd>Alt</kbd>+<kbd>W</kbd>.</p> <pre>HotIfWinActive "ahk_class Notepad" Hotkey "!w", ToggleWordWrap <em>; !w = Alt+W</em> ToggleWordWrap(ThisHotkey) { MenuSelect "A",, "Format", "Word Wrap" } </pre> </div> <div class="ex" id="ExampleIfFn"> <p><a class="ex_number" href="#ExampleIfFn"></a> 创建一个界面允许你注册简单的三键组合热键.</p> <pre> HkGui := Gui() HkGui.Add("Text", "xm", "Prefix key:") HkGui.Add("Edit", "yp x100 w100 vPrefix", "Space") HkGui.Add("Text", "xm", "Suffix hotkey:") HkGui.Add("Edit", "yp x100 w100 vSuffix", "f & j") HkGui.Add("Button", "Default", "Register").OnEvent("Click", RegisterHotkey) HkGui.OnEvent("Close", (*) => ExitApp()) HkGui.OnEvent("Escape", (*) => ExitApp()) HkGui.Show() RegisterHotkey(*) { Saved := HkGui.Submit(false) HotIf (*) => GetKeyState(Saved.Prefix) Hotkey Saved.Suffix, (ThisHotkey) => MsgBox(ThisHotkey) }</pre> </div> </body> </html>