[Xfce4-commits] <libxfce4ui:new-sm-client> set up docs for XfceSMClient
Brian J. Tarricone
brian at tarricone.org
Tue Sep 15 07:04:02 CEST 2009
Updating branch refs/heads/kelnos/new-sm-client
to 0c53e720e629cb50b10b357d787167ff8520090f (commit)
from 4e6de2230b1fb849809f8f53b1e2040a2fadaa2e (commit)
commit 0c53e720e629cb50b10b357d787167ff8520090f
Author: Brian J. Tarricone <brian at tarricone.org>
Date: Mon Sep 14 21:58:02 2009 -0700
set up docs for XfceSMClient
docs/libxfce4ui-docs.sgml | 6 +
docs/libxfce4ui-sections.txt | 57 +++++++
docs/tmpl/libxfce4ui-unused.sgml | 52 ++++++
docs/tmpl/xfce-sm-client.sgml | 344 ++++++++++++++++++++++++++++++++++++++
4 files changed, 459 insertions(+), 0 deletions(-)
diff --git a/docs/libxfce4ui-docs.sgml b/docs/libxfce4ui-docs.sgml
index ba3bd9e..1af031f 100644
--- a/docs/libxfce4ui-docs.sgml
+++ b/docs/libxfce4ui-docs.sgml
@@ -7,6 +7,7 @@
<!ENTITY xfce-gtk-extensions SYSTEM "xml/xfce-gtk-extensions.xml">
<!ENTITY xfce-dialogs SYSTEM "xml/xfce-dialogs.xml">
<!ENTITY xfce-titled-dialog SYSTEM "xml/xfce-titled-dialog.xml">
+<!ENTITY xfce-sm-client SYSTEM "xml/xfce-sm-client.xml">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY date "Juli 2009">
@@ -71,6 +72,11 @@
&xfce-titled-dialog;
</part>
+ <part id="libxfce4ui-sm">
+ <title>Xfce Session Management Support</title>
+ &xfce-sm-client;
+ </part>
+
<index>
<title>Index</title>
</index>
diff --git a/docs/libxfce4ui-sections.txt b/docs/libxfce4ui-sections.txt
index c61a7e5..60daa3f 100644
--- a/docs/libxfce4ui-sections.txt
+++ b/docs/libxfce4ui-sections.txt
@@ -70,3 +70,60 @@ XFCE_TITLED_DIALOG_GET_CLASS
XfceTitledDialogPrivate
xfce_titled_dialog_get_type
</SECTION>
+
+<SECTION>
+<FILE>xfce-sm-client</FILE>
+XfceSMClient
+XfceSMClientPriority
+XfceSMClientRestartStyle
+XfceSMClientShutdownHint
+XfceSMClientState
+xfce_sm_client_get_option_group
+xfce_sm_client_get
+xfce_sm_client_get_with_argv
+xfce_sm_client_get_full
+xfce_sm_client_connect
+xfce_sm_client_disconnect
+xfce_sm_client_is_resumed
+xfce_sm_client_request_shutdown
+xfce_sm_client_get_client_id
+xfce_sm_client_get_state
+xfce_sm_client_get_state_file
+xfce_sm_client_get_clone_command
+xfce_sm_client_set_clone_command
+xfce_sm_client_get_current_directory
+xfce_sm_client_set_current_directory
+xfce_sm_client_get_discard_command
+xfce_sm_client_set_discard_command
+xfce_sm_client_get_priority
+xfce_sm_client_set_priority
+xfce_sm_client_get_program
+xfce_sm_client_set_program
+xfce_sm_client_get_resign_command
+xfce_sm_client_set_resign_command
+xfce_sm_client_get_restart_command
+xfce_sm_client_set_restart_command
+xfce_sm_client_get_restart_style
+xfce_sm_client_set_restart_style
+xfce_sm_client_get_shutdown_command
+xfce_sm_client_set_shutdown_command
+<SUBSECTION Standard>
+XfceSMClientClass
+XFCE_IS_SM_CLIENT
+XFCE_IS_SM_CLIENT_CLASS
+XFCE_SM_CLIENT
+XFCE_SM_CLIENT_CLASS
+XFCE_SM_CLIENT_GET_CLASS
+XFCE_TYPE_SM_CLIENT
+XFCE_TYPE_SM_CLIENT_PRIORITY
+XFCE_TYPE_SM_CLIENT_RESTART_STYLE
+XFCE_TYPE_SM_CLIENT_SHUTDOWN_HINT
+XFCE_TYPE_SM_CLIENT_STATE
+<SUBSECTION Private>
+XfceSMClientPrivate
+xfce_sm_client_get_type
+xfce_sm_client_priority_get_type
+xfce_sm_client_restart_style_get_type
+xfce_sm_client_shutdown_hint_get_type
+xfce_sm_client_state_get_type
+</SECTION>
diff --git a/docs/tmpl/libxfce4ui-unused.sgml b/docs/tmpl/libxfce4ui-unused.sgml
index e69de29..ab23b1c 100644
--- a/docs/tmpl/libxfce4ui-unused.sgml
+++ b/docs/tmpl/libxfce4ui-unused.sgml
@@ -0,0 +1,52 @@
+<!-- ##### SECTION ./tmpl/xfce-pango-extensions.sgml:Long_Description ##### -->
+<para>
+These functions allow the developer to quickly work with Pango attributes.
+</para>
+
+
+<!-- ##### SECTION ./tmpl/xfce-pango-extensions.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/xfce-pango-extensions.sgml:Short_Description ##### -->
+Common used functions to easily access Pango functions.
+
+
+<!-- ##### SECTION ./tmpl/xfce-pango-extensions.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/xfce-pango-extensions.sgml:Title ##### -->
+Xfce Pango Extensions
+
+
+<!-- ##### STRUCT XfceSMClientClass ##### -->
+<para>
+
+</para>
+
+ at parent:
+ at save_state:
+ at save_state_extended:
+ at quit_requested:
+ at quit:
+ at quit_cancelled:
+ at state_changed:
+ at _xfce_reserved0:
+ at _xfce_reserved1:
+ at _xfce_reserved2:
+ at _xfce_reserved3:
+
+<!-- ##### FUNCTION xfce_pango_attr_list_new ##### -->
+<para>
+
+</para>
+
+ at scale_factor:
+ at style:
+ at weight:
+ at underline:
+ at Returns:
+
diff --git a/docs/tmpl/xfce-sm-client.sgml b/docs/tmpl/xfce-sm-client.sgml
new file mode 100644
index 0000000..fd8f729
--- /dev/null
+++ b/docs/tmpl/xfce-sm-client.sgml
@@ -0,0 +1,344 @@
+<!-- ##### SECTION Title ##### -->
+xfce-sm-client
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT XfceSMClient ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM XfceSMClientPriority ##### -->
+<para>
+
+</para>
+
+ at XFCE_SM_CLIENT_PRIORITY_HIGHEST:
+ at XFCE_SM_CLIENT_PRIORITY_WM:
+ at XFCE_SM_CLIENT_PRIORITY_DESKTOP:
+ at XFCE_SM_CLIENT_PRIORITY_CORE:
+ at XFCE_SM_CLIENT_PRIORITY_DEFAULT:
+
+<!-- ##### ENUM XfceSMClientRestartStyle ##### -->
+<para>
+
+</para>
+
+ at XFCE_SM_CLIENT_RESTART_IF_RUNNING:
+ at XFCE_SM_CLIENT_RESTART_ANYWAY:
+ at XFCE_SM_CLIENT_RESTART_IMMEDIATELY:
+ at XFCE_SM_CLIENT_RESTART_NEVER:
+
+<!-- ##### ENUM XfceSMClientShutdownHint ##### -->
+<para>
+
+</para>
+
+ at XFCE_SM_CLIENT_SHUTDOWN_HINT_ASK:
+ at XFCE_SM_CLIENT_SHUTDOWN_HINT_LOGOUT:
+ at XFCE_SM_CLIENT_SHUTDOWN_HINT_HALT:
+ at XFCE_SM_CLIENT_SHUTDOWN_HINT_REBOOT:
+
+<!-- ##### ENUM XfceSMClientState ##### -->
+<para>
+
+</para>
+
+ at XFCE_SM_CLIENT_STATE_IDLE:
+ at XFCE_SM_CLIENT_STATE_SAVING_PHASE_1:
+ at XFCE_SM_CLIENT_STATE_WAITING_FOR_PHASE_2:
+ at XFCE_SM_CLIENT_STATE_SAVING_PHASE_2:
+ at XFCE_SM_CLIENT_STATE_WAITING_FOR_INTERACT:
+ at XFCE_SM_CLIENT_STATE_INTERACTING:
+ at XFCE_SM_CLIENT_STATE_FROZEN:
+ at XFCE_SM_CLIENT_STATE_DISCONNECTED:
+ at XFCE_SM_CLIENT_STATE_REGISTERING:
+
+<!-- ##### FUNCTION xfce_sm_client_get_option_group ##### -->
+<para>
+
+</para>
+
+ at argc:
+ at argv:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_with_argv ##### -->
+<para>
+
+</para>
+
+ at argc:
+ at argv:
+ at restart_style:
+ at priority:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_full ##### -->
+<para>
+
+</para>
+
+ at restart_style:
+ at priority:
+ at resumed_client_id:
+ at program:
+ at current_directory:
+ at restart_command:
+ at clone_command:
+ at discard_command:
+ at resign_command:
+ at shutdown_command:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_connect ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at error:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_disconnect ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+
+
+<!-- ##### FUNCTION xfce_sm_client_is_resumed ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_request_shutdown ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at shutdown_hint:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_client_id ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_state ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_state_file ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_clone_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_set_clone_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at value:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_current_directory ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_set_current_directory ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at value:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_discard_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_set_discard_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at value:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_priority ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_set_priority ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at value:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_program ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_set_program ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at value:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_resign_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_set_resign_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at value:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_restart_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_set_restart_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at value:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_restart_style ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_set_restart_style ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at restart_style:
+
+
+<!-- ##### FUNCTION xfce_sm_client_get_shutdown_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at Returns:
+
+
+<!-- ##### FUNCTION xfce_sm_client_set_shutdown_command ##### -->
+<para>
+
+</para>
+
+ at sm_client:
+ at value:
+
+
More information about the Xfce4-commits
mailing list