WPDesktop

From EDM2
Jump to: navigation, search

This is the Desktop WPS Class. This SOM Object is part of the OS/2 Workplace Shell classes.

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.

Default Title
"Desktop"
DLL
PMWP.DLL
Class definition file
wpdesk.idl

Class hierarchy SOMObject

Instance methods

  • wpAddDesktopArcRest1Page
  • wpAddDesktopDefDT1Page
  • wpAddDesktopLockup1Page
  • wpAddDesktopLockup2Page
  • wpAddDesktopLockup3Page
  • wpIsCurrentDesktop
  • wpQueryAutoLockup
  • wpQueryDefaultDropOp
  • wpQueryLockupAutoDim
  • wpQueryLockupBackground
  • wpQueryLockupFullScreen
  • wpQueryLockupOnStartup
  • wpQueryLockupTimeout
  • wpSetAutoLockup
  • wpSetDefaultDropOp
  • wpSetLockupAutoDim
  • wpSetLockupBackground
  • wpSetLockupFullScreen
  • wpSetLockupOnStartup
  • wpSetLockupTimeout

Setup strings for WPDesktop objects (WARP 4)

These are the setup strings for the WPDesktop objects in WARP 4. (see also Set or get the WPS lockup password and Changing the Lockup page entries)

Class WPDesktop
Key Name 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 fullyqualified path of the image file; "(none)" to use no file 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 between 1 and 20

B = Background type. This can be one of the following:

I = Image
C = Color only

C = Background color. This color can be 3 numbers representing 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.
LOCKUPSCREENSAVERMODE YES Lockup acts like a screen saver
(no password is required)
NO Lockup acts like in WARP 3
(you must enter a password to unlock)
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. The default is 3 minutes.

Class methods

The following list shows the WPDesktop class methods.

  • wpclsQueryActiveDesktop
  • wpclsQueryActiveDesktopHWND
  • wpclsQueryObjectFromFrame

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
  • wpclsQueryDefaultView
  • wpclsQueryIconData
  • wpclsQueryIconDataN
  • wpclsQuerySettingsPageSize
  • wpclsQueryStyle
  • wpclsQueryTitle