Desktop Related Methods

A program or Workplace Shell object would call the following methods to get information about a Desktop object. These methods are not normally overridden.

┌──────────────────────────────┬──────────────────────────────┐
│Method Name                   │Description                   │
├──────────────────────────────┼──────────────────────────────┤
│wpIsCurrentDesktop            │Returns an indication of      │
│                              │whether or not the Desktop    │
│                              │object is the active Desktop. │
├──────────────────────────────┼──────────────────────────────┤
│wpclsQueryActiveDesktop       │Returns the pointer to the    │
│                              │active Desktop object.        │
├──────────────────────────────┼──────────────────────────────┤
│wpclsQueryActiveDesktopHWND   │Returns the window handle for │
│                              │the active Desktop.           │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryAutoLockup             │Returns the current value of  │
│                              │the automatic lockup option.  │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryLockupAutoDim          │Returns the current value of  │
│                              │the lockup auto-dim option.   │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryLockupBackground       │Returns the current values for│
│                              │the lockup background.        │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryLockupFullScreen       │Returns the current value of  │
│                              │the lockup full-screen option.│
├──────────────────────────────┼──────────────────────────────┤
│wpQueryLockupOnStartup        │Returns the current value of  │
│                              │the lockup on the startup     │
│                              │option.                       │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryLockupTimeout          │Returns the current timeout   │
│                              │value for automatic lockup.   │
├──────────────────────────────┼──────────────────────────────┤
│wpclsQueryObjectFromFrame     │Returns the pointer to the    │
│                              │object associated with the    │
│                              │specified frame window.       │
└──────────────────────────────┴──────────────────────────────┘

A program or Workplace Shell object would call the following methods to get information about a Desktop object.

┌──────────────────────────────┬──────────────────────────────┐
│Method Name                   │Description                   │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryDefaultDropOp          │Queries the default drop      │
│                              │operation of objects that are │
│                              │dropped on the Desktop.  The  │
│                              │default is set on the Desktop │
│                              │page of the Desktop's Settings│
│                              │notebook. This method can be  │
│                              │overridden to control the     │
│                              │Desktop's default drop        │
│                              │operation                     │
└──────────────────────────────┴──────────────────────────────┘

A program or Workplace Shell object would call the following methods to get information about a Desktop object. These methods are not normally overridden.

┌──────────────────────────────┬──────────────────────────────┐
│Method Name                   │Description                   │
├──────────────────────────────┼──────────────────────────────┤
│wpSetAutoLockup               │Sets the value of the         │
│                              │automatic lockup option.      │
├──────────────────────────────┼──────────────────────────────┤
│wpSetDefaultDropOp            │Sets the default drop         │
│                              │operation of objects that are │
│                              │dropped on the Desktop.  The  │
│                              │default is set on the Desktop │
│                              │page of the Desktop's Settings│
│                              │notebook.                     │
├──────────────────────────────┼──────────────────────────────┤
│wpSetLockupAutoDim            │Sets the value of the lockup  │
│                              │auto-dim option.              │
├──────────────────────────────┼──────────────────────────────┤
│wpSetLockupBackground         │Sets the current values for   │
│                              │the lockup background.        │
├──────────────────────────────┼──────────────────────────────┤
│wpSetLockupFullScreen         │Sets the value of the lockup  │
│                              │full-screen option.           │
├──────────────────────────────┼──────────────────────────────┤
│wpSetLockupOnStartup          │Sets the value of the lockup  │
│                              │on the startup option.        │
├──────────────────────────────┼──────────────────────────────┤
│wpSetLockupTimeout            │Sets the timeout value for    │
│                              │automatic lockup.             │
└──────────────────────────────┴──────────────────────────────┘


[Back: Data File Related Methods]
[Next: Disk (File-System Device) Related Methods]