Jump to content

WPDesktop: Difference between revisions

From EDM2
Created page with " ==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 ..."
 
Ak120 (talk | contribs)
35,819 edits
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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.


==Setup strings for WPDesktop objects (WARP 4)==
;Default Title: "Desktop"
;DLL: [[PMWP.DLL]]
;Class definition file: wpdesk.idl


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 hierarchy==
SOMObject
* [[SOMObject]]
** [[WPObject]]
*** [[WPFileSystem]]
**** [[WPFolder]]
***** WPDesktop


==Instance methods==
  Class WPDesktop
*wpAddDesktopArcRest1Page
*wpAddDesktopDefDT1Page
*wpAddDesktopLockup1Page
*wpAddDesktopLockup2Page
*wpAddDesktopLockup3Page
*wpIsCurrentDesktop
*wpQueryAutoLockup
*wpQueryDefaultDropOp
*wpQueryLockupAutoDim
*wpQueryLockupBackground
*wpQueryLockupFullScreen
*wpQueryLockupOnStartup
*wpQueryLockupTimeout
*wpSetAutoLockup
*wpSetDefaultDropOp
*wpSetLockupAutoDim
*wpSetLockupBackground
*wpSetLockupFullScreen
*wpSetLockupOnStartup
*wpSetLockupTimeout


  Key Name         Value         Description
==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)
  AUTOLOCKUP       YES           This sets the auto-lockup feature,
{|class="wikitable"
                                  so that the keyboard and mouse will
|+Class WPDesktop
                                  automatically lock up after the
!Key Name||Value||Description
                                  specified number of minutes of
|-
                                  inactivity.
|rowspan="2"|AUTOLOCKUP
 
|YES
                  NO             This turns off the autolockup
|This sets the auto-lockup feature, so that the keyboard and mouse will automatically lock up after the specified number of minutes of inactivity.
                                  feature, so that the system will
|-
                                  not automatically lock the keyboard
|NO
                                  and mouse, no matter how long they
|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.
                                  are inactive.
|-
 
|rowspan="2"|LOCKUPAUTODIM
  LOCKUPAUTODIM   YES           This sets the autodim feature, so
|YES
                                  that the screen blanks out and a
|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.
                                  floating lock icon is displayed 2
|-
                                  minutes after the keyboard and
|NO
                                  mouse are locked.
|This turns off the autodim feature.
 
|-
                  NO             This turns off the autodim feature.
|LOCKUPBACKGROUND
 
|N,M,S,B,C
  LOCKUPBACKGROUND N,M,S,B,C     This sets the lockup background,
|This sets the lockup background, where:<br />
                                  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.<br /><br />
                                  N = Image file name. This name must be
M = Image mode. This mode can be one of the following:
                                      the fullyqualified path of the
:N = Normal image
                                      image file; "(none)" to use no
:T = Titled image
                                      file or. "?:\" is permitted
:S = Scaled image
                                      to indicate the boot drive.
S = Scaling factor between 1 and 20<br /><br />
 
B = Background type. This can be one of the following:
                                  M = Image mode. This mode can
:I = Image
                                      be one of the following:
:C = Color only
                                        N = Normal image
C = Background color. This color can be 3 numbers representing RGB values or the default, in the following format:
                                        T = Titled image
:{R-value G-value B-value}
                                        S = Scaled image
For example:
 
"BACKGROUND=C:\OS2\BITMAP\OS2LOGO.BMP,S,3,I"
                                  S = Scaling factor between 1 and 20
or
 
"BACKGROUND=(none),,,C,0 128 128"
                                  B = Background type. This can
|-
                                      be one of the following:
|rowspan="2"|LOCKUPFULLSCREEN
                                        I = Image
|YES
                                        C = Color only
|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.
 
|-
                                  C = Background color. This color
|NO
                                      can be 3 numbers representing
|This specifies that when the system locks up, a message box is to be displayed prompting you to enter your lockup password.
                                      RGB values or the default, in
|-
                                      the following format:
|rowspan="2"|LOCKUPSCREENSAVERMODE
 
|YES
                                        {R-value G-value B-value}
|Lockup acts like a screen saver
 
:(no password is required)
                    For example:
|-
                      "BACKGROUND=C:\OS2\BITMAP\OS2LOGO.BMP,S,3,I"
|NO
                    or
|Lockup acts like in WARP 3
                      "BACKGROUND=(none),,,C,0 128 128"
:(you must enter a password to unlock)
 
|-
  LOCKUPFULLSCREEN
|rowspan=2|LOCKUPONSTARTUP
                  YES           This specifies that the entire
|YES
                                  screen is taken up by the lockup
|This specifies that the keyboard and mouse are automatically locked when the system is started or restarted.
                                  background image. The lockup
|-
                                  background specified by the
|NO
                                  LOCKUPBACKGROUND keyname is
|This specifies that the keyboard and mouse are not automatically locked when the system is started or restarted.
                                  displayed when the system locks
|-
                                  the keyboard and mouse.
|LOCKUPTIMEOUT
 
|n
                  NO             This specifies that when the system
|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.
                                  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
==Class methods==
                                  and mouse are automatically locked
The following list shows the WPDesktop class methods.
                                  when the system is started or
*wpclsQueryActiveDesktop
                                  restarted.
*wpclsQueryActiveDesktopHWND
*wpclsQueryObjectFromFrame


                  NO            This specifies that the keyboard
==WPObject class methods==
                                  and mouse are not automatically
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.
                                  locked when the system is started
*wpclsQueryDefaultHelp
                                  or restarted.
*wpclsQueryDefaultView
*wpclsQueryIconData
*wpclsQueryIconDataN
*wpclsQuerySettingsPageSize
*wpclsQueryStyle
*wpclsQueryTitle


  LOCKUPTIMEOUT    n              This specifies the number of
[[Category:WPS Classes]]
                                  minutes of keyboard and mouse
                                  inactivity that will cause the
                                  system to automatically lock the
                                  keyboard and mouse. The default is
                                  3 minutes.

Latest revision as of 01:29, 22 July 2020

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
Retrieved from "https://www.edm2.com/index.php?title=WPDesktop&oldid=74629"