File: Registry.xml

package info (click to toggle)
at-spi2-core 2.59.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,220 kB
  • sloc: ansic: 45,031; xml: 1,505; python: 384; sh: 239; makefile: 31; javascript: 13
file content (124 lines) | stat: -rw-r--r-- 4,847 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
  <!--
      org.a11y.atspi.Registry:
      @short_description: Interface implemented by the AT-SPI registry daemon.

      The registry daemon listens on org.a11y.atspi.Registry and exposes an
      object at /org/a11y/atspi/registry that implements this interface.
  -->
  <interface name="org.a11y.atspi.Registry">

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

    <!--
        RegisterEvent:

        @event_type: a character string indicating the type of events for which
        notification is requested.  Format is
        EventClass:major_type:minor_type:detail
        where all subfields other than EventClass are optional.
        EventClasses include "object", "window", "mouse",
        and toolkit events (e.g. "Gtk", "AWT").
        Examples: "focus:", "Gtk:GtkWidget:button_press_event".

        @properties: A list of properties that applications should pass
        when sending the event specified in @event_type. This is intended
        to allow an AT to proactively request the information that it is
        interested in and minimize the need to make additional queries in
        response to the event. This is currently unimplemented; the
        specification would need to be fleshed out here.

        @app_bus_name: The application that this request pertains to.
        This allows an app to indicate that it is interested in a
        particular event only for a certain application. If this string is
        empty, then this registration applies to all applications.

        This method is to be called by an AT to indicate that it is
        interested in receiving a particular event from applications.
        Applications can optionally call GetRegisteredEvents and listen for
        EventListenerRewgistered and EventListenerDeregistered signals and,
        in this way, only send events that an AT is interested in receiving.
    -->
    <method name="RegisterEvent">
      <arg direction="in" name="event" type="s"/>
      <arg direction="in" name="properties" type="as"/>
      <arg direction="in" name="app_bus_name" type="s"/>
    </method>

    <!--
        DeregisterEvent:

        @event_type: A character string indicating the event to be
        deregistered. See RegisterEvent for a description of the format of
        this string.

        Indicates that an AT is no longer interested in listening to a
        particular event.
        TODO: Add app_bus_name here.
    -->
    <method name="DeregisterEvent">
      <arg direction="in" name="event" type="s"/>
    </method>

    <!--
        GetRegisteredEvents:

        @events: A dictionary listing the registered events. For each entry,
        the first string gives the bus name of the AT holding the
        registration. The second string gives the event. See RegisterEvent
        for a description of the format of this string.
    -->
    <method name="GetRegisteredEvents">
      <arg direction="out" name="events" type="a(ss)"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiEventListenerArray"/>
    </method>

    <!--
        EventListenerRegistered:

        @bus: The bus name of the AT registering the event.

        @event: The event being registered. See RegisterEvent for a
        description of the format of this string.

        @properties: An array of properties that the AT is interested in
        receiving along with the event. Currently unimplemented; the
        specification for this would need to be fleshed out.

        Indicates that an AT has requested to listen for an event.
        Applications can optionally listen to this signal to maintain a
        list of events that ATs are interested in receiving and only send
        events when needed.
    -->
    <signal name="EventListenerRegistered">
      <arg name="bus" type="s"/>
      <arg name="event" type="s"/>
      <arg name="properties" type="as"/>
    </signal>

    <!--
        EventListenerDeregistered:

        @bus: The bus name of the AT registering the event.

        @event: The event being deregistered. See RegisterEvent for a
        description of the format of this string.

        Indicates that an AT is no longer interested in listening for an
        event. Applications can optionally listen to this signal to maintain
        a list of events that ATs are interested in receiving and only send
        events when needed.
    -->
    <signal name="EventListenerDeregistered">
      <arg name="bus" type="s"/>
      <arg name="event" type="s"/>
    </signal>
  </interface>
</node>