Func
当脚本通过命令调用时,会将其传递给 Func 对象。在脚本函数(/Manual/scripting/script_functions.zh.md)中,会将其传递给 OnClick 方法作为 ClickData.func 属性,并且在通过 ScriptCommandData.func 属性添加内部命令脚本插件(/Manual/scripting/example_scripts/adding_a_new_internal_command.zh.md)中。Func 对象提供有关命令的默认源和目标的信息,以及有关如何调用的详细说明。
属性名称 | 返回类型 | 描述 |
---|---|---|
args | object:Args | 返回一个 Args 对象,用于访问调用此脚本的命令行上给定的任何参数。当脚本将内部命令添加到 Opus 时,会使用此项。当添加命令时,可以提供命令行模板,并且用户在脚本命令的命令行上提供的任何参数都可通过此对象获得。 对于大多数用途,argsmap 属性可能是访问你的命令的参数的更简单方法。 |
argsmap | object:Map | |
command | object:Command | 此属性返回一个预先填充的 Command 对象,该对象可用于针对源和目标标签页运行命令。使用此对象相当于调用 DOpusFactory.Command 并手动设置源和目标标签页。 |
desttab | object:Tab | 此对象表示此函数的默认目标标签页。 |
fromdrop | bool | 如果通过拖放操作调用命令,则返回 True。 |
fromkey | bool | 如果通过键盘(即通过热键而不是按钮)调用命令,则返回 True。 |
qualifiers | string | 返回一个字符串,表示用户在调用命令时按下的任意限定键。 字符串可以包含以下任意或所有内容:shift, ctrl, alt, lwin, rwin。 如果没有按下限定键,则字符串为:none |
sourcetab | object:Tab | 此对象表示此函数的默认源标签页。 |
viewer | object:Viewer | 如果从独立图像浏览器(/Manual/additional_functionality/viewing_images/README.zh.md)运行此按钮,则此对象表示浏览器窗口。 |
最后更新于