← Back to branch summary

~cjcurran/indicator-session/beta-fixes

« back to all changes in this revision

Viewing changes to src/org.freedesktop.ConsoleKit.Seat.xml

  • Committer: Conor Curran
  • Date: 2011-08-18 14:24:01 UTC
  • mfrom: (175.2.5 indicator-session)
  • Revision ID: conor.curran@canonical.com-20110818142401-cjibgli3b181oy89
merge in the big fix branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/org.freedesktop.ConsoleKit.Seat.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
 
3
 
 
4
  <interface name="org.freedesktop.ConsoleKit.Seat">
 
5
    <doc:doc>
 
6
      <doc:description>
 
7
        <doc:para>A seat is a collection of sessions and a set of hardware (usually at
 
8
least a keyboard and mouse).  Only one session may be active on a
 
9
seat at a time.</doc:para>
 
10
      </doc:description>
 
11
    </doc:doc>
 
12
 
 
13
    <method name="GetId">
 
14
      <arg name="sid" direction="out" type="o">
 
15
        <doc:doc>
 
16
          <doc:summary>Seat ID</doc:summary>
 
17
        </doc:doc>
 
18
      </arg>
 
19
      <doc:doc>
 
20
        <doc:description>
 
21
          <doc:para>Returns the ID for Seat.</doc:para>
 
22
        </doc:description>
 
23
      </doc:doc>
 
24
    </method>
 
25
 
 
26
    <method name="GetSessions">
 
27
      <arg name="sessions" direction="out" type="ao">
 
28
        <doc:doc>
 
29
          <doc:summary>an array of Session IDs</doc:summary>
 
30
        </doc:doc>
 
31
      </arg>
 
32
      <doc:doc>
 
33
        <doc:description>
 
34
          <doc:para>This gets a list of all the <doc:ref type="interface" to="Session">Sessions</doc:ref>
 
35
          that are currently attached to this seat.</doc:para>
 
36
          <doc:para>Each Session ID is an D-Bus object path for the object that implements the
 
37
          <doc:ref type="interface" to="Session">Session</doc:ref> interface.</doc:para>
 
38
        </doc:description>
 
39
      </doc:doc>
 
40
    </method>
 
41
 
 
42
    <method name="GetDevices">
 
43
      <arg name="devices" direction="out" type="a(ss)">
 
44
        <doc:doc>
 
45
          <doc:summary>an array of devices</doc:summary>
 
46
        </doc:doc>
 
47
      </arg>
 
48
      <doc:doc>
 
49
        <doc:description>
 
50
          <doc:para>This gets a list of all the devices
 
51
          that are currently associated with this seat.</doc:para>
 
52
          <doc:para>Each device is an D-Bus structure that represents
 
53
          the device type and the device id.
 
54
          </doc:para>
 
55
        </doc:description>
 
56
      </doc:doc>
 
57
    </method>
 
58
 
 
59
    <method name="GetActiveSession">
 
60
      <arg name="ssid" direction="out" type="o">
 
61
        <doc:doc>
 
62
          <doc:summary>Session ID</doc:summary>
 
63
        </doc:doc>
 
64
      </arg>
 
65
      <doc:doc>
 
66
        <doc:description>
 
67
          <doc:para>Gets the Session ID that is currently active on this Seat.</doc:para>
 
68
          <doc:para>Returns NULL if there is no active session.</doc:para>
 
69
        </doc:description>
 
70
      </doc:doc>
 
71
    </method>
 
72
 
 
73
    <method name="CanActivateSessions">
 
74
      <arg name="can_activate" direction="out" type="b">
 
75
        <doc:doc>
 
76
          <doc:summary>TRUE if seat supports session activation</doc:summary>
 
77
        </doc:doc>
 
78
      </arg>
 
79
      <doc:doc>
 
80
        <doc:description><doc:para>Used to determine whether the seat supports session activation.</doc:para>
 
81
        </doc:description>
 
82
      </doc:doc>
 
83
    </method>
 
84
 
 
85
    <method name="ActivateSession">
 
86
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
87
      <arg name="ssid" direction="in" type="o">
 
88
        <doc:doc>
 
89
          <doc:summary>Session ID</doc:summary>
 
90
        </doc:doc>
 
91
      </arg>
 
92
      <doc:doc>
 
93
        <doc:description>
 
94
          <doc:para>Attempt to activate the specified session.  In most
 
95
          cases, if successful, this will cause the session to
 
96
          become visible and take control of the hardware that is
 
97
          associated with this seat.</doc:para>
 
98
        </doc:description>
 
99
        <doc:seealso><doc:ref type="method" to="Session.Activate">Activate()</doc:ref></doc:seealso>
 
100
      </doc:doc>
 
101
    </method>
 
102
 
 
103
    <signal name="ActiveSessionChanged">
 
104
      <arg name="ssid" type="o">
 
105
        <doc:doc>
 
106
          <doc:summary>Session ID</doc:summary>
 
107
        </doc:doc>
 
108
      </arg>
 
109
      <doc:doc>
 
110
        <doc:description>
 
111
          <doc:para>Emitted when the active session has changed.</doc:para>
 
112
        </doc:description>
 
113
      </doc:doc>
 
114
    </signal>
 
115
    <signal name="SessionAdded">
 
116
      <arg name="ssid" type="o">
 
117
        <doc:doc>
 
118
          <doc:summary>Session ID</doc:summary>
 
119
        </doc:doc>
 
120
      </arg>
 
121
      <doc:doc>
 
122
        <doc:description>
 
123
          <doc:para>Emitted when a session has been added to the seat.</doc:para>
 
124
        </doc:description>
 
125
      </doc:doc>
 
126
    </signal>
 
127
    <signal name="SessionRemoved">
 
128
      <arg name="ssid" type="o">
 
129
        <doc:doc>
 
130
          <doc:summary>Session ID</doc:summary>
 
131
        </doc:doc>
 
132
      </arg>
 
133
      <doc:doc>
 
134
        <doc:description>
 
135
          <doc:para>Emitted when a session has been removed from the seat.</doc:para>
 
136
        </doc:description>
 
137
      </doc:doc>
 
138
    </signal>
 
139
    <signal name="DeviceAdded">
 
140
      <arg name="device" type="(ss)">
 
141
        <doc:doc>
 
142
          <doc:summary>Device structure</doc:summary>
 
143
        </doc:doc>
 
144
      </arg>
 
145
      <doc:doc>
 
146
        <doc:description>
 
147
          <doc:para>Emitted when a device has been associated with the seat.</doc:para>
 
148
        </doc:description>
 
149
      </doc:doc>
 
150
    </signal>
 
151
    <signal name="DeviceRemoved">
 
152
      <arg name="device" type="(ss)">
 
153
        <doc:doc>
 
154
          <doc:summary>Device structure</doc:summary>
 
155
        </doc:doc>
 
156
      </arg>
 
157
      <doc:doc>
 
158
        <doc:description>
 
159
          <doc:para>Emitted when a device has been dissociated from the seat.</doc:para>
 
160
        </doc:description>
 
161
      </doc:doc>
 
162
    </signal>
 
163
  </interface>
 
164
</node>