XfceSMClient

XfceSMClient — Session management client

Stability Level

Stable, unless otherwise indicated

Types and Values

Object Hierarchy

    GEnum
    ├── XfceSMClientRestartStyle
    ├── XfceSMClientShutdownHint
    ╰── XfceSmCLientErrorEnum

Includes

#include <libxfce4ui/libxfce4ui.h>

Description

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.

Functions

Types and Values

enum XfceSMClientPriority

Some sample priority values for use with xfce_sm_client_set_priority().

Members

XFCE_SM_CLIENT_PRIORITY_HIGHEST

A 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_CORE

A priority value for use by applications that place windows on the screen and possibly set window manager struts.

 

XFCE_SM_CLIENT_PRIORITY_DESKTOP

A priority value for use by applications that draw on the desktop.

 

XFCE_SM_CLIENT_PRIORITY_DEFAULT

A priority value for regular applications.

 

XFCE_SM_CLIENT_PRIORITY_LOWEST

The lowest possible priority value.

 

enum XfceSMClientRestartStyle

An enumeration describing how the session manager should restart the application.

Members

XFCE_SM_CLIENT_RESTART_NORMAL

Only restart the application if it is still running when the session is next saved.

 

XFCE_SM_CLIENT_RESTART_IMMEDIATELY

Immediately restart the application if it ever quits.

 

enum XfceSMClientShutdownHint

Hints to the session manager what kind of shutdown the session manager should perform.

Members

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 XfceSmCLientErrorEnum

Error codes returned by XfceSmCLient functions.

Members

XFCE_SM_CLIENT_ERROR_FAILED

Failed to connect to the session manager.

 

XFCE_SM_CLIENT_ERROR_INVALID_CLIENT

Session does not have a valid client id.