Updating branch refs/heads/kelnos/new-sm-client
to bef8eee3c84fd9c40d008b5486ff4c01d5069f4e (commit)
from 53a05e42bb84aa0ab31e41b7cb2f86f002b788ba (commit)
commit bef8eee3c84fd9c40d008b5486ff4c01d5069f4e
Author: Brian J. Tarricone <br...@tarricone.org>
Date: Tue Sep 15 01:18:51 2009 -0700
finish up the XfceSMClient docs
docs/libxfce4ui-sections.txt | 2 -
docs/tmpl/xfce-sm-client.sgml | 87 +++++++++++++++++++++++++++--------------
libxfce4ui/xfce-sm-client.h | 6 +-
3 files changed, 60 insertions(+), 35 deletions(-)
diff --git a/docs/libxfce4ui-sections.txt b/docs/libxfce4ui-sections.txt
index 60daa3f..ef8f4e3 100644
--- a/docs/libxfce4ui-sections.txt
+++ b/docs/libxfce4ui-sections.txt
@@ -108,7 +108,6 @@ 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
@@ -120,7 +119,6 @@ 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
diff --git a/docs/tmpl/xfce-sm-client.sgml b/docs/tmpl/xfce-sm-client.sgml
index b68c55b..4c39565 100644
--- a/docs/tmpl/xfce-sm-client.sgml
+++ b/docs/tmpl/xfce-sm-client.sgml
@@ -1,12 +1,14 @@
<!-- ##### SECTION Title ##### -->
-xfce-sm-client
+XfceSMClient
<!-- ##### SECTION Short_Description ##### -->
-
+Session management client
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+#XfceSMClient is a session management client that speaks the X Session
+Management Protocol (XSMP). It's designed to be easy to use and hide some
+of the more esoteric feaures of XSMP from the API user.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -19,55 +21,80 @@ xfce-sm-client
<!-- ##### STRUCT XfceSMClient ##### -->
<para>
-
+An opaque struct with only private fields.
</para>
<!-- ##### ENUM XfceSMClientPriority ##### -->
<para>
-
+Some sample priority values for use with xfce_sm_client_set_priority().
</para>
-...@xfce_sm_client_priority_highest:
-...@xfce_sm_client_priority_wm:
-...@xfce_sm_client_priority_desktop:
-...@xfce_sm_client_priority_core:
-...@xfce_sm_client_priority_default:
+...@xfce_sm_client_priority_highest: A relatively-high priority value. You
+ probably don't want to use this.
+...@xfce_sm_client_priority_wm: A priority value for use by the window manager.
+...@xfce_sm_client_priority_desktop: A priority value for use by applications
+ that draw on the desktop.
+...@xfce_sm_client_priority_core: A priority value for use by applications that
+ place windows on the screen and possibly set
+ window manager struts.
+...@xfce_sm_client_priority_default: A priority value for regular applications.
<!-- ##### ENUM XfceSMClientRestartStyle ##### -->
<para>
-
+An enumeration describing how the session manager should restart
+the application.
</para>
-...@xfce_sm_client_restart_if_running:
-...@xfce_sm_client_restart_anyway:
-...@xfce_sm_client_restart_immediately:
-...@xfce_sm_client_restart_never:
+...@xfce_sm_client_restart_if_running: Only restart the application if it is
+ still running at the end of the current
+ session
+...@xfce_sm_client_restart_anyway: Always restart the application the next
+ time the session starts
+...@xfce_sm_client_restart_immediately: Immediately restart the application
+ if it ever quits
+...@xfce_sm_client_restart_never: Don't restart the application; after it
+ runs once, remove it from the session
<!-- ##### ENUM XfceSMClientShutdownHint ##### -->
<para>
-
+Hints to the session manager what kind of shutdown the session manager
+should perform.
</para>
-...@xfce_sm_client_shutdown_hint_ask:
-...@xfce_sm_client_shutdown_hint_logout:
-...@xfce_sm_client_shutdown_hint_halt:
-...@xfce_sm_client_shutdown_hint_reboot:
+...@xfce_sm_client_shutdown_hint_ask: Prompt the user for a choice
+...@xfce_sm_client_shutdown_hint_logout: End the current session
+...@xfce_sm_client_shutdown_hint_halt: Shut down the computer
+...@xfce_sm_client_shutdown_hint_reboot: Restart the computer
<!-- ##### ENUM XfceSMClientState ##### -->
<para>
-
-</para>
-
-...@xfce_sm_client_state_idle:
-...@xfce_sm_client_state_saving_phase_1:
-...@xfce_sm_client_state_waiting_for_phase_2:
-...@xfce_sm_client_state_saving_phase_2:
-...@xfce_sm_client_state_waiting_for_interact:
-...@xfce_sm_client_state_interacting:
-...@xfce_sm_client_state_frozen:
-...@xfce_sm_client_state_disconnected:
-...@xfce_sm_client_state_registering:
+Describes the various X Session Management Protocol states the client
+may be in
+</para>
+
+...@xfce_sm_client_state_idle: The application is running normally
+...@xfce_sm_client_state_saving_phase_1: The application is saving its state
+...@xfce_sm_client_state_waiting_for_phase_2: The application has requested
+ an extended save state, and is
+ waiting for the session manaer's
+ response
+...@xfce_sm_client_state_saving_phase_2: The application is saving extended
+ state information
+...@xfce_sm_client_state_waiting_for_interact: The application is waiting its
+ turn to interact with the user
+ during shutdown
+...@xfce_sm_client_state_interacting: The application is interacting with the
+ user during shutdown
+...@xfce_sm_client_state_frozen: The application is frozen (and should not
+ interact with the user) while waiting for
+ further instructions from the session
+ manager
+...@xfce_sm_client_state_disconnected: The application has disconnected from
+ the session manager
+...@xfce_sm_client_state_registering: The application has just connected to
+ the session manager and is in the
+ registration phase
<!-- ##### FUNCTION xfce_sm_client_get_option_group ##### -->
<para>
diff --git a/libxfce4ui/xfce-sm-client.h b/libxfce4ui/xfce-sm-client.h
index a0e4859..dc67782 100644
--- a/libxfce4ui/xfce-sm-client.h
+++ b/libxfce4ui/xfce-sm-client.h
@@ -36,12 +36,12 @@
G_BEGIN_DECLS
-typedef enum /*< prefix=XFCE_SM_CLIENT_RESTART_ >*/
+typedef enum
{
XFCE_SM_CLIENT_RESTART_IF_RUNNING = 0,
- XFCE_SM_CLIENT_RESTART_ANYWAY, /* TODO: maybe not support this? */
+ XFCE_SM_CLIENT_RESTART_ANYWAY,
XFCE_SM_CLIENT_RESTART_IMMEDIATELY,
- XFCE_SM_CLIENT_RESTART_NEVER, /* TODO: maybe not support this? */
+ XFCE_SM_CLIENT_RESTART_NEVER,
} XfceSMClientRestartStyle;
typedef enum
_______________________________________________
Xfce4-commits mailing list
Xfce4-commits@xfce.org
http://foo-projects.org/mailman/listinfo/xfce4-commits
