WPDesktop

Class definition file: wpdesk.idl

Class hierarchy SOMObject
WPObject
WPFileSystem
WPFolder
WPDesktop

Description

This is the Workplace desktop object class. An instance of this class can be created as a Workplace object. An instance of this class is created initially by the system. It has the title "Desktop" and initially resides in the root directory of the drive containing the user profile.

Menu ID list

The following list shows the WPMENUID menu IDs for this class:

Menu item text

Menu ID

WPMENUID_LOCKUP

WPMENUID_SHUTDOWN

WPMENUID_SYSTEMSETUP

Instance methods

The following list shows all the WPDesktop methods:

wpAddDesktopArcRest1Page

wpAddDesktopDefDT1Page

wpAddDesktopLockup1Page

wpAddDesktopLockup2Page

wpAddDesktopLockup3Page

wpQueryLockupBackground

wpQueryLockupFullScreen

wpQueryLockupOnStartup

wpSetLockupBackground

wpSetLockupFullScreen

wpSetLockupOnStartup

wpSetLockupTimeout

SOMObject instance methods

The following list shows all the instance methods overridden by the WPObject class. These instance methods are overridden in order to modify the behavior defined by an ancestor class.

somDefaultInit

somDestruct

WPObject instance methods

The following list shows all the methods overridden by the WPDesktop class. These methods are overridden in order to modify the behavior defined by an ancestor class.

wpSetup override by WPDesktop

The following table shows the keyname-value pairs added by the WPDesktop class.

кФФФФФФФФФФФФФФФФФФФФТФФФФФФФФФФФФФФФТФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФПГKEYNAME             ГVALUE          ГDESCRIPTION                        Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГAUTOLOCKUP          ГYES            ГThis sets the auto-lockup feature, Г
Г                    Г               Гso that the keyboard and mouse willГ
Г                    Г               Гautomatically lock up after the    Г
Г                    Г               Гspecified number of minutes of     Г
Г                    Г               Гinactivity.                        Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                    ГNO             ГThis turns off the autolockup      Г
Г                    Г               Гfeature, so that the system will   Г
Г                    Г               Гnot automatically lock the keyboardГ
Г                    Г               Гand mouse, no matter how long they Г
Г                    Г               Гare inactive.                      Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГLOCKUPAUTODIM       ГYES            ГThis sets the autodim feature, so  Г
Г                    Г               Гthat the screen blanks out and a   Г
Г                    Г               Гfloating lock icon is displayed 2  Г
Г                    Г               Гminutes after the keyboard and     Г
Г                    Г               Гmouse are locked.                  Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                    ГNO             ГThis turns off the autodim feature.Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГLOCKUPBACKGROUND    ГN,M,S,B,C      ГThis sets the lockup background,   Г
Г                    Г               Гwhere:                             Г
Г                    Г               ГN = Image file name. This          Г
Г                    Г               Г    name must be the fully-        Г
Г                    Г               Г    qualified path of the          Г
Г                    Г               Г    image file. "(none)"           Г
Г                    Г               Г    or "?:\" is                    Г
Г                    Г               Г    permitted to indicate the      Г
Г                    Г               Г    boot drive.                    Г
Г                    Г               Г                                   Г
Г                    Г               ГM = Image mode. This mode can      Г
Г                    Г               Г    be one of the following:       Г
Г                    Г               Г    N = Normal image               Г
Г                    Г               Г    T = Titled image               Г
Г                    Г               Г    S = Scaled image               Г
Г                    Г               Г                                   Г
Г                    Г               ГS = Scaling factor.                Г
Г                    Г               Г                                   Г
Г                    Г               ГB = Background type. This can      Г
Г                    Г               Г    be one of the following:       Г
Г                    Г               Г    I = Image                      Г
Г                    Г               Г    C = Color only                 Г
Г                    Г               Г                                   Г
Г                    Г               ГC = Background color. This         Г
Г                    Г               Г    color can be 3 numbers re-     Г
Г                    Г               Г    presenting RGB values or       Г
Г                    Г               Г    the default, in the            Г
Г                    Г               Г    following format:              Г
Г                    Г               Г                                   Г
Г                    Г               Г    {R-value G-value B-value}      Г
Г                    Г               Г                                   Г
Г                    Г               ГFor example:                       Г
Г                    Г               Г"BACKGROUND=                       Г
Г                    Г               ГC:\OS2\BITMAP\OS2LOGO.BMP,S,       Г
Г                    Г               Г3,I"                               Г
Г                    Г               Гor                                 Г
Г                    Г               Г"BACKGROUND=                       Г
Г                    Г               Г(none),,,C,0 128 128"              Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГLOCKUPFULLSCREEN    ГYES            ГThis specifies that the entire     Г
Г                    Г               Гscreen is taken up by the lockup   Г
Г                    Г               Гbackground image.  The lockup      Г
Г                    Г               Гbackground specified by the        Г
Г                    Г               ГLOCKUPBACKGROUND keyname is        Г
Г                    Г               Гdisplayed when the system locks theГ
Г                    Г               Гkeyboard and mouse.                Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                    ГNO             ГThis specifies that when the systemГ
Г                    Г               Гlocks up, a message box is to be   Г
Г                    Г               Гdisplayed prompting you to enter   Г
Г                    Г               Гyour lockup password.              Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГLOCKUPONSTARTUP     ГYES            ГThis specifies that the keyboard   Г
Г                    Г               Гand mouse are automatically locked Г
Г                    Г               Гwhen the system is started or      Г
Г                    Г               Гrestarted.                         Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г                    ГNO             ГThis specifies that the keyboard   Г
Г                    Г               Гand mouse are not automatically    Г
Г                    Г               Гlocked when the system is started  Г
Г                    Г               Гor restarted.                      Г
УФФФФФФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
ГLOCKUPTIMEOUT       Гn              ГThis specifies the number of       Г
Г                    Г               Гminutes of keyboard and mouse      Г
Г                    Г               Гinactivity that will cause the     Г
Г                    Г               Гsystem to automatically lock the   Г
Г                    Г               Гkeyboard and mouse.                Г
РФФФФФФФФФФФФФФФФФФФФСФФФФФФФФФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

Class methods

The following list shows the WPDesktop class methods.

WPObject class methods

The following list shows all the class methods overridden by the WPDesktop class. These methods are overridden to modify the behavior defined by an ancestor class.

wpclsQueryDefaultHelp
[Back] [Next]