Jump to content

WPDesktop: Difference between revisions

From EDM2
No edit summary
Ak120 (talk | contribs)
No edit summary
Line 1: Line 1:


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


[[Category:The OS/2 API Project]]
[[Category:The OS/2 API Project]]

Revision as of 13:00, 20 April 2016

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.