diff options
| -rw-r--r-- | doc/ConsoleKit.xml.in | 10 | ||||
| -rw-r--r-- | doc/Makefile.am | 6 | ||||
| -rw-r--r-- | doc/ck-dbus-manager.xml | 52 | ||||
| -rw-r--r-- | doc/ck-dbus-seat.xml | 39 | ||||
| -rw-r--r-- | doc/ck-dbus-session.xml | 55 | ||||
| -rw-r--r-- | doc/docbook-dbus.xsl | 261 | ||||
| -rwxr-xr-x | doc/docize-dbus-xml.sh | 34 | ||||
| -rw-r--r-- | doc/ref-ck-manager.xml | 181 | ||||
| -rw-r--r-- | doc/ref-ck-seat.xml | 111 | ||||
| -rw-r--r-- | doc/ref-ck-session.xml | 262 | ||||
| -rw-r--r-- | src/ck-manager.xml | 12 | ||||
| -rw-r--r-- | src/ck-seat.xml | 12 | ||||
| -rw-r--r-- | src/ck-session.xml | 9 |
13 files changed, 884 insertions, 160 deletions
diff --git a/doc/ConsoleKit.xml.in b/doc/ConsoleKit.xml.in index 73834a1..fca0aa4 100644 --- a/doc/ConsoleKit.xml.in +++ b/doc/ConsoleKit.xml.in @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY dbus-Manager SYSTEM "./ck-dbus-manager.xml"> -<!ENTITY dbus-Seat SYSTEM "./ck-dbus-seat.xml"> -<!ENTITY dbus-Session SYSTEM "./ck-dbus-session.xml"> +<!ENTITY dbus-Manager SYSTEM "./ref-ck-manager.xml"> +<!ENTITY dbus-Seat SYSTEM "./ref-ck-seat.xml"> +<!ENTITY dbus-Session SYSTEM "./ref-ck-session.xml"> ]> <book id="index"> @@ -62,4 +62,8 @@ </reference> </part> + <index> + <title>Index</title> + </index> + </book> diff --git a/doc/Makefile.am b/doc/Makefile.am index 6f96464..c7ac22a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -3,9 +3,9 @@ NULL = SPEC_XML_FILES = \ ConsoleKit.xml \ ck-introduction.xml \ - ck-dbus-manager.xml \ - ck-dbus-seat.xml \ - ck-dbus-session.xml \ + ref-ck-manager.xml \ + ref-ck-seat.xml \ + ref-ck-session.xml \ $(NULL) if DOCBOOK_DOCS_ENABLED diff --git a/doc/ck-dbus-manager.xml b/doc/ck-dbus-manager.xml deleted file mode 100644 index 77577a5..0000000 --- a/doc/ck-dbus-manager.xml +++ /dev/null @@ -1,52 +0,0 @@ -<refentry id="ck-manager"> - <refmeta> - <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Manager</refentrytitle> - <manvolnum>1</manvolnum> - </refmeta> - - <refnamediv> - <refname>org.freedesktop.ConsoleKit.Manager</refname> - <refpurpose>Primary management interface</refpurpose> - </refnamediv> - - <refsynopsisdiv role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> - - Interface: - org.freedesktop.ConsoleKit.Manager - - Methods: - GetSeats (out OBJECT_PATH ARRAY seats) - GetSessionsForUser (in UINT32 uid, - out OBJECT_PATH ARRAY sessions) - GetCurrentSession (out OBJECT_PATH session) - GetSessionForUnixProcess (in UINT32 pid, - out OBJECT_PATH session) - GetSessionForCookie (in STRING cookie, - out OBJECT_PATH session) - GetSystemIdleHint (out BOOLEAN hint) - GetSystemIdleSinceHint (out STRING iso8601_datetime) - - OpenSession (out STRING cookie) - OpenSessionWithParameters (int STRING,VARIANT STRUCT ARRAY parameters, - out STRING cookie) - CloseSession (int STRING cookie, - out BOOLEAN result) - - Signals: - SeatAdded (STRING sid) - SeatRemoved (STRING sid) - SystemIdleHintChanged (BOOLEAN hint) - - </synopsis> - - </refsynopsisdiv> - - <refsect1 role="desc"> - <title role="desc.title">Description</title> - <para> - </para> - </refsect1> - -</refentry> diff --git a/doc/ck-dbus-seat.xml b/doc/ck-dbus-seat.xml deleted file mode 100644 index 738f6e2..0000000 --- a/doc/ck-dbus-seat.xml +++ /dev/null @@ -1,39 +0,0 @@ -<refentry id="ck-seat"> - <refmeta> - <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Seat</refentrytitle> - <manvolnum>2</manvolnum> - </refmeta> - - <refnamediv> - <refname>org.freedesktop.ConsoleKit.Seat</refname> - <refpurpose>Seat interface</refpurpose> - </refnamediv> - - <refsynopsisdiv role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> - - Interface: - org.freedesktop.ConsoleKit.Seat - - Methods: - GetId (out OBJECT_PATH sid) - ActivateSession (in OBJECT_PATH ssid) - GetActiveSession (out OBJECT_PATH ssid) - GetSessions (out OBJECT_PATH ARRAY sessions) - - Signals: - SessionAdded (STRING ssid) - SessionRemoved (STRING ssid) - ActiveSessionChanged (STRING ssid) - - </synopsis> - </refsynopsisdiv> - - <refsect1 role="desc"> - <title role="desc.title">Description</title> - <para> - </para> - </refsect1> - -</refentry> diff --git a/doc/ck-dbus-session.xml b/doc/ck-dbus-session.xml deleted file mode 100644 index 77181ec..0000000 --- a/doc/ck-dbus-session.xml +++ /dev/null @@ -1,55 +0,0 @@ -<refentry id="ck-session"> - <refmeta> - <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Session</refentrytitle> - <manvolnum>3</manvolnum> - </refmeta> - - <refnamediv> - <refname>org.freedesktop.ConsoleKit.Session</refname> - <refpurpose>Session interface</refpurpose> - </refnamediv> - - <refsynopsisdiv role="synopsis"> - <title role="synopsis.title">Synopsis</title> - <synopsis> - - Interface: - org.freedesktop.ConsoleKit.Session - - Methods: - GetId (out STRING ssid) - GetSeatId (out STRING sid) - GetUser (out INT32 uid) - GetIdleHint (out BOOLEAN hint) - SetIdleHint (in BOOLEAN hint) - GetIdleSinceHint (out STRING iso8601_datetime) - GetCreationTime (out STRING iso8601_datetime) - GetRemoteHostName (out STRING hostname) - GetDisplayDevice (out STRING device) - GetX11DisplayDevice (out STRING device) - GetX11Display (out STRING display) - GetSessionType (out STRING type) - IsLocal (out BOOLEAN local) - IsActive (out BOOLEAN active) - Unlock () - Lock () - Activate () - - Signals: - ActiveChanged (BOOLEAN active) - IdleHintChanged (BOOLEAN hint) - Unlock () - Lock () - - Properties: - - </synopsis> - </refsynopsisdiv> - - <refsect1 role="desc"> - <title role="desc.title">Description</title> - <para> - </para> - </refsect1> - -</refentry> diff --git a/doc/docbook-dbus.xsl b/doc/docbook-dbus.xsl new file mode 100644 index 0000000..56eada4 --- /dev/null +++ b/doc/docbook-dbus.xsl @@ -0,0 +1,261 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="1.0"> +<!-- + Convert D-Bus Glib xml into DocBook refentries + Copyright (C) 2007 William Jon McCann + License: GPL +--> +<xsl:output method="xml" indent="yes"/> + +<xsl:template match="/"> + +<xsl:variable name="interface" select="//interface/@name"/> +<xsl:variable name="basename"> + <xsl:call-template name="interface-basename"> + <xsl:with-param name="str" select="$interface"/> + </xsl:call-template> +</xsl:variable> + +<refentry><xsl:attribute name="id"><xsl:value-of select="$basename"/></xsl:attribute> + <refmeta> + <refentrytitle role="top_of_page"><xsl:value-of select="//interface/@name"/></refentrytitle> + </refmeta> + + <refnamediv> + <refname><xsl:value-of select="//interface/@name"/></refname> + <refpurpose><xsl:value-of select="$basename"/> interface</refpurpose> + </refnamediv> + + <refsynopsisdiv role="synopsis"> + <title role="synopsis.title">Methods</title> + <synopsis> + <xsl:call-template name="methods-synopsis"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </synopsis> + </refsynopsisdiv> + + <refsect1 role="signal_proto"> + <title role="signal_proto.title">Signals</title> + <synopsis> + <xsl:call-template name="signals-synopsis"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </synopsis> + </refsect1> + + <refsect1 role="impl_interfaces"> + <title role="impl_interfaces.title">Implemented Interfaces</title> + <para> + <xsl:value-of select="$interface"/> implements + org.freedesktop.DBus.Introspectable, + org.freedesktop.DBus.Properties + </para> + </refsect1> + + + <refsect1 role="properties"> + <title role="properties.title">Properties</title> + <synopsis> + <xsl:call-template name="properties-synopsis"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </synopsis> + </refsect1> + + <refsect1 role="desc"> + <title role="desc.title">Description</title> + <para> + </para> + </refsect1> + + + <refsect1 role="details"> + <title role="details.title">Details</title> + <xsl:call-template name="method-details"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </refsect1> + + <refsect1 role="signals"> + <title role="signals.title">Signal Details</title> + <xsl:call-template name="signal-details"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </refsect1> + + <refsect1 role="property_details"> + <title role="property_details.title">Property Details</title> + <xsl:call-template name="property-details"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </refsect1> + +</refentry> +</xsl:template> + + +<xsl:template name="property-details"> + <xsl:param name="basename"/> + <xsl:variable name="longest"> + <xsl:call-template name="find-longest"> + <xsl:with-param name="set" select="@name"/> + </xsl:call-template> + </xsl:variable> + <xsl:for-each select="///property"> + <refsect2> + <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>-property-<xsl:value-of select="@name"/></xsl:attribute></anchor>'<xsl:value-of select="@name"/>'</title> +<indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$basename"/></secondary><tertiary>property</tertiary></indexterm> +<programlisting>'<xsl:value-of select="@name"/>'<xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="2"/></xsl:call-template> +<xsl:call-template name="property-args"><xsl:with-param name="indent" select="string-length(@name) + 2"/></xsl:call-template></programlisting> + </refsect2> + </xsl:for-each> +</xsl:template> + + +<xsl:template name="signal-details"> + <xsl:param name="basename"/> + <xsl:variable name="longest"> + <xsl:call-template name="find-longest"> + <xsl:with-param name="set" select="@name"/> + </xsl:call-template> + </xsl:variable> + <xsl:for-each select="///signal"> + <refsect2> + <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>-signal-<xsl:value-of select="@name"/></xsl:attribute></anchor><xsl:value-of select="@name"/> ()</title> +<indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$basename"/></secondary><tertiary>signal</tertiary></indexterm> +<programlisting><xsl:value-of select="@name"/> (<xsl:call-template name="signal-args"><xsl:with-param name="indent" select="string-length(@name) + 2"/><xsl:with-param name="prefix" select="."/></xsl:call-template>)</programlisting> + </refsect2> + </xsl:for-each> +</xsl:template> + + +<xsl:template name="method-details"> + <xsl:param name="basename"/> + <xsl:variable name="longest"> + <xsl:call-template name="find-longest"> + <xsl:with-param name="set" select="@name"/> + </xsl:call-template> + </xsl:variable> + <xsl:for-each select="///method"> + <refsect2> + <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>-<xsl:value-of select="@name"/></xsl:attribute></anchor><xsl:value-of select="@name"/> ()</title> +<indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$basename"/></secondary><tertiary>method</tertiary></indexterm> +<programlisting><xsl:value-of select="@name"/> (<xsl:call-template name="method-args"><xsl:with-param name="indent" select="string-length(@name) + 2"/><xsl:with-param name="prefix" select="."/></xsl:call-template>)</programlisting> + </refsect2> + </xsl:for-each> +</xsl:template> + + +<xsl:template name="properties-synopsis"> + <xsl:param name="basename"/> + <xsl:variable name="longest"> + <xsl:call-template name="find-longest"> + <xsl:with-param name="set" select="///property/@name"/> + </xsl:call-template> + </xsl:variable> + <xsl:for-each select="///property"> +<link><xsl:attribute name="linkend"><xsl:value-of select="$basename"/>-property-<xsl:value-of select="@name"/></xsl:attribute>'<xsl:value-of select="@name"/>'</link><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@name) + 1"/></xsl:call-template> <xsl:call-template name="property-args"><xsl:with-param name="indent" select="$longest + 2"/></xsl:call-template> +</xsl:for-each> +</xsl:template> + + +<xsl:template name="signals-synopsis"> + <xsl:param name="basename"/> + <xsl:variable name="longest"> + <xsl:call-template name="find-longest"> + <xsl:with-param name="set" select="///signal/@name"/> + </xsl:call-template> + </xsl:variable> + <xsl:for-each select="///signal"> +<link><xsl:attribute name="linkend"><xsl:value-of select="$basename"/>-signal-<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></link><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@name) + 1"/></xsl:call-template>(<xsl:call-template name="signal-args"><xsl:with-param name="indent" select="$longest + 2"/><xsl:with-param name="prefix" select="///signal"/></xsl:call-template>) +</xsl:for-each> +</xsl:template> + + +<xsl:template name="methods-synopsis"> + <xsl:param name="basename"/> + <xsl:variable name="longest"> + <xsl:call-template name="find-longest"> + <xsl:with-param name="set" select="///method/@name"/> + </xsl:call-template> + </xsl:variable> + <xsl:for-each select="///method"> +<link><xsl:attribute name="linkend"><xsl:value-of select="$basename"/>-<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></link><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@name) + 1"/></xsl:call-template>(<xsl:call-template name="method-args"><xsl:with-param name="indent" select="$longest + 2"/><xsl:with-param name="prefix" select="///method"/></xsl:call-template>) +</xsl:for-each> +</xsl:template> + + +<xsl:template name="method-args"><xsl:param name="indent"/><xsl:param name="prefix"/><xsl:variable name="longest"><xsl:call-template name="find-longest"><xsl:with-param name="set" select="$prefix/arg/@type"/></xsl:call-template></xsl:variable><xsl:for-each select="arg"><xsl:value-of select="@direction"/> +<xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="4 - string-length(@direction)"/></xsl:call-template>'<xsl:value-of select="@type"/>'<xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@type) + 1"/></xsl:call-template> +<xsl:value-of select="@name"/><xsl:if test="not(position() = last())">, +<xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$indent"/></xsl:call-template></xsl:if> +</xsl:for-each> +</xsl:template> + + +<xsl:template name="signal-args"><xsl:param name="indent"/><xsl:param name="prefix"/><xsl:variable name="longest"><xsl:call-template name="find-longest"><xsl:with-param name="set" select="$prefix/arg/@type"/></xsl:call-template></xsl:variable><xsl:for-each select="arg">'<xsl:value-of select="@type"/>'<xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@type) + 1"/></xsl:call-template> +<xsl:value-of select="@name"/><xsl:if test="not(position() = last())">, +<xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$indent"/></xsl:call-template></xsl:if> +</xsl:for-each> +</xsl:template> + + +<xsl:template name="property-args"><xsl:param name="indent"/> +<xsl:value-of select="@access"/><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="9 - string-length(@access) + 1"/></xsl:call-template>'<xsl:value-of select="@type"/>' +</xsl:template> + + +<xsl:template name="pad-spaces"> + <xsl:param name="width"/> + <xsl:variable name="spaces" xml:space="preserve"> </xsl:variable> + <xsl:value-of select="substring($spaces,1,$width)"/> +</xsl:template> + + +<xsl:template name="find-longest"> + <xsl:param name="set"/> + <xsl:param name="index" select="1"/> + <xsl:param name="longest" select="0"/> + + <xsl:choose> + <xsl:when test="$index > count($set)"> + <!--finished looking--> + <xsl:value-of select="$longest"/> + </xsl:when> + <xsl:when test="string-length($set[$index])>$longest"> + <!--found new longest--> + <xsl:call-template name="find-longest"> + <xsl:with-param name="set" select="$set"/> + <xsl:with-param name="index" select="$index + 1"/> + <xsl:with-param name="longest" select="string-length($set[$index])"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <!--this isn't any longer--> + <xsl:call-template name="find-longest"> + <xsl:with-param name="set" select="$set"/> + <xsl:with-param name="index" select="$index + 1"/> + <xsl:with-param name="longest" select="$longest"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + +<xsl:template name="interface-basename"> + <xsl:param name="str"/> + <xsl:choose> + <xsl:when test="contains($str,'.')"> + <xsl:call-template name="interface-basename"> + <xsl:with-param name="str" select="substring-after($str,'.')"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$str"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +</xsl:stylesheet> diff --git a/doc/docize-dbus-xml.sh b/doc/docize-dbus-xml.sh new file mode 100755 index 0000000..1df63e1 --- /dev/null +++ b/doc/docize-dbus-xml.sh @@ -0,0 +1,34 @@ +#!/bin/sh + +DIST_BIN=`dirname "$0"` + +CMD=xsltproc +XSL=${DIST_BIN}/docbook-dbus.xsl + +if test "x$1" = "x" -o "x$1" = "x-h" -o "x$1" = "x--help"; then + echo "usage: $0 [file] ..." + exit 1 +fi + +if [ ! -r ${XSL} ]; then + echo "Cannot find XSLT file" + exit 1 +fi + +FILES="$@" +for FILE in $FILES; do + echo "${FILE}" | grep ".xml$" > /dev/null + if [ $? -ne 0 ]; then + echo "Skipping non-xml file: ${FILE}" + continue + fi + + d=`dirname ${FILE}` + b=`basename ${FILE} .xml` + + outfile="ref-${b}.xml" + echo "Creating: ${outfile}" + ${CMD} ${XSL} ${FILE} | tail -n +2 > ${outfile} +done + +exit 0 diff --git a/doc/ref-ck-manager.xml b/doc/ref-ck-manager.xml new file mode 100644 index 0000000..c2392f3 --- /dev/null +++ b/doc/ref-ck-manager.xml @@ -0,0 +1,181 @@ +<refentry id="Manager"> + <refmeta> + <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Manager</refentrytitle> + </refmeta> + <refnamediv> + <refname>org.freedesktop.ConsoleKit.Manager</refname> + <refpurpose>Manager interface</refpurpose> + </refnamediv> + <refsynopsisdiv role="synopsis"> + <title role="synopsis.title">Methods</title> + <synopsis><link linkend="Manager-OpenSession">OpenSession</link> (out 's' cookie) +<link linkend="Manager-OpenSessionWithParameters">OpenSessionWithParameters</link> (in 'a(sv)' parameters, + out 's' cookie) +<link linkend="Manager-CloseSession">CloseSession</link> (in 's' cookie, + out 'b' result) +<link linkend="Manager-GetSeats">GetSeats</link> (out 'ao' seats) +<link linkend="Manager-GetCurrentSession">GetCurrentSession</link> (out 'o' ssid) +<link linkend="Manager-GetSessionForCookie">GetSessionForCookie</link> (in 's' cookie, + out 'o' ssid) +<link linkend="Manager-GetSessionForUnixProcess">GetSessionForUnixProcess</link> (in 'u' pid, + out 'o' ssid) +<link linkend="Manager-GetSessionsForUser">GetSessionsForUser</link> (in 'u' uid, + out 'ao' sessions) +<link linkend="Manager-GetSystemIdleHint">GetSystemIdleHint</link> (out 'b' idle_hint) +<link linkend="Manager-GetSystemIdleSinceHint">GetSystemIdleSinceHint</link> (out 's' iso8601_datetime) +</synopsis> + </refsynopsisdiv> + <refsect1 role="signal_proto"> + <title role="signal_proto.title">Signals</title> + <synopsis><link linkend="Manager-signal-SeatAdded">SeatAdded</link> ('o' sid) +<link linkend="Manager-signal-SeatRemoved">SeatRemoved</link> ('o' sid) +<link linkend="Manager-signal-SystemIdleHintChanged">SystemIdleHintChanged</link> ('b' hint) +</synopsis> + </refsect1> + <refsect1 role="impl_interfaces"> + <title role="impl_interfaces.title">Implemented Interfaces</title> + <para>org.freedesktop.ConsoleKit.Manager implements + org.freedesktop.DBus.Introspectable, + org.freedesktop.DBus.Properties + </para> + </refsect1> + <refsect1 role="properties"> + <title role="properties.title">Properties</title> + <synopsis/> + </refsect1> + <refsect1 role="desc"> + <title role="desc.title">Description</title> + <para/> + </refsect1> + <refsect1 role="details"> + <title role="details.title">Details</title> + <refsect2> + <title><anchor role="function" id="Manager-OpenSession"/>OpenSession ()</title> + <indexterm> + <primary>OpenSession</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>OpenSession (out 's' cookie)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-OpenSessionWithParameters"/>OpenSessionWithParameters ()</title> + <indexterm> + <primary>OpenSessionWithParameters</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>OpenSessionWithParameters (in 'a(sv)' parameters, + out 's' cookie)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-CloseSession"/>CloseSession ()</title> + <indexterm> + <primary>CloseSession</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>CloseSession (in 's' cookie, + out 'b' result)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-GetSeats"/>GetSeats ()</title> + <indexterm> + <primary>GetSeats</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSeats (out 'ao' seats)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-GetCurrentSession"/>GetCurrentSession ()</title> + <indexterm> + <primary>GetCurrentSession</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetCurrentSession (out 'o' ssid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-GetSessionForCookie"/>GetSessionForCookie ()</title> + <indexterm> + <primary>GetSessionForCookie</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSessionForCookie (in 's' cookie, + out 'o' ssid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-GetSessionForUnixProcess"/>GetSessionForUnixProcess ()</title> + <indexterm> + <primary>GetSessionForUnixProcess</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSessionForUnixProcess (in 'u' pid, + out 'o' ssid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-GetSessionsForUser"/>GetSessionsForUser ()</title> + <indexterm> + <primary>GetSessionsForUser</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSessionsForUser (in 'u' uid, + out 'ao' sessions)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-GetSystemIdleHint"/>GetSystemIdleHint ()</title> + <indexterm> + <primary>GetSystemIdleHint</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSystemIdleHint (out 'b' idle_hint)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-GetSystemIdleSinceHint"/>GetSystemIdleSinceHint ()</title> + <indexterm> + <primary>GetSystemIdleSinceHint</primary> + <secondary>Manager</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSystemIdleSinceHint (out 's' iso8601_datetime)</programlisting> + </refsect2> + </refsect1> + <refsect1 role="signals"> + <title role="signals.title">Signal Details</title> + <refsect2> + <title><anchor role="function" id="Manager-signal-SeatAdded"/>SeatAdded ()</title> + <indexterm> + <primary>SeatAdded</primary> + <secondary>Manager</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>SeatAdded ('o' sid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-signal-SeatRemoved"/>SeatRemoved ()</title> + <indexterm> + <primary>SeatRemoved</primary> + <secondary>Manager</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>SeatRemoved ('o' sid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Manager-signal-SystemIdleHintChanged"/>SystemIdleHintChanged ()</title> + <indexterm> + <primary>SystemIdleHintChanged</primary> + <secondary>Manager</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>SystemIdleHintChanged ('b' hint)</programlisting> + </refsect2> + </refsect1> + <refsect1 role="property_details"> + <title role="property_details.title">Property Details</title> + </refsect1> +</refentry> diff --git a/doc/ref-ck-seat.xml b/doc/ref-ck-seat.xml new file mode 100644 index 0000000..a679d8e --- /dev/null +++ b/doc/ref-ck-seat.xml @@ -0,0 +1,111 @@ +<refentry id="Seat"> + <refmeta> + <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Seat</refentrytitle> + </refmeta> + <refnamediv> + <refname>org.freedesktop.ConsoleKit.Seat</refname> + <refpurpose>Seat interface</refpurpose> + </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> + </refsynopsisdiv> + <refsect1 role="signal_proto"> + <title role="signal_proto.title">Signals</title> + <synopsis><link linkend="Seat-signal-ActiveSessionChanged">ActiveSessionChanged</link> ('o' sid) +<link linkend="Seat-signal-SessionAdded">SessionAdded</link> ('o' sid) +<link linkend="Seat-signal-SessionRemoved">SessionRemoved</link> ('o' sid) +</synopsis> + </refsect1> + <refsect1 role="impl_interfaces"> + <title role="impl_interfaces.title">Implemented Interfaces</title> + <para>org.freedesktop.ConsoleKit.Seat implements + org.freedesktop.DBus.Introspectable, + org.freedesktop.DBus.Properties + </para> + </refsect1> + <refsect1 role="properties"> + <title role="properties.title">Properties</title> + <synopsis/> + </refsect1> + <refsect1 role="desc"> + <title role="desc.title">Description</title> + <para/> + </refsect1> + <refsect1 role="details"> + <title role="details.title">Details</title> + <refsect2> + <title><anchor role="function" id="Seat-GetId"/>GetId ()</title> + <indexterm> + <primary>GetId</primary> + <secondary>Seat</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetId (out 'o' sid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-GetSessions"/>GetSessions ()</title> + <indexterm> + <primary>GetSessions</primary> + <secondary>Seat</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSessions (out 'ao' sessions)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-GetActiveSession"/>GetActiveSession ()</title> + <indexterm> + <primary>GetActiveSession</primary> + <secondary>Seat</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetActiveSession (out 'o' ssid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-ActivateSession"/>ActivateSession ()</title> + <indexterm> + <primary>ActivateSession</primary> + <secondary>Seat</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>ActivateSession (in 'o' ssid)</programlisting> + </refsect2> + </refsect1> + <refsect1 role="signals"> + <title role="signals.title">Signal Details</title> + <refsect2> + <title><anchor role="function" id="Seat-signal-ActiveSessionChanged"/>ActiveSessionChanged ()</title> + <indexterm> + <primary>ActiveSessionChanged</primary> + <secondary>Seat</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>ActiveSessionChanged ('o' sid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-signal-SessionAdded"/>SessionAdded ()</title> + <indexterm> + <primary>SessionAdded</primary> + <secondary>Seat</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>SessionAdded ('o' sid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Seat-signal-SessionRemoved"/>SessionRemoved ()</title> + <indexterm> + <primary>SessionRemoved</primary> + <secondary>Seat</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>SessionRemoved ('o' sid)</programlisting> + </refsect2> + </refsect1> + <refsect1 role="property_details"> + <title role="property_details.title">Property Details</title> + </refsect1> +</refentry> diff --git a/doc/ref-ck-session.xml b/doc/ref-ck-session.xml new file mode 100644 index 0000000..bd165bc --- /dev/null +++ b/doc/ref-ck-session.xml @@ -0,0 +1,262 @@ +<refentry id="Session"> + <refmeta> + <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Session</refentrytitle> + </refmeta> + <refnamediv> + <refname>org.freedesktop.ConsoleKit.Session</refname> + <refpurpose>Session interface</refpurpose> + </refnamediv> + <refsynopsisdiv role="synopsis"> + <title role="synopsis.title">Methods</title> + <synopsis><link linkend="Session-GetId">GetId</link> (out 'o' ssid) +<link linkend="Session-GetSeatId">GetSeatId</link> (out 'o' sid) +<link linkend="Session-GetSessionType">GetSessionType</link> (out 's' type) +<link linkend="Session-GetUser">GetUser</link> (out 'i' uid) +<link linkend="Session-GetX11Display">GetX11Display</link> (out 's' display) +<link linkend="Session-GetX11DisplayDevice">GetX11DisplayDevice</link> (out 's' x11_display_device) +<link linkend="Session-GetDisplayDevice">GetDisplayDevice</link> (out 's' display_device) +<link linkend="Session-GetRemoteHostName">GetRemoteHostName</link> (out 's' remote_host_name) +<link linkend="Session-IsActive">IsActive</link> (out 'b' active) +<link linkend="Session-IsLocal">IsLocal</link> (out 'b' local) +<link linkend="Session-GetCreationTime">GetCreationTime</link> (out 's' iso8601_datetime) +<link linkend="Session-Activate">Activate</link> () +<link linkend="Session-Lock">Lock</link> () +<link linkend="Session-Unlock">Unlock</link> () +<link linkend="Session-GetIdleHint">GetIdleHint</link> (out 'b' idle_hint) +<link linkend="Session-GetIdleSinceHint">GetIdleSinceHint</link> (out 's' iso8601_datetime) +<link linkend="Session-SetIdleHint">SetIdleHint</link> (in 'b' idle_hint) +</synopsis> + </refsynopsisdiv> + <refsect1 role="signal_proto"> + <title role="signal_proto.title">Signals</title> + <synopsis><link linkend="Session-signal-ActiveChanged">ActiveChanged</link> ('b' is_active) +<link linkend="Session-signal-IdleHintChanged">IdleHintChanged</link> ('b' hint) +<link linkend="Session-signal-Lock">Lock</link> () +<link linkend="Session-signal-Unlock">Unlock</link> () +</synopsis> + </refsect1> + <refsect1 role="impl_interfaces"> + <title role="impl_interfaces.title">Implemented Interfaces</title> + <para>org.freedesktop.ConsoleKit.Session implements + org.freedesktop.DBus.Introspectable, + org.freedesktop.DBus.Properties + </para> + </refsect1> + <refsect1 role="properties"> + <title role="properties.title">Properties</title> + <synopsis><link linkend="Session-property-is-local">'is-local'</link> read 'b' +</synopsis> + </refsect1> + <refsect1 role="desc"> + <title role="desc.title">Description</title> + <para/> + </refsect1> + <refsect1 role="details"> + <title role="details.title">Details</title> + <refsect2> + <title><anchor role="function" id="Session-GetId"/>GetId ()</title> + <indexterm> + <primary>GetId</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetId (out 'o' ssid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetSeatId"/>GetSeatId ()</title> + <indexterm> + <primary>GetSeatId</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSeatId (out 'o' sid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetSessionType"/>GetSessionType ()</title> + <indexterm> + <primary>GetSessionType</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetSessionType (out 's' type)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetUser"/>GetUser ()</title> + <indexterm> + <primary>GetUser</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetUser (out 'i' uid)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetX11Display"/>GetX11Display ()</title> + <indexterm> + <primary>GetX11Display</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetX11Display (out 's' display)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetX11DisplayDevice"/>GetX11DisplayDevice ()</title> + <indexterm> + <primary>GetX11DisplayDevice</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetX11DisplayDevice (out 's' x11_display_device)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetDisplayDevice"/>GetDisplayDevice ()</title> + <indexterm> + <primary>GetDisplayDevice</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetDisplayDevice (out 's' display_device)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetRemoteHostName"/>GetRemoteHostName ()</title> + <indexterm> + <primary>GetRemoteHostName</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetRemoteHostName (out 's' remote_host_name)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-IsActive"/>IsActive ()</title> + <indexterm> + <primary>IsActive</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>IsActive (out 'b' active)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-IsLocal"/>IsLocal ()</title> + <indexterm> + <primary>IsLocal</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>IsLocal (out 'b' local)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetCreationTime"/>GetCreationTime ()</title> + <indexterm> + <primary>GetCreationTime</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetCreationTime (out 's' iso8601_datetime)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-Activate"/>Activate ()</title> + <indexterm> + <primary>Activate</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>Activate ()</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-Lock"/>Lock ()</title> + <indexterm> + <primary>Lock</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>Lock ()</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-Unlock"/>Unlock ()</title> + <indexterm> + <primary>Unlock</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>Unlock ()</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetIdleHint"/>GetIdleHint ()</title> + <indexterm> + <primary>GetIdleHint</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetIdleHint (out 'b' idle_hint)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-GetIdleSinceHint"/>GetIdleSinceHint ()</title> + <indexterm> + <primary>GetIdleSinceHint</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>GetIdleSinceHint (out 's' iso8601_datetime)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-SetIdleHint"/>SetIdleHint ()</title> + <indexterm> + <primary>SetIdleHint</primary> + <secondary>Session</secondary> + <tertiary>method</tertiary> + </indexterm> + <programlisting>SetIdleHint (in 'b' idle_hint)</programlisting> + </refsect2> + </refsect1> + <refsect1 role="signals"> + <title role="signals.title">Signal Details</title> + <refsect2> + <title><anchor role="function" id="Session-signal-ActiveChanged"/>ActiveChanged ()</title> + <indexterm> + <primary>ActiveChanged</primary> + <secondary>Session</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>ActiveChanged ('b' is_active)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-signal-IdleHintChanged"/>IdleHintChanged ()</title> + <indexterm> + <primary>IdleHintChanged</primary> + <secondary>Session</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>IdleHintChanged ('b' hint)</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-signal-Lock"/>Lock ()</title> + <indexterm> + <primary>Lock</primary> + <secondary>Session</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>Lock ()</programlisting> + </refsect2> + <refsect2> + <title><anchor role="function" id="Session-signal-Unlock"/>Unlock ()</title> + <indexterm> + <primary>Unlock</primary> + <secondary>Session</secondary> + <tertiary>signal</tertiary> + </indexterm> + <programlisting>Unlock ()</programlisting> + </refsect2> + </refsect1> + <refsect1 role="property_details"> + <title role="property_details.title">Property Details</title> + <refsect2> + <title><anchor role="function" id="Session-property-is-local"/>'is-local'</title> + <indexterm> + <primary>is-local</primary> + <secondary>Session</secondary> + <tertiary>property</tertiary> + </indexterm> + <programlisting>'is-local' read 'b' +</programlisting> + </refsect2> + </refsect1> +</refentry> diff --git a/src/ck-manager.xml b/src/ck-manager.xml index 6eadd11..ced06b0 100644 --- a/src/ck-manager.xml +++ b/src/ck-manager.xml @@ -49,8 +49,14 @@ <arg name="iso8601_datetime" type="s" direction="out"/> </method> - <signal name="SeatAdded"/> - <signal name="SeatRemoved"/> - <signal name="SystemIdleHintChanged"/> + <signal name="SeatAdded"> + <arg name="sid" type="o"/> + </signal> + <signal name="SeatRemoved"> + <arg name="sid" type="o"/> + </signal> + <signal name="SystemIdleHintChanged"> + <arg name="hint" type="b"/> + </signal> </interface> </node> diff --git a/src/ck-seat.xml b/src/ck-seat.xml index 9a32e57..3e7a0fa 100644 --- a/src/ck-seat.xml +++ b/src/ck-seat.xml @@ -20,8 +20,14 @@ <arg name="ssid" direction="in" type="o"/> </method> - <signal name="ActiveSessionChanged"/> - <signal name="SessionAdded"/> - <signal name="SessionRemoved"/> + <signal name="ActiveSessionChanged"> + <arg name="sid" type="o"/> + </signal> + <signal name="SessionAdded"> + <arg name="sid" type="o"/> + </signal> + <signal name="SessionRemoved"> + <arg name="sid" type="o"/> + </signal> </interface> </node> diff --git a/src/ck-session.xml b/src/ck-session.xml index 0c90fb1..c40e8f2 100644 --- a/src/ck-session.xml +++ b/src/ck-session.xml @@ -58,11 +58,16 @@ <arg name="idle_hint" type="b" direction="in"/> </method> - <signal name="ActiveChanged"/> + <signal name="ActiveChanged"> + <arg name="is_active" type="b"/> + </signal> + <signal name="IdleHintChanged"> + <arg name="hint" type="b"/> + </signal> <signal name="Lock"/> <signal name="Unlock"/> - <signal name="IdleHintChanged"/> + <property name="is-local" access="read" type="b"/> </interface> </node> |