Class Documentation

Name:WinState
Version:1.0
ID:ID_WINSTATE
Status:Unspecified
Category:Command
Date:April 2001
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2000-2001. All rights reserved.



Description

The WinState class has been specially developed to save the window states of X11 programs at shutdown, storing them until they can be restarted at a later time. Its usefulness only extends as far as X11 based Linux systems, and other Athene systems do not benefit from its use.

To store the current state of X11 programs, use this DML code:

  <winstate save/>

To restore the X11 programs, use this DML code:

  <winstate restore/>

It is recommended that the WinState class is only used during shutdown and startup operations. The benefit of using it in other circumstances is questionable.

Actions

The WinState class supports the following actions:

Activate  Saves window states.
ClosingTag  If the object is non-static, this action will save the window states and then the object will self-destruct.

Structure

The WinState object consists of the following public fields:

Location  Sets the location for the WinState configuration file.
Restore  Set to TRUE if the WinState object should restore the X11 programs.
Save  Set to TRUE if the object should save the configurations of running X11 programs.
Static  Set to TRUE to make the object static.
Field:Location
Synonyms:Src
Short:Sets the location for the WinState configuration file.
Type:STRING
Status:Read/Write

If you want the WinState configuration file to be stored in a specific file rather than the default location, set this field to the location that you prefer.

 

Field:Restore
Short:Set to TRUE if the WinState object should restore the X11 programs.
Type:BOOLEAN
Status:Read/Write

If you want the WinState object to restore the X11 programs defined in the configuration file, set this field to TRUE. Note that if no configuration information is found in the source file, then the restoration process will do nothing.

 

Field:Save
Short:Set to TRUE if the object should save the configurations of running X11 programs.
Type:BOOLEAN
Status:Read/Write

If you want to save the status of currently running X11 programs, set this field to TRUE. This has the effect of automatically turning off the Restore field if it is on.

By default the WinState object will save the window states anyway, so in most cases it is not necessary to set the Save field if you do not wish to.

 

Field:Static
Short:Set to TRUE to make the object static.
Type:BOOLEAN
Status:Read/Init

By default, a WinState object will activate itself and then self-destruct when a closing tag is received. If you would rather that the object stays in the system, set this field to TRUE. If you do this, the only way to get the WinState object to perform is to call the Activate() action.