summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWilliam Jon McCann <mccann@jhu.edu>2007-03-19 16:35:55 -0400
committerWilliam Jon McCann <mccann@jhu.edu>2007-03-19 16:35:55 -0400
commit4c365a8e28adafd6619ada97d4239e9e6df429ab (patch)
tree07747bdf4b591fffdf753ab7242d8cfbd13f5b02 /doc
parentc40a87c622ac1543dc2d9cdccc651e33affadcfa (diff)
add CanActivateSessions to Seat interface
And associated documentation and added to test-fus.
Diffstat (limited to 'doc')
-rw-r--r--doc/spec/ck-seat.xml12
-rw-r--r--doc/xml/ck-design.xml9
-rw-r--r--doc/xml/ref-ck-seat.xml12
3 files changed, 28 insertions, 5 deletions
diff --git a/doc/spec/ck-seat.xml b/doc/spec/ck-seat.xml
index 81fb1cc..1d154e7 100644
--- a/doc/spec/ck-seat.xml
+++ b/doc/spec/ck-seat.xml
@@ -52,6 +52,18 @@ seat at a time.</doc:para>
</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>Used to determine whether the seat supports session activation.
+ </doc:description>
+ </doc:doc>
+ </method>
+
<method name="ActivateSession">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="ssid" direction="in" type="o">
diff --git a/doc/xml/ck-design.xml b/doc/xml/ck-design.xml
index 086795c..1148773 100644
--- a/doc/xml/ck-design.xml
+++ b/doc/xml/ck-design.xml
@@ -61,6 +61,9 @@ The Session will remain open until the Session Leader disconnects from the D-Bus
To determine which Seat it is running on.
</listitem>
<listitem>
+ To know if the current seat supports session switching.
+ </listitem>
+ <listitem>
A list of all sessions on the current Seat.
</listitem>
<listitem>
@@ -121,6 +124,12 @@ The Session will remain open until the Session Leader disconnects from the D-Bus
To determine which session it is running in.
</listitem>
<listitem>
+ To determine which Seat it is running on.
+ </listitem>
+ <listitem>
+ To know if the current seat supports session switching.
+ </listitem>
+ <listitem>
A list of all sessions on the current Seat.
</listitem>
<listitem>
diff --git a/doc/xml/ref-ck-seat.xml b/doc/xml/ref-ck-seat.xml
index 6161207..03f4176 100644
--- a/doc/xml/ref-ck-seat.xml
+++ b/doc/xml/ref-ck-seat.xml
@@ -8,10 +8,11 @@
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Methods</title>
- <synopsis><link linkend="Seat.GetId">GetId</link> (out 'o' sid)
-<link linkend="Seat.GetSessions">GetSessions</link> (out 'ao' sessions)
-<link linkend="Seat.GetActiveSession">GetActiveSession</link> (out 'o' ssid)
-<link linkend="Seat.ActivateSession">ActivateSession</link> (in 'o' ssid)
+ <synopsis><link linkend="Seat.GetId">GetId</link> (out 'o' sid)
+<link linkend="Seat.GetSessions">GetSessions</link> (out 'ao' sessions)
+<link linkend="Seat.GetActiveSession">GetActiveSession</link> (out 'o' ssid)
+<link linkend="Seat.CanActivateSessions">CanActivateSessions</link> (out 'b' can_activate)
+<link linkend="Seat.ActivateSession">ActivateSession</link> (in 'o' ssid)
</synopsis>
</refsynopsisdiv>
<refsect1 role="signal_proto">
@@ -51,7 +52,8 @@ seat at a time.</para>
<variablelist role="params"><varlistentry><term><parameter>sessions</parameter>:</term><listitem><simpara>an array of Session IDs</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat.GetActiveSession"/>GetActiveSession ()</title><indexterm><primary>GetActiveSession</primary><secondary>Seat</secondary></indexterm><programlisting>GetActiveSession (out 'o' ssid)</programlisting></refsect2>
<para>Gets the Session ID that is currently active on this Seat.</para>
<para>Returns NULL if there is no active session.</para>
- <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat.ActivateSession"/>ActivateSession ()</title><indexterm><primary>ActivateSession</primary><secondary>Seat</secondary></indexterm><programlisting>ActivateSession (in 'o' ssid)</programlisting></refsect2>
+ <variablelist role="params"><varlistentry><term><parameter>ssid</parameter>:</term><listitem><simpara>Session ID</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat.CanActivateSessions"/>CanActivateSessions ()</title><indexterm><primary>CanActivateSessions</primary><secondary>Seat</secondary></indexterm><programlisting>CanActivateSessions (out 'b' can_activate)</programlisting></refsect2>Used to determine whether the seat supports session activation.
+ <variablelist role="params"><varlistentry><term><parameter>can_activate</parameter>:</term><listitem><simpara>TRUE if seat supports session activation</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="Seat.ActivateSession"/>ActivateSession ()</title><indexterm><primary>ActivateSession</primary><secondary>Seat</secondary></indexterm><programlisting>ActivateSession (in 'o' ssid)</programlisting></refsect2>
<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