summaryrefslogtreecommitdiff
path: root/src/libaccountsservice/org.freedesktop.ConsoleKit.Seat.xml
blob: d95990bc71818a9638b6b2e4df1e36972c76e08c (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
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">

  <interface name="org.freedesktop.ConsoleKit.Seat">
    <doc:doc>
      <doc:description>
        <doc:para>A seat is a collection of sessions and a set of hardware (usually at
least a keyboard and mouse).  Only one session may be active on a
seat at a time.</doc:para>
      </doc:description>
    </doc:doc>

    <method name="GetId">
      <arg name="sid" direction="out" type="o">
        <doc:doc>
          <doc:summary>Seat ID</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>Returns the ID for Seat.</doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <method name="GetSessions">
      <arg name="sessions" direction="out" type="ao">
        <doc:doc>
          <doc:summary>an array of Session IDs</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>This gets a list of all the <doc:ref type="interface" to="Session">Sessions</doc:ref>
          that are currently attached to this seat.</doc:para>
          <doc:para>Each Session ID is an D-Bus object path for the object that implements the
          <doc:ref type="interface" to="Session">Session</doc:ref> interface.</doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <method name="GetDevices">
      <arg name="devices" direction="out" type="a(ss)">
        <doc:doc>
          <doc:summary>an array of devices</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>This gets a list of all the devices
          that are currently associated with this seat.</doc:para>
          <doc:para>Each device is an D-Bus structure that represents
          the device type and the device id.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <method name="GetActiveSession">
      <arg name="ssid" direction="out" type="o">
        <doc:doc>
          <doc:summary>Session ID</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>Gets the Session ID that is currently active on this Seat.</doc:para>
          <doc:para>Returns NULL if there is no active session.</doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <method name="CanActivateSessions">
      <arg name="can_activate" direction="out" type="b">
        <doc:doc>
          <doc:summary>TRUE if seat supports session activation</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description><doc:para>Used to determine whether the seat supports session activation.</doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <method name="ActivateSession">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="ssid" direction="in" type="o">
        <doc:doc>
          <doc:summary>Session ID</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>Attempt to activate the specified session.  In most
          cases, if successful, this will cause the session to
          become visible and take control of the hardware that is
          associated with this seat.</doc:para>
        </doc:description>
        <doc:seealso><doc:ref type="method" to="Session.Activate">Activate()</doc:ref></doc:seealso>
      </doc:doc>
    </method>

    <signal name="ActiveSessionChanged">
      <arg name="ssid" type="o">
        <doc:doc>
          <doc:summary>Session ID</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>Emitted when the active session has changed.</doc:para>
        </doc:description>
      </doc:doc>
    </signal>
    <signal name="SessionAdded">
      <arg name="ssid" type="o">
        <doc:doc>
          <doc:summary>Session ID</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>Emitted when a session has been added to the seat.</doc:para>
        </doc:description>
      </doc:doc>
    </signal>
    <signal name="SessionRemoved">
      <arg name="ssid" type="o">
        <doc:doc>
          <doc:summary>Session ID</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>Emitted when a session has been removed from the seat.</doc:para>
        </doc:description>
      </doc:doc>
    </signal>
    <signal name="DeviceAdded">
      <arg name="device" type="(ss)">
        <doc:doc>
          <doc:summary>Device structure</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>Emitted when a device has been associated with the seat.</doc:para>
        </doc:description>
      </doc:doc>
    </signal>
    <signal name="DeviceRemoved">
      <arg name="device" type="(ss)">
        <doc:doc>
          <doc:summary>Device structure</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>Emitted when a device has been dissociated from the seat.</doc:para>
        </doc:description>
      </doc:doc>
    </signal>
  </interface>
</node>