VNOX-Client/patches/atspi-common/xml/Action.xml
loki5512344 8e5ab56611
feat(client): redesign native UI, themes, settings and avatars
Separate conversation drafts and voice view state, add native settings and restricted CSS themes, implement validated avatar cropping, and refresh dependencies with documented desktop compatibility backports.
2026-10-24 14:23:48 +02:00

128 lines
4.9 KiB
XML
Vendored

<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<!--
org.a11y.atspi.Action:
@short_description: Allows exploring and invoking the actions of a user-actionable UI component.
For example, a button may expose a "click" action; a popup menu may expose an "open"
action. Components which are not "passive" providers of UI information should
implement this interface, unless there is a more specialized interface for
interaction like org.a11y.atspi.Text or org.a11y.atspi.Value.
-->
<interface name="org.a11y.atspi.Action">
<!--
NActions: returns the number of available actions.
By convention, if there is more than one action available, the first one is
considered the "default" action of the object.
-->
<property name="NActions" type="i" access="read"/>
<!--
GetDescription:
@index: 0-based index of the action to query.
Returns: The localized description for the action at the specified @index. For
example, a screen reader will read out this description when the user asks for
extra detail on an action. For example, "Clicks the button" for the "click"
action of a button.
-->
<method name="GetDescription">
<arg type="i" name="index" direction="in"/>
<arg type="s" direction="out"/>
</method>
<!--
GetName:
@index: 0-based index of the action to query.
Returns: Machine-readable name for the action at the specified @index.
-->
<method name="GetName">
<arg type="i" name="index" direction="in"/>
<arg type="s" direction="out"/>
</method>
<!--
GetLocalizedName:
@index: 0-based index of the action to query.
Returns: A short, localized name for the action at the specified @index. This is
what screen readers will read out during normal navigation. For example, "Click"
for a button.
-->
<method name="GetLocalizedName">
<arg type="i" name="index" direction="in"/>
<arg type="s" direction="out"/>
</method>
<!--
GetKeyBinding:
@index: 0-based index of the action to query.
Gets the keybinding which can be used to activate this action, if one
exists. The string returned should contain localized, human-readable,
key sequences as they would appear when displayed on screen. It must
be in the format "mnemonic;sequence;shortcut".
- The mnemonic key activates the object if it is presently enabled onscreen.
This typically corresponds to the underlined letter within the widget.
Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for
a button.
- The sequence is the full list of keys which invoke the action even if the
relevant element is not currently shown on screen. For instance, for a menu
item the sequence is the keybindings used to open the parent menus before
invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a
traditional "New..." menu item.
- The shortcut, if it exists, will invoke the same action without showing
the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a
traditional "New..." menu item.
Example: For a traditional "New..." menu item, the expected return value
would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N"
for the German locale. If, hypothetically, this menu item lacked a mnemonic,
it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.
If there is no key binding for this action, return "".
-->
<method name="GetKeyBinding">
<arg type="i" name="index" direction="in"/>
<arg type="s" direction="out"/>
</method>
<!--
GetActions:
Returns: an array of (localized_name, localized description, keybinding) for the
actions that an object supports. See the GetKeyBinding method for a description
of that field's syntax.
This is equivalent to using the methods GetLocalizedName, GetDescription,
GetKeyBinding for each action, but with a single call and thus less DBus traffic.
By convention, if there is more than one action available, the first one is
considered the "default" action of the object.
-->
<method name="GetActions">
<arg direction="out" type="a(sss)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiActionArray"/>
</method>
<!--
DoAction:
@index: 0-based index of the action to perform.
Performs the specified action on the object.
Returns: true on success, false otherwise.
-->
<method name="DoAction">
<arg direction="in" name="index" type="i"/>
<arg direction="out" type="b"/>
</method>
</interface>
</node>