Top | ![]() |
![]() |
![]() |
![]() |
void | connect | Run First |
void | die | Run Last |
void | disconnect | Run First |
void | save-complete | Run First |
gboolean | save-yourself | Run Last |
void | shutdown-cancelled | Run First |
enum | GnomeDialogType |
enum | GnomeRestartStyle |
enum | GnomeClientFlags |
enum | GnomeSaveStyle |
enum | GnomeInteractStyle |
struct | GnomeClient |
#define | GNOME_CLIENT_PARAM_SM_CONNECT |
void (*GnomeInteractFunction) (GnomeClient *client
,gint key
,GnomeDialogType dialog_type
,gpointer data
);
GnomeClient *
gnome_master_client (void
);
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_program_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.
Additionally, the master client gets some static arguments set automatically
(see gnome_client_add_static_arg()
for static arguments):
gnome_program_init()
passes all the command line options which are
recognised by gtk as static arguments to the master client.
const gchar *
gnome_client_get_config_prefix (GnomeClient *client
);
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.
const gchar *
gnome_client_get_global_config_prefix (GnomeClient *client
);
Get the config prefix that will be returned by
gnome_client_get_config_prefix()
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.
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.
void gnome_client_set_global_config_prefix (GnomeClient *client
,const gchar *prefix
);
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.
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.
GnomeClientFlags
gnome_client_get_flags (GnomeClient *client
);
Determine the client's status with the session manager.,
void gnome_client_set_restart_style (GnomeClient *client
,GnomeRestartStyle style
);
Tells the session manager how the client should be restarted in future session. The options are given by the GnomeRestartStyle enum.
void gnome_client_set_priority (GnomeClient *client
,guint priority
);
The gnome-session manager restarts clients in order of their priorities in a similar way to the start up ordering in SysV. This function allows the app to suggest a position in this ordering. The value should be between 0 and 99. A default value of 50 is assigned to apps that do not provide a value. The user may assign a different priority.
void gnome_client_set_restart_command (GnomeClient *client
,gint argc
,gchar *argv[]
);
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.
void gnome_client_add_static_arg (GnomeClient *client
,...
);
You can add arguments to your restart command's 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+ that are specified by the user on the original command
line.
client |
Pointer to GNOME session client object. |
|
... |
|
void gnome_client_set_discard_command (GnomeClient *client
,gint argc
,gchar *argv[]
);
void gnome_client_set_resign_command (GnomeClient *client
,gint argc
,gchar *argv[]
);
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.
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.
void gnome_client_set_shutdown_command (GnomeClient *client
,gint argc
,gchar *argv[]
);
GNOME_RESTART_ANYWAY clients can set this command to run when the user logs out but the client is no longer running.
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.
void gnome_client_set_current_directory (GnomeClient *client
,const gchar *dir
);
Set the directory to be in when running shutdown, discard, restart, etc. commands.
void gnome_client_set_environment (GnomeClient *client
,const gchar *name
,const gchar *value
);
Set an environment variable to be placed in the client's environment prior to running restart, shutdown, discard, etc. commands.
void gnome_client_set_clone_command (GnomeClient *client
,gint argc
,gchar *argv[]
);
Set a command the session manager can use to create a new instance of the application.
void gnome_client_set_process_id (GnomeClient *client
,pid_t pid
);
The client should tell the session manager the result of
getpid()
. However, GNOME does this automatically; so you do not need this
function.
void gnome_client_set_program (GnomeClient *client
,const gchar *program
);
Used to tell the session manager the name of your program. Set automatically; this function isn't needed.
void gnome_client_set_user_id (GnomeClient *client
,const gchar *id
);
Tell the session manager the user's login name. GNOME does this automatically; no need to call the function.
void gnome_client_save_any_dialog (GnomeClient *client
,GtkDialog *dialog
);
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 session manager is sending an interaction style of GNOME_INTERACT_ANY. A "Cancel Logout" button will be added during a shutdown.
client |
Pointer to GnomeClient object. |
|
dialog |
Pointer to GNOME dialog widget (a GtkDialog widget). |
void gnome_client_save_error_dialog (GnomeClient *client
,GtkDialog *dialog
);
May be called during a "save_youself" handler when an error has occurred during the save. The session manager decides when the dialog is shown, but it will not be shown it unless the session manager is sending an interaction style of GNOME_INTERACT_ANY. A "Cancel Logout" button will be added during a shutdown.
client |
Pointer to GnomeClient object. |
|
dialog |
Pointer to GNOME dialog widget (a GtkDialog widget). |
void
gnome_client_request_phase_2 (GnomeClient *client
);
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.
void gnome_client_request_save (GnomeClient *client
,GnomeSaveStyle save_style
,gboolean shutdown
,GnomeInteractStyle interact_style
,gboolean fast
,gboolean global
);
Request the session manager to save the session in some way. The arguments correspond with the arguments passed to the "save_yourself" signal handler.
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.
client |
Pointer to GNOME session client object. |
|
save_style |
Save style to request. |
|
shutdown |
Whether to log out of the session. |
|
interact_style |
Whether to allow user interaction. |
|
fast |
Minimize activity to save as soon as possible. |
|
global |
Request that all other apps in the session also save their state. |
void
gnome_client_flush (GnomeClient *client
);
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.
void
gnome_client_disable_master_connection
(void
);
gnome_client_disable_master_connection
is deprecated and should not be used in newly-written code.
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.
GnomeClient *
gnome_client_new (void
);
gnome_client_new
is deprecated and should not be used in newly-written code.
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 gnome_master_client()
instead.
GnomeClient *
gnome_client_new_without_connection (void
);
Allocates memory for a new GNOME session management client
object. You probably want to use gnome_master_client()
instead.
void
gnome_client_connect (GnomeClient *client
);
Causes the client to connect to the session manager. Usually happens automatically; no need to call this function.
void
gnome_client_disconnect (GnomeClient *client
);
Disconnect the client from the session manager.
void gnome_client_set_id (GnomeClient *client
,const gchar *id
);
Set the client's session management ID; must be done before connecting to the session manager. There is usually no reason to call this function.
const gchar *
gnome_client_get_id (GnomeClient *client
);
Returns session management ID
const gchar *
gnome_client_get_previous_id (GnomeClient *client
);
Get the session management ID from the previous session.
Pointer to the session management ID the client had in the last
session, or NULL
if it was not in a previous session.
const gchar *
gnome_client_get_desktop_id (GnomeClient *client
);
Get the client ID of the desktop's current instance, i.e. if
you consider the desktop as a whole as a session managed app, this
returns its session ID using a GNOME extension to session
management. May return NULL
for apps not running under a recent
version of gnome-session; apps should handle that case.
void gnome_client_request_interaction (GnomeClient *client
,GnomeDialogType dialog_type
,GnomeInteractFunction function
,gpointer data
);
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_dialog()
or
gnome_client_save_error_dialog()
. Note, however, that overriding the session
manager specified preference in this way (by using arbitrary dialog boxes)
is not very nice.
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()
.
client |
A GnomeClient object. |
|
dialog_type |
The type of dialog to create. |
|
function |
Callback to invoke to perform the interaction. |
|
data |
Callback data. |
void gnome_client_request_interaction_interp (GnomeClient *client
,GnomeDialogType dialog_type
,GtkCallbackMarshal function
,gpointer data
,GDestroyNotify destroy
);
Similar to gnome_client_request_interaction()
, but used when
you need to destroy the callback data after the interaction.
client |
Pointer to GNOME session client object. |
|
dialog_type |
Type of dialog to show. |
|
function |
Callback to perform the interaction (a GnomeInteractFunction). |
|
data |
Callback data. |
|
destroy |
Function to destroy callback data. |
“connect”
signalvoid user_function (GnomeClient *client, gboolean arg1, gpointer user_data)
Flags: Run First
“disconnect”
signalvoid user_function (GnomeClient *client, gpointer user_data)
Flags: Run First
“save-complete”
signalvoid user_function (GnomeClient *client, gpointer user_data)
Flags: Run First
“save-yourself”
signalgboolean user_function (GnomeClient *client, gint arg1, GnomeSaveStyle arg2, gboolean arg3, GnomeInteractStyle arg4, gboolean arg5, gpointer user_data)
Flags: Run Last
“shutdown-cancelled”
signalvoid user_function (GnomeClient *client, gpointer user_data)
Flags: Run First