File: Action.xml

package info (click to toggle)
at-spi2-core 2.59.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,212 kB
  • sloc: ansic: 45,028; xml: 1,505; python: 384; sh: 239; makefile: 29; javascript: 13
file content (136 lines) | stat: -rw-r--r-- 5,255 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?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">

    <!--
        Version: The version of this interface.

        This property is incremented by one every time a new method, signal, or property
        is added to this interface.
    -->
    <property name="version" type="u" access="read"/>

    <!--
        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>