<HTML
><HEAD
><TITLE
>GnomeClient</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.74b"><LINK
REL="HOME"
TITLE="Gnome User Interface Library Reference Manual"
HREF="book1.html"><LINK
REL="UP"
TITLE="GNOME Widgets and Objects"
HREF="gnome-objects.html"><LINK
REL="PREVIOUS"
TITLE="GnomeCanvasWidget"
HREF="gnomecanvaswidget.html"><LINK
REL="NEXT"
TITLE="GnomeColorPicker"
HREF="gnomecolorpicker.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
BGCOLOR="#000000"
CELLPADDING="1"
CELLSPACING="0"
><TR
><TH
COLSPAN="4"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="5"
>Gnome User Interface Library Reference Manual</FONT
></TH
></TR
><TR
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="left"
><A
HREF="gnomecanvaswidget.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><<< Previous Page</B
></FONT
></A
></TD
><TD
WIDTH="25%"
BGCOLOR="#0000C0"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="book1.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Home</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#00C000"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="gnome-objects.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Up</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="right"
><A
HREF="gnomecolorpicker.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page >>></B
></FONT
></A
></TD
></TR
></TABLE
></DIV
><H1
><A
NAME="GNOMECLIENT"
>GnomeClient</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN12028"
></A
><H2
>Name</H2
>GnomeClient -- Routines to provide session management support in your application</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN12031"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
> #include <gnome.h>
struct <A
HREF="gnomeclient.html#GNOMECLIENT-STRUCT"
>GnomeClient</A
>;
enum <A
HREF="gnomeclient.html#GNOMECLIENTFLAGS"
>GnomeClientFlags</A
>;
#define <A
HREF="gnomeclient.html#GNOME-CLIENT-CONNECTED-CAPS"
>GNOME_CLIENT_CONNECTED</A
> (obj)
enum <A
HREF="gnomeclient.html#GNOMEINTERACTSTYLE"
>GnomeInteractStyle</A
>;
enum <A
HREF="gnomeclient.html#GNOMEDIALOGTYPE"
>GnomeDialogType</A
>;
enum <A
HREF="gnomeclient.html#GNOMESAVESTYLE"
>GnomeSaveStyle</A
>;
enum <A
HREF="gnomeclient.html#GNOMERESTARTSTYLE"
>GnomeRestartStyle</A
>;
enum <A
HREF="gnomeclient.html#GNOMECLIENTSTATE"
>GnomeClientState</A
>;
void (<A
HREF="gnomeclient.html#GNOMEINTERACTFUNCTION"
>*GnomeInteractFunction</A
>) (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> key,
<A
HREF="gnomeclient.html#GNOMEDIALOGTYPE"
>GnomeDialogType</A
> dialog_type,
<GTKDOCLINK
HREF="GPOINTER"
>gpointer</GTKDOCLINK
> data);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-DISABLE-MASTER-CONNECTION"
>gnome_client_disable_master_connection</A
>
(void);
<A
HREF="gnomeclient.html"
>GnomeClient</A
>* <A
HREF="gnomeclient.html#GNOME-MASTER-CLIENT"
>gnome_master_client</A
> (void);
<A
HREF="gnomeclient.html"
>GnomeClient</A
>* <A
HREF="gnomeclient.html#GNOME-CLONED-CLIENT"
>gnome_cloned_client</A
> (void);
<A
HREF="gnomeclient.html"
>GnomeClient</A
>* <A
HREF="gnomeclient.html#GNOME-CLIENT-NEW"
>gnome_client_new</A
> (void);
<A
HREF="gnomeclient.html"
>GnomeClient</A
>* <A
HREF="gnomeclient.html#GNOME-CLIENT-NEW-WITHOUT-CONNECTION"
>gnome_client_new_without_connection</A
>
(void);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-CONNECT"
>gnome_client_connect</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-DISCONNECT"
>gnome_client_disconnect</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-ID"
>gnome_client_set_id</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *client_id);
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* <A
HREF="gnomeclient.html#GNOME-CLIENT-GET-ID"
>gnome_client_get_id</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* <A
HREF="gnomeclient.html#GNOME-CLIENT-GET-PREVIOUS-ID"
>gnome_client_get_previous_id</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* <A
HREF="gnomeclient.html#GNOME-CLIENT-GET-CONFIG-PREFIX"
>gnome_client_get_config_prefix</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* <A
HREF="gnomeclient.html#GNOME-CLIENT-GET-GLOBAL-CONFIG-PREFIX"
>gnome_client_get_global_config_prefix</A
>
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-GLOBAL-CONFIG-PREFIX"
>gnome_client_set_global_config_prefix</A
>
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *prefix);
<A
HREF="gnomeclient.html#GNOMECLIENTFLAGS"
>GnomeClientFlags</A
> <A
HREF="gnomeclient.html#GNOME-CLIENT-GET-FLAGS"
>gnome_client_get_flags</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-RESTART-STYLE"
>gnome_client_set_restart_style</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomeclient.html#GNOMERESTARTSTYLE"
>GnomeRestartStyle</A
> style);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-RESTART-COMMAND"
>gnome_client_set_restart_command</A
>
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-ADD-STATIC-ARG"
>gnome_client_add_static_arg</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
...);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-DISCARD-COMMAND"
>gnome_client_set_discard_command</A
>
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-RESIGN-COMMAND"
>gnome_client_set_resign_command</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-SHUTDOWN-COMMAND"
>gnome_client_set_shutdown_command</A
>
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-CURRENT-DIRECTORY"
>gnome_client_set_current_directory</A
>
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *dir);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-ENVIRONMENT"
>gnome_client_set_environment</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *name,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *value);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-CLONE-COMMAND"
>gnome_client_set_clone_command</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-PROCESS-ID"
>gnome_client_set_process_id</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="PID-T"
>pid_t</GTKDOCLINK
> pid);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-PROGRAM"
>gnome_client_set_program</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *program);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SET-USER-ID"
>gnome_client_set_user_id</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *user_id);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-REQUEST-PHASE-2"
>gnome_client_request_phase_2</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SAVE-ANY-DIALOG"
>gnome_client_save_any_dialog</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomedialog.html"
>GnomeDialog</A
> *dialog);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-SAVE-ERROR-DIALOG"
>gnome_client_save_error_dialog</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomedialog.html"
>GnomeDialog</A
> *dialog);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-REQUEST-INTERACTION"
>gnome_client_request_interaction</A
>
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomeclient.html#GNOMEDIALOGTYPE"
>GnomeDialogType</A
> dialog,
<A
HREF="gnomeclient.html#GNOMEINTERACTFUNCTION"
>GnomeInteractFunction</A
> func,
<GTKDOCLINK
HREF="GPOINTER"
>gpointer</GTKDOCLINK
> client_data);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-REQUEST-INTERACTION-INTERP"
>gnome_client_request_interaction_interp</A
>
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomeclient.html#GNOMEDIALOGTYPE"
>GnomeDialogType</A
> dialog,
<GTKDOCLINK
HREF="GTKCALLBACKMARSHAL"
>GtkCallbackMarshal</GTKDOCLINK
> func,
<GTKDOCLINK
HREF="GPOINTER"
>gpointer</GTKDOCLINK
> data,
<GTKDOCLINK
HREF="GTKDESTROYNOTIFY"
>GtkDestroyNotify</GTKDOCLINK
> destroy);
void <A
HREF="gnomeclient.html#GNOME-INTERACTION-KEY-RETURN"
>gnome_interaction_key_return</A
> (<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> key,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> cancel_shutdown);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-REQUEST-SAVE"
>gnome_client_request_save</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomeclient.html#GNOMESAVESTYLE"
>GnomeSaveStyle</A
> save_style,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> shutdown,
<A
HREF="gnomeclient.html#GNOMEINTERACTSTYLE"
>GnomeInteractStyle</A
> interact_style,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> fast,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> global);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-FLUSH"
>gnome_client_flush</A
> (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);
void <A
HREF="gnomeclient.html#GNOME-CLIENT-INIT"
>gnome_client_init</A
> (void); </PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN12154"
></A
><H2
>Object Hierarchy</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
> <GTKDOCLINK
HREF="GTKOBJECT"
>GtkObject</GTKDOCLINK
>
+----GnomeClient</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN12158"
></A
><H2
>Description</H2
><P
>The GNOME project uses a special object - the GnomeClient object
- to implement session management. This object handles the connection
to a session manager, the setting and removing of properties and the
handling of messages sent by a session manager.</P
><P
>There are two functions in the GNOME libraries, that create a
new GnomeClient object: <A
HREF="gnomeclient.html#GNOME-CLIENT-NEW"
>gnome_client_new</A
>() and
<A
HREF="gnomeclient.html#GNOME-CLIENT-NEW-WITHOUT-CONNECTION"
>gnome_client_new_without_connection</A
>(). As one may guess from the
functions names: The first function tries to connect to a session
manager automatically, while the second one does not. However, you
probably don't need to create your own client;
<TT
CLASS="FUNCTION"
><A
HREF="gnomeui-gnome-init.html#GNOME-INIT"
>gnome_init</A
>()</TT
> automatically creates a client for
you. To obtain this client, call
<TT
CLASS="FUNCTION"
><A
HREF="gnomeclient.html#GNOME-MASTER-CLIENT"
>gnome_master_client</A
>().</TT
>
</P
><P
>Two useful sources of information on session management are the
gnome-client header file and the SMlib.PS.Z document that comes with
X.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN12169"
></A
><H2
>Details</H2
><DIV
CLASS="REFSECT2"
><A
NAME="AEN12171"
></A
><H3
><A
NAME="GNOMECLIENT-STRUCT"
></A
>struct GnomeClient</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>struct GnomeClient;</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12176"
></A
><H3
><A
NAME="GNOMECLIENTFLAGS"
></A
>enum GnomeClientFlags</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef enum
{
GNOME_CLIENT_IS_CONNECTED= 1 << 0,
GNOME_CLIENT_RESTARTED = 1 << 1,
GNOME_CLIENT_RESTORED = 1 << 2
} GnomeClientFlags;</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12181"
></A
><H3
><A
NAME="GNOME-CLIENT-CONNECTED-CAPS"
></A
>GNOME_CLIENT_CONNECTED()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>#define GNOME_CLIENT_CONNECTED(obj) (GNOME_CLIENT (obj)->smc_conn)</PRE
></TD
></TR
></TABLE
><P
>Returns TRUE if the client is connected to the session manager.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12186"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>obj</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>Client to check.
</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12195"
></A
><H3
><A
NAME="GNOMEINTERACTSTYLE"
></A
>enum GnomeInteractStyle</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef enum
{
GNOME_INTERACT_NONE,
GNOME_INTERACT_ERRORS,
GNOME_INTERACT_ANY
} GnomeInteractStyle;</PRE
></TD
></TR
></TABLE
><P
>Controls permitted user interaction during session save.</P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12200"
></A
><H3
><A
NAME="GNOMEDIALOGTYPE"
></A
>enum GnomeDialogType</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef enum
{
GNOME_DIALOG_ERROR,
GNOME_DIALOG_NORMAL
} GnomeDialogType;</PRE
></TD
></TR
></TABLE
><P
>Controls type of dialog generated for user interaction.</P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12205"
></A
><H3
><A
NAME="GNOMESAVESTYLE"
></A
>enum GnomeSaveStyle</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef enum
{
GNOME_SAVE_GLOBAL,
GNOME_SAVE_LOCAL,
GNOME_SAVE_BOTH
} GnomeSaveStyle;</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12210"
></A
><H3
><A
NAME="GNOMERESTARTSTYLE"
></A
>enum GnomeRestartStyle</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef enum
{
GNOME_RESTART_IF_RUNNING,
GNOME_RESTART_ANYWAY,
GNOME_RESTART_IMMEDIATELY,
GNOME_RESTART_NEVER
} GnomeRestartStyle;</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12215"
></A
><H3
><A
NAME="GNOMECLIENTSTATE"
></A
>enum GnomeClientState</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef enum
{
GNOME_CLIENT_IDLE,
GNOME_CLIENT_SAVING_PHASE_1,
GNOME_CLIENT_WAITING_FOR_PHASE_2,
GNOME_CLIENT_SAVING_PHASE_2,
GNOME_CLIENT_FROZEN,
GNOME_CLIENT_DISCONNECTED,
GNOME_CLIENT_REGISTERING
} GnomeClientState;</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12220"
></A
><H3
><A
NAME="GNOMEINTERACTFUNCTION"
></A
>GnomeInteractFunction ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void (*GnomeInteractFunction) (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> key,
<A
HREF="gnomeclient.html#GNOMEDIALOGTYPE"
>GnomeDialogType</A
> dialog_type,
<GTKDOCLINK
HREF="GPOINTER"
>gpointer</GTKDOCLINK
> data);</PRE
></TD
></TR
></TABLE
><P
>Callback invoked to perform user interaction.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12229"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>Client.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>key</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>Key to be returned when interaction ends.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dialog_type</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>Type of dialog being shown.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>data</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>Callback data.
</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12250"
></A
><H3
><A
NAME="GNOME-CLIENT-DISABLE-MASTER-CONNECTION"
></A
>gnome_client_disable_master_connection ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_disable_master_connection
(void);</PRE
></TD
></TR
></TABLE
><P
>Don't connect the master client to the session manager. Usually
invoked by users when they pass the --sm-disable argument to a Gnome application.</P
><P
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12256"
></A
><H3
><A
NAME="GNOME-MASTER-CLIENT"
></A
>gnome_master_client ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomeclient.html"
>GnomeClient</A
>* gnome_master_client (void);</PRE
></TD
></TR
></TABLE
><P
>Get the master session management client. This master client gets
a client id, that may be specified by the '--sm-client-id' command
line option. A master client will be generated by 'gnome-init'.
If possible the master client will contact the session manager
after command-line parsing is finished (unless
'gnome_client_disable_master_connection' was called). The master
client will also set the SM_CLIENT_ID property on the client leader
window of your application. </P
><P
> Additionally, the master client gets some static arguments set
automatically (see 'gnome_client_add_static_arg' for static
arguments): 'gnome_init' passes all the command line options which
are recognised by gtk as static arguments to the master client.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12264"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to the master client</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12273"
></A
><H3
><A
NAME="GNOME-CLONED-CLIENT"
></A
>gnome_cloned_client ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomeclient.html"
>GnomeClient</A
>* gnome_cloned_client (void);</PRE
></TD
></TR
></TABLE
><P
></P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12280"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12289"
></A
><H3
><A
NAME="GNOME-CLIENT-NEW"
></A
>gnome_client_new ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomeclient.html"
>GnomeClient</A
>* gnome_client_new (void);</PRE
></TD
></TR
></TABLE
><P
>Allocates memory for a new GNOME session management
client object. After allocating, the client tries to connect to a
session manager. You probably want to use
<function><A
HREF="gnomeclient.html#GNOME-MASTER-CLIENT"
>gnome_master_client</A
>()</function> instead.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12297"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to a newly allocated GNOME session management
client object.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12306"
></A
><H3
><A
NAME="GNOME-CLIENT-NEW-WITHOUT-CONNECTION"
></A
>gnome_client_new_without_connection ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomeclient.html"
>GnomeClient</A
>* gnome_client_new_without_connection
(void);</PRE
></TD
></TR
></TABLE
><P
>Allocates memory for a new GNOME session management
client object. You probably want to use
<function><A
HREF="gnomeclient.html#GNOME-MASTER-CLIENT"
>gnome_master_client</A
>()</function> instead.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12314"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to a newly allocated GNOME session management
client object.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12323"
></A
><H3
><A
NAME="GNOME-CLIENT-CONNECT"
></A
>gnome_client_connect ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_connect (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);</PRE
></TD
></TR
></TABLE
><P
>Causes the client to connect to the session manager.
Usually happens automatically; no need to call this function.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12330"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12339"
></A
><H3
><A
NAME="GNOME-CLIENT-DISCONNECT"
></A
>gnome_client_disconnect ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_disconnect (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);</PRE
></TD
></TR
></TABLE
><P
>Disconnect the client from the session manager.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12346"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12355"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-ID"
></A
>gnome_client_set_id ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_id (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *client_id);</PRE
></TD
></TR
></TABLE
><P
>Set the client's session management ID; must be done
before connecting to the session manager. Frankly I have no idea
why you'd do this.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12363"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client_id</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12376"
></A
><H3
><A
NAME="GNOME-CLIENT-GET-ID"
></A
>gnome_client_get_id ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* gnome_client_get_id (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);</PRE
></TD
></TR
></TABLE
><P
>Returns session management ID</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12384"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Session management ID for this client; NULL if not connected to a session manager.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12397"
></A
><H3
><A
NAME="GNOME-CLIENT-GET-PREVIOUS-ID"
></A
>gnome_client_get_previous_id ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* gnome_client_get_previous_id (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);</PRE
></TD
></TR
></TABLE
><P
>Get the previous session management ID (from previous session)</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12405"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to the session management ID the client had in the last
session, or NULL if it wasn't in a previous session.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12418"
></A
><H3
><A
NAME="GNOME-CLIENT-GET-CONFIG-PREFIX"
></A
>gnome_client_get_config_prefix ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* gnome_client_get_config_prefix (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);</PRE
></TD
></TR
></TABLE
><P
>Get the config prefix for a client. This config prefix
provides a suitable place to store any details about the state of
the client which can not be described using the app's command line
arguments (as set in the restart command). You may push the
returned value using 'gnome_config_push_prefix' and read or write
any values you require.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12426"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Config prefix.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12439"
></A
><H3
><A
NAME="GNOME-CLIENT-GET-GLOBAL-CONFIG-PREFIX"
></A
>gnome_client_get_global_config_prefix ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* gnome_client_get_global_config_prefix
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);</PRE
></TD
></TR
></TABLE
><P
>Get the config prefix that will be returned by
#<A
HREF="gnomeclient.html#GNOME-CLIENT-GET-CONFIG-PREFIX"
>gnome_client_get_config_prefix</A
>() for clients
which have NOT been restarted or cloned (i.e. for clients started
by the user without `--sm-' options). This config prefix may be
used to write the user's preferred config for these "new" clients.</P
><P
>You could also use this prefix as a place to store and retrieve
config details that you wish to apply to ALL instances of the
app. However, this practice limits the users freedom to configure
each instance in a different way so it should be used with caution.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12449"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The config prefix as a newly allocated string</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12462"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-GLOBAL-CONFIG-PREFIX"
></A
>gnome_client_set_global_config_prefix ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_global_config_prefix
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *prefix);</PRE
></TD
></TR
></TABLE
><P
>Set the value used for the global config prefix. The config prefixes
returned by gnome_client_get_config_prefix are formed by extending
this prefix with an unique identifier.
The global config prefix defaults to a name based on the name of
the executable. This function allows you to set it to a different
value. It should be called BEFORE retrieving the config prefix for
the first time. Later calls will be ignored.</P
><P
> For example, setting a global config prefix of "/app.d/session/"
would ensure that all your session save files or directories would
be gathered together into the app.d directory.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12471"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>prefix</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Prefix for saving the global configuration</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12484"
></A
><H3
><A
NAME="GNOME-CLIENT-GET-FLAGS"
></A
>gnome_client_get_flags ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gnomeclient.html#GNOMECLIENTFLAGS"
>GnomeClientFlags</A
> gnome_client_get_flags (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);</PRE
></TD
></TR
></TABLE
><P
></P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12492"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>some flags, that give additional information about this
client. Right now, the following flags are supported:
- GNOME_CLIENT_IS_CONNECTED: The client is connected to a session
manager (It's the same information like using *
GNOME_CLIENT_CONNECTED).
- GNOME_CLIENT_RESTARTED: The client has been restarted, i. e. it
has been running with the same client id before.
- GNOME_CLIENT_RESTORED: This flag is only used for the master
client. It indicates, that there may be a configuraion file from
which the clients state should be restored (using the
gnome_client_get_config_prefix call).</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12505"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-RESTART-STYLE"
></A
>gnome_client_set_restart_style ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_restart_style (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomeclient.html#GNOMERESTARTSTYLE"
>GnomeRestartStyle</A
> style);</PRE
></TD
></TR
></TABLE
><P
>GNOME_RESTART_IF_RUNNING causes the client to be
restarted in the next session if it was running when the previous
session exited. Restart is done via the restart command you
set. GNOME_RESTART_ANYWAY means the client will be restarted even
if the user exits the client before logging
out. GNOME_RESTART_IMMEDIATELY restarts the client immediately
anytime it crashes or is exited.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12513"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>style</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> When to restart the client</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12526"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-RESTART-COMMAND"
></A
>gnome_client_set_restart_command ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_restart_command
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);</PRE
></TD
></TR
></TABLE
><P
>When clients crash or the user logs out and back in,
they are restarted. * This command should perform the restart. *
Executing the restart command on the local host should reproduce
the state of the client at the time of the session save as closely
as possible. Saving config info under the
gnome_client_get_config_prefix is generally useful.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12535"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argc</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> number of strings in argv</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argv</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> argument vector to <function><GTKDOCLINK
HREF="EXECV"
>execv</GTKDOCLINK
>()</function> to restart the client</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12553"
></A
><H3
><A
NAME="GNOME-CLIENT-ADD-STATIC-ARG"
></A
>gnome_client_add_static_arg ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_add_static_arg (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
...);</PRE
></TD
></TR
></TABLE
><P
>You can add arguments to your restart command argv
with this function. This function provides an alternative way of
adding new arguments to the restart command. The arguments are
placed before the arguments specified by
'gnome_client_set_restart_command' and after the arguments
recognised by gtk specified by the user on the original command
line.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12560"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>...</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> NULL-terminated list of arguments to add to the restart command</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12573"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-DISCARD-COMMAND"
></A
>gnome_client_set_discard_command ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_discard_command
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);</PRE
></TD
></TR
></TABLE
><P
>Provides a command to run when a client is removed
from the session. It might delete session-specific config files for
example. Executing the discard command on the local host should
delete the information saved as part of the session save that was
in progress when the discard command was set. For example:</P
><P
><example>
gchar *prefix = gnome_client_get_config_prefix (client);
gchar *argv[] = { "rm", "-r", NULL };
argv[2] = gnome_config_get_real_path (prefix);
gnome_client_set_discard_command (client, 3, argv);
</example></P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12583"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argc</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Number of strings in argv</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argv</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12600"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-RESIGN-COMMAND"
></A
>gnome_client_set_resign_command ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_resign_command (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);</PRE
></TD
></TR
></TABLE
><P
>Some clients can be "undone," removing their effects and deleting any
saved state. For example, xmodmap could register a resign command to undo the keymap
changes it saved.</P
><P
>Used by clients that use the GNOME_RESTART_ANYWAY restart style to
to undo their effects (these clients usually perform initialisation
functions and leave effects behind after they die). The resign
command combines the effects of a shutdown command and a discard
command. It is executed when the user decides that the client
should cease to be restarted.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12610"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argc</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> number of strings in argv</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argv</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12627"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-SHUTDOWN-COMMAND"
></A
>gnome_client_set_shutdown_command ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_shutdown_command
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);</PRE
></TD
></TR
></TABLE
><P
>GNOME_RESTART_ANYWAY clients can set this command to run
when the user logs out but the client is no longer running.</P
><P
>Used by clients that use the GNOME_RESTART_ANYWAY restart style to
to undo their effects (these clients usually perform initialisation
functions and leave effects behind after they die). The shutdown
command simply undoes the effects of the client. It is executed
during a normal logout.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12637"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argc</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> number of strings in argv</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argv</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12654"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-CURRENT-DIRECTORY"
></A
>gnome_client_set_current_directory ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_current_directory
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *dir);</PRE
></TD
></TR
></TABLE
><P
>Set the directory to be in when running shutdown, discard, restart, etc. commands.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12662"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dir</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Directory path</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12675"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-ENVIRONMENT"
></A
>gnome_client_set_environment ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_environment (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *name,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *value);</PRE
></TD
></TR
></TABLE
><P
>Set an environment variable to be placed in the
client's environment prior to running restart, shutdown, discard, etc. commands.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12684"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>name</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Name of the environment variable</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>value</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Value of the environment variable</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12701"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-CLONE-COMMAND"
></A
>gnome_client_set_clone_command ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_clone_command (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> argc,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *argv[]);</PRE
></TD
></TR
></TABLE
><P
>Set a command the session manager can use to create a new instance of the application.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12710"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argc</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> number of strings in the argv vector</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argv</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12727"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-PROCESS-ID"
></A
>gnome_client_set_process_id ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_process_id (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<GTKDOCLINK
HREF="PID-T"
>pid_t</GTKDOCLINK
> pid);</PRE
></TD
></TR
></TABLE
><P
>The client should tell the session manager the result
of <function><GTKDOCLINK
HREF="GETPID"
>getpid</GTKDOCLINK
>()</function>. However, Gnome does this
automatically; so you don't need this function.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12736"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>pid</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> PID to set as the client's PID</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12749"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-PROGRAM"
></A
>gnome_client_set_program ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_program (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *program);</PRE
></TD
></TR
></TABLE
><P
>Used to tell the session manager the name of your program. Set automatically;
this function isn't needed.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12757"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>program</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> name of the program</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12770"
></A
><H3
><A
NAME="GNOME-CLIENT-SET-USER-ID"
></A
>gnome_client_set_user_id ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_set_user_id (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
const <GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *user_id);</PRE
></TD
></TR
></TABLE
><P
>Tell the session manager the user's login name. Gnome
does this automatically; no need to call the function.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12778"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>user_id</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12791"
></A
><H3
><A
NAME="GNOME-CLIENT-REQUEST-PHASE-2"
></A
>gnome_client_request_phase_2 ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_request_phase_2 (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);</PRE
></TD
></TR
></TABLE
><P
>Request the session managaer to emit the "save_yourself" signal for
a second time after all the clients in the session have ceased
interacting with the user and entered an idle state. This might be
useful if your app manages other apps and requires that they are in
an idle state before saving its final data.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12798"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12807"
></A
><H3
><A
NAME="GNOME-CLIENT-SAVE-ANY-DIALOG"
></A
>gnome_client_save_any_dialog ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_save_any_dialog (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomedialog.html"
>GnomeDialog</A
> *dialog);</PRE
></TD
></TR
></TABLE
><P
>May be called during a "save_youself" handler to request that a
(modal) dialog is presented to the user. The session manager decides
when the dialog is shown but it will not be shown it unless the
interact_style == GNOME_INTERACT_ANY. A "Cancel Logout" button
will be added during a shutdown.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12815"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dialog</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME dialog widget.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12828"
></A
><H3
><A
NAME="GNOME-CLIENT-SAVE-ERROR-DIALOG"
></A
>gnome_client_save_error_dialog ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_save_error_dialog (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomedialog.html"
>GnomeDialog</A
> *dialog);</PRE
></TD
></TR
></TABLE
><P
>May be called during a "save_youself" handler when an error has occured
during the save. The session manager decides when the dialog is shown
but it will not be shown when the interact_style == GNOME_INTERACT_NONE.
A "Cancel Logout" button will be added during a shutdown.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12836"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dialog</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME dialog widget.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12849"
></A
><H3
><A
NAME="GNOME-CLIENT-REQUEST-INTERACTION"
></A
>gnome_client_request_interaction ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_request_interaction
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomeclient.html#GNOMEDIALOGTYPE"
>GnomeDialogType</A
> dialog,
<A
HREF="gnomeclient.html#GNOMEINTERACTFUNCTION"
>GnomeInteractFunction</A
> func,
<GTKDOCLINK
HREF="GPOINTER"
>gpointer</GTKDOCLINK
> client_data);</PRE
></TD
></TR
></TABLE
><P
>Use the following functions, if you want to interact
with the user during a "save_yourself" handler without being
restricted to using the dialog based commands
gnome_client_save_[any/error]_dialog. If and when the session
manager decides that it's the app's turn to interact then 'func'
will be called with the specified arguments and a unique
'GnomeInteractionKey'. The session manager will block other clients
from interacting until this key is returned with
'gnome_interaction_key_return'.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12859"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dialog</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>func</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client_data</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12880"
></A
><H3
><A
NAME="GNOME-CLIENT-REQUEST-INTERACTION-INTERP"
></A
>gnome_client_request_interaction_interp ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_request_interaction_interp
(<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomeclient.html#GNOMEDIALOGTYPE"
>GnomeDialogType</A
> dialog,
<GTKDOCLINK
HREF="GTKCALLBACKMARSHAL"
>GtkCallbackMarshal</GTKDOCLINK
> func,
<GTKDOCLINK
HREF="GPOINTER"
>gpointer</GTKDOCLINK
> data,
<GTKDOCLINK
HREF="GTKDESTROYNOTIFY"
>GtkDestroyNotify</GTKDOCLINK
> destroy);</PRE
></TD
></TR
></TABLE
><P
>Used when you need to destroy the callback data after the interaction.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12891"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>dialog</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>func</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> </TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>data</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> callback data</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>destroy</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> function to destroy callback data</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12916"
></A
><H3
><A
NAME="GNOME-INTERACTION-KEY-RETURN"
></A
>gnome_interaction_key_return ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_interaction_key_return (<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> key,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> cancel_shutdown);</PRE
></TD
></TR
></TABLE
><P
>Used in interaction callback to tell the session manager
you're done interacting</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12924"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>key</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Key passed to interaction callback</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>cancel_shutdown</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> if TRUE then cancel the shutdown</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12937"
></A
><H3
><A
NAME="GNOME-CLIENT-REQUEST-SAVE"
></A
>gnome_client_request_save ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_request_save (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client,
<A
HREF="gnomeclient.html#GNOMESAVESTYLE"
>GnomeSaveStyle</A
> save_style,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> shutdown,
<A
HREF="gnomeclient.html#GNOMEINTERACTSTYLE"
>GnomeInteractStyle</A
> interact_style,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> fast,
<GTKDOCLINK
HREF="GBOOLEAN"
>gboolean</GTKDOCLINK
> global);</PRE
></TD
></TR
></TABLE
><P
>Request the session manager to save the session in
some way. The arguments correspond with the arguments passed to the
"save_yourself" signal handler.</P
><P
>The save_style indicates whether the save should affect data
accessible to other users (GNOME_SAVE_GLOBAL) or only the state
visible to the current user (GNOME_SAVE_LOCAL) or both. Setting
shutdown to TRUE will initiate a logout. The interact_style
specifies which kinds of interaction will be available. Setting
fast to TRUE will limit the save to setting the session manager
properties plus any essential data. Setting the value of global to
TRUE will request that all the other apps in the session do a save
as well. A global save is mandatory when doing a shutdown.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12950"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>save_style</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Save style to request</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>shutdown</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Whether to log out of the session</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>interact_style</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> whether to allow user interaction</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>fast</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> minimize activity to save ASAP</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>global</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> request that all other apps in the session also save</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12979"
></A
><H3
><A
NAME="GNOME-CLIENT-FLUSH"
></A
>gnome_client_flush ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_flush (<A
HREF="gnomeclient.html"
>GnomeClient</A
> *client);</PRE
></TD
></TR
></TABLE
><P
>This will force the underlying connection to the session manager to
be flushed. This is useful if you have some pending changes that
you want to make sure get committed.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN12986"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>client</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Pointer to GNOME session client object.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN12995"
></A
><H3
><A
NAME="GNOME-CLIENT-INIT"
></A
>gnome_client_init ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_client_init (void);</PRE
></TD
></TR
></TABLE
><P
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><BR
CLEAR="all"><BR><TABLE
WIDTH="100%"
BORDER="0"
BGCOLOR="#000000"
CELLPADDING="1"
CELLSPACING="0"
><TR
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="left"
><A
HREF="gnomecanvaswidget.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><<< Previous Page</B
></FONT
></A
></TD
><TD
WIDTH="25%"
BGCOLOR="#0000C0"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="book1.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Home</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#00C000"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="gnome-objects.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Up</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="right"
><A
HREF="gnomecolorpicker.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page >>></B
></FONT
></A
></TD
></TR
><TR
><TD
COLSPAN="2"
ALIGN="left"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>GnomeCanvasWidget</B
></FONT
></TD
><TD
COLSPAN="2"
ALIGN="right"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>GnomeColorPicker</B
></FONT
></TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
1bbf51ece72e40a5f40ad48678e7c5a5
>
files
>
441
