summaryrefslogtreecommitdiff
path: root/xml/Socket.xml
blob: a1d19754fc983671a3fc5a1e45ccb67df66fd907 (plain)
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
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
  <!--
      org.a11y.atspi.Socket:
      @short_description: Interface to register an application on the registry.
  -->
  <interface name="org.a11y.atspi.Socket">

    <!--
        Embed:
        @plug: a string for the unique bus name of the application, and an object path
        for the application's' root object.

        This is the entry point for an application that wants to register itself against
        the accessibility registry.  The application's root object, which it passes in
        @plug, must support the org.a11y.atspi.Application interface.

        When an application calls this method on the registry, the following handshake happens:

        * Application calls this method on the registry to identify itself.

        * The registry sets the "Id" property on the org.a11y.atspi.Application interface on the @plug object.

        * The Embed method returns with the bus name and object path for the registry's root object.

        Returns: the bus name and object path of the registry's root object.
    -->
    <method name="Embed">
      <arg direction="in" name="plug" type="(so)"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QSpiObjectReference"/>
      <arg direction="out" name="socket" type="(so)"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiObjectReference"/>
    </method>

    <!--
        Unembed:
        @plug: a string for the unique bus name of the application, and an object path
        for the application's' root object.

        Unregisters an application from the accesibility registry.  It is not necessary to
        call this method; the accessibility registry detects when an application
        disconnects from the bus.
    -->
    <method name="Unembed">
      <arg direction="in" name="plug" type="(so)"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QSpiObjectReference"/>
    </method>

    <!--
        Available:
        @socket: application and object path for the registry's root object.

        The accessibility registry emits this signal early during startup, when it has
        registered with the DBus daemon and is available for calls from applications.
    -->
    <signal name="Available">
      <arg name="socket" type="(so)"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QSpiObjectReference"/>
    </signal>

  </interface>
</node>