org.gnu.gnome
Class Client

java.lang.Object
  extended byorg.gnu.glib.Struct
      extended byorg.gnu.glib.GObject
          extended byorg.gnu.gnome.Client

public class Client
extends org.gnu.glib.GObject

The GnomeClient object makes it possible for your application to save session information when the user logs out. If, when logging out, the user chooses to save the current settings, a save_yourself signal is sent to each application. Then an application can save information in such a way that it is supported on the command line whenever the program automatically restarts a user login.


Constructor Summary
Client()
          Create a new session management client and try to connect to a session manager.
 
Method Summary
 void addListener(ClientListener listener)
          Register an object to handle Client events.
 void connect()
          Try to connect to a session manager.
 void disconnect()
          Disconnect from the session manager.
 void flush()
          Flush the underlying connection to the connection manager.
 java.lang.String getConfigPrefix()
          Get the config prefix for a client.
 java.lang.String getDesktopID()
           
 java.lang.Class getEventListenerClass(java.lang.String signal)
           
 org.gnu.glib.EventType getEventType(java.lang.String signal)
           
 ClientFlags getFlags()
          Returns some flags, that give additional information about this client.
 java.lang.String getGlobalConfigPrefix()
          Get the config prefix for clients which have NOT been restarted or cloned.
 java.lang.String getID()
           
 java.lang.String getPreviousID()
           
static org.gnu.glib.Type getType()
          Retrieve the runtime type used by the GLib library.
 void removeListener(ClientListener listener)
          Removes a listener
 void requestPhase2()
           
 void requestSave(SaveStyle saveStyle, boolean shutdown, InteractStyle interactStyle, boolean fast, boolean global)
          Request the session manager to save the session in some way.
 void saveAnyDialog(org.gnu.gtk.Dialog dialog)
           
 void saveErrorDialog(org.gnu.gtk.Dialog dialog)
           
 void setCloneCommand(java.lang.String[] args)
           
 void setCurrentDirectory(java.lang.String dir)
          Sets the directory where all commands are executed.
 void setDiscardCommand(java.lang.String[] args)
           
 void setEnvironment(java.lang.String name, java.lang.String value)
           
 void setGlobalConfigPrefix(java.lang.String prefix)
          Set the value used for the global config prefix.
 void setID(java.lang.String id)
           
 void setPriority(int priority)
          The gnome-session manager includes an extension to the protocol which allows the order in which clients are started up to be organized into a number of run levels.
 void setProcessID(int id)
           
 void setProgram(java.lang.String program)
           
 void setResignCommand(java.lang.String[] args)
           
 void setRestartCommand(java.lang.String[] args)
          Provide the command that should be used to restart this application.
 void setRestartStyle(RestartStyle style)
          The session manager usually only restarts clients which are running when the session was last saved.
 void setShutdownCommand(java.lang.String[] args)
           
 void setUserID(java.lang.String id)
           
 
Methods inherited from class org.gnu.glib.GObject
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addListener, collect, freezeNotify, getBooleanProperty, getData, getDoubleProperty, getFloatProperty, getGObjectFromHandle, getIntProperty, getJavaObjectProperty, getLongProperty, getPixbufProperty, getProperty, getStringProperty, hasProperty, notify, removeEventHandler, removeListener, setBooleanProperty, setData, setDoubleProperty, setFloatProperty, setIntProperty, setJavaObjectProperty, setLongProperty, setPixbufProperty, setProperty, setStringProperty, thawNotify
 
Methods inherited from class org.gnu.glib.Struct
equals, getHandle, getNullHandle, hashCode
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Client

public Client()
Create a new session management client and try to connect to a session manager.

Method Detail

getConfigPrefix

public java.lang.String getConfigPrefix()
Get the config prefix for a client. The 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).


getGlobalConfigPrefix

public java.lang.String getGlobalConfigPrefix()
Get the config prefix for clients which have NOT been restarted or cloned. This config prefix may be used to write the user's preferred config for these "new" clients.

You may 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 user's freedom to configure each instance in a different way so it should be used with caution.


setGlobalConfigPrefix

public void setGlobalConfigPrefix(java.lang.String prefix)
Set the value used for the global config prefix. The config prefixes returned by getGlobalConfigPrefix() are formed by extending this prefix with a 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.


getFlags

public ClientFlags getFlags()
Returns some flags, that give additional information about this client.


setRestartStyle

public void setRestartStyle(RestartStyle style)
The session manager usually only restarts clients which are running when the session was last saved. You can set the restart style to make the manager restart the client: - at the start of every session (RESTART_AWAY) - whenever the client dies (RESTART_IMMEDIATELY) - never (RESTART_NEVER)


setPriority

public void setPriority(int priority)
The gnome-session manager includes an extension to the protocol which allows the order in which clients are started up to be organized into a number of run levels. This method may be used to inform the gnome-session manager of where this client should appear in this run level ordering. The priority runs from 0 (started first) to 99 (started last) and defaults to 50.


setCurrentDirectory

public void setCurrentDirectory(java.lang.String dir)
Sets the directory where all commands are executed.


setRestartCommand

public void setRestartCommand(java.lang.String[] args)
Provide the command that should be used to restart this application.


setDiscardCommand

public void setDiscardCommand(java.lang.String[] args)

setResignCommand

public void setResignCommand(java.lang.String[] args)

setShutdownCommand

public void setShutdownCommand(java.lang.String[] args)

setEnvironment

public void setEnvironment(java.lang.String name,
                           java.lang.String value)

setCloneCommand

public void setCloneCommand(java.lang.String[] args)

setProcessID

public void setProcessID(int id)

setProgram

public void setProgram(java.lang.String program)

setUserID

public void setUserID(java.lang.String id)

saveAnyDialog

public void saveAnyDialog(org.gnu.gtk.Dialog dialog)

saveErrorDialog

public void saveErrorDialog(org.gnu.gtk.Dialog dialog)

requestPhase2

public void requestPhase2()

requestSave

public void requestSave(SaveStyle saveStyle,
                        boolean shutdown,
                        InteractStyle interactStyle,
                        boolean fast,
                        boolean global)
Request the session manager to save the session in some way.


flush

public void flush()
Flush the underlying connection to the connection manager. This is useful if you have some pending changes that you want to make sure get committed.


connect

public void connect()
Try to connect to a session manager. This should only be called after a disconnect().


disconnect

public void disconnect()
Disconnect from the session manager.


setID

public void setID(java.lang.String id)

getID

public java.lang.String getID()

getPreviousID

public java.lang.String getPreviousID()

getDesktopID

public java.lang.String getDesktopID()

getType

public static org.gnu.glib.Type getType()
Retrieve the runtime type used by the GLib library.


addListener

public void addListener(ClientListener listener)
Register an object to handle Client events.

See Also:
ClientListener

removeListener

public void removeListener(ClientListener listener)
Removes a listener

See Also:
addListener(ClientListener)

getEventListenerClass

public java.lang.Class getEventListenerClass(java.lang.String signal)

getEventType

public org.gnu.glib.EventType getEventType(java.lang.String signal)