gnome-session r4865 - in branches/dbus_based: . doc/dbus gnome-session

[mccann svn gnome org]

Author: mccann
Date: Mon Jul 28 15:39:10 2008
New Revision: 4865
URL: http://svn.gnome.org/viewvc/gnome-session?rev=4865&view=rev

Log:
2008-07-28  William Jon McCann  <jmccann redhat com>

	* doc/dbus/Makefile.am:
	* doc/dbus/gnome-session.xml.in:
	* gnome-session/gsm-inhibitor.xml:
	Add docs for inhibitors.



Modified:
   branches/dbus_based/ChangeLog
   branches/dbus_based/doc/dbus/Makefile.am
   branches/dbus_based/doc/dbus/gnome-session.xml.in
   branches/dbus_based/gnome-session/gsm-inhibitor.xml

Modified: branches/dbus_based/doc/dbus/Makefile.am
==============================================================================
--- branches/dbus_based/doc/dbus/Makefile.am	(original)
+++ branches/dbus_based/doc/dbus/Makefile.am	Mon Jul 28 15:39:10 2008
@@ -5,6 +5,7 @@
 	org.gnome.SessionManager.ref.xml \
 	org.gnome.SessionManager.Client.ref.xml \
 	org.gnome.SessionManager.DBusClient.ref.xml \
+	org.gnome.SessionManager.Inhibitor.ref.xml \
 	$(NULL)
 
 if DOCBOOK_DOCS_ENABLED
@@ -17,7 +18,7 @@
 
 endif # DOCBOOK_DOCS_ENABLED
 
-all : org.gnome.SessionManager.ref.xml org.gnome.SessionManager.Client.ref.xml org.gnome.SessionManager.DBusClient.ref.xml
+all : org.gnome.SessionManager.ref.xml org.gnome.SessionManager.Client.ref.xml org.gnome.SessionManager.DBusClient.ref.xml org.gnome.SessionManager.Inhibitor.ref.xml
 
 org.gnome.SessionManager.ref.xml : $(top_srcdir)/gnome-session/gsm-manager.xml spec-to-docbook.xsl
 	$(XSLTPROC) $(top_srcdir)/doc/dbus/spec-to-docbook.xsl $< | tail -n +2 >> $@
@@ -25,6 +26,8 @@
 	$(XSLTPROC) $(top_srcdir)/doc/dbus/spec-to-docbook.xsl $< | tail -n +2 >> $@
 org.gnome.SessionManager.DBusClient.ref.xml : $(top_srcdir)/gnome-session/gsm-dbus-client.xml spec-to-docbook.xsl
 	$(XSLTPROC) $(top_srcdir)/doc/dbus/spec-to-docbook.xsl $< | tail -n +2 >> $@
+org.gnome.SessionManager.Inhibitor.ref.xml : $(top_srcdir)/gnome-session/gsm-inhibitor.xml spec-to-docbook.xsl
+	$(XSLTPROC) $(top_srcdir)/doc/dbus/spec-to-docbook.xsl $< | tail -n +2 >> $@
 
 EXTRA_DIST =				\
 	spec-to-docbook.xsl		\

Modified: branches/dbus_based/doc/dbus/gnome-session.xml.in
==============================================================================
--- branches/dbus_based/doc/dbus/gnome-session.xml.in	(original)
+++ branches/dbus_based/doc/dbus/gnome-session.xml.in	Mon Jul 28 15:39:10 2008
@@ -3,6 +3,7 @@
 <!ENTITY dbus-Manager SYSTEM "org.gnome.SessionManager.ref.xml">
 <!ENTITY dbus-Client SYSTEM "org.gnome.SessionManager.Client.ref.xml">
 <!ENTITY dbus-DBusClient SYSTEM "org.gnome.SessionManager.DBusClient.ref.xml">
+<!ENTITY dbus-Inhibitor SYSTEM "org.gnome.SessionManager.Inhibitor.ref.xml">
 ]>
 
 <book id="index">
@@ -37,6 +38,7 @@
       &dbus-Manager;
       &dbus-Client;
       &dbus-DBusClient;
+      &dbus-Inhibitor;
 
     </reference>
   </part>

Modified: branches/dbus_based/gnome-session/gsm-inhibitor.xml
==============================================================================
--- branches/dbus_based/gnome-session/gsm-inhibitor.xml	(original)
+++ branches/dbus_based/gnome-session/gsm-inhibitor.xml	Mon Jul 28 15:39:10 2008
@@ -1,6 +1,103 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd";>
-<node>
+<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd";>
   <interface name="org.gnome.SessionManager.Inhibitor">
+    <method name="GetAppId">
+      <arg type="s" name="app_id" direction="out">
+        <doc:doc>
+          <doc:summary>The identifier for the associated application</doc:summary>
+        </doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>Return the application ID associated with this inhibit.</doc:para>
+        </doc:description>
+      </doc:doc>
+    </method>
+    <method name="GetClientId">
+      <arg type="o" name="client_id" direction="out">
+        <doc:doc>
+          <doc:summary>The object path of the associated client</doc:summary>
+        </doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>Return the client object path associated with this inhibit.</doc:para>
+        </doc:description>
+      </doc:doc>
+    </method>
+    <method name="GetReason">
+      <arg type="s" name="reason" direction="out">
+        <doc:doc>
+          <doc:summary>The reason for the inhibit</doc:summary>
+        </doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>Return the reason for the inhibit</doc:para>
+        </doc:description>
+      </doc:doc>
+    </method>
+    <method name="GetFlags">
+      <arg type="u" name="flags" direction="out">
+        <doc:doc>
+          <doc:summary>The flags that determine the scope of the inhibit</doc:summary>
+        </doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>Return the flags that determine the scope of the inhibit</doc:para>
+        </doc:description>
+      </doc:doc>
+    </method>
+    <method name="GetToplevelXid">
+      <arg type="u" name="xid" direction="out">
+        <doc:doc>
+          <doc:summary>X11 toplevel window identifier associated with this inhibit.  Zero if not set.</doc:summary>
+        </doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>Return the X11 toplevel window identifier associated with this inhibit.  Zero if not set.</doc:para>
+        </doc:description>
+      </doc:doc>
+    </method>
+
+    <property name="app-id" type="s" access="read">
+      <doc:doc>
+        <doc:description>
+          <doc:para>The application identifier associated with the inhibit.</doc:para>
+        </doc:description>
+      </doc:doc>
+    </property>
+    <property name="client-id" type="s" access="read">
+      <doc:doc>
+        <doc:description>
+          <doc:para>The session management client object path associated with the inhibit.</doc:para>
+        </doc:description>
+      </doc:doc>
+    </property>
+    <property name="reason" type="s" access="read">
+      <doc:doc>
+        <doc:description>
+          <doc:para>The reason for the inhibit.</doc:para>
+        </doc:description>
+      </doc:doc>
+    </property>
+    <property name="flags" type="u" access="read">
+      <doc:doc>
+        <doc:description>
+          <doc:para>The flags that determine the scope of the inhibit.</doc:para>
+        </doc:description>
+      </doc:doc>
+    </property>
+    <property name="toplevel-xid" type="u" access="read">
+      <doc:doc>
+        <doc:description>
+          <doc:para>The X11 toplevel window identifier associated with this inhibit.  Zero if not set.</doc:para>
+        </doc:description>
+      </doc:doc>
+    </property>
+
   </interface>
 </node>