wpAddDesktopDefDT1Page
This method is specific to version 3, or higher, of the OS/2 operating system.
This instance method is called to allow the object to add the Desktop page to the Settings notebook.
Syntax
_wpAddDesktopDefDT1Page(somSelf, hwndNotebook)
Parameters
- somSelf (WPDesktop *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPDesktop.
- hwndNotebook (HWND) - input
- Settings notebook handle.
Returns
- rc (ULONG) - returns
- Page identifier.
- 0 Error occurred
- PageId Identifier for the inserted page.
Usage
This method must be called only from within an override of the wpAddSettingsPages method.
How to Override
This method should always be overridden to replace or remove the Desktop page from the object's Settings notebook. To remove the page from the Settings notebook, the override method should return SETTINGS_PAGE_REMOVED without calling the parent method. To replace the page with another page, the override method should call the wpInsertSettingsPage method without calling the parent method.
Example Code
#define INCL_WINWORKPLACE #include <os2.h> WPDesktop *somSelf; /* Pointer to the object on which the method is being invoked. */ HWND hwndNotebook; /* Settings notebook handle. */ ULONG rc; /* Page identifier. */ rc = _wpAddDesktopDefDT1Page(somSelf, hwndNotebook);
This example overrides the method to eliminate this page from the object's Settings notebook.
SOM_Scope ULONG SOMLINK MyObj_wpAddDesktopDefDT1Page(MyObj *somSelf,
HWND hwndNotebook)
{
/* MyObjData *somThis = MyObjGetData(somSelf); */
MyObjMethodDebug("MyObj","MyObj_wpAddDesktopDefDT1Page");
/* return (parent_wpAddDesktopDefDT1Page(somSelf,hwndNotebook)); */
return ( SETTINGS_PAGE_REMOVED );
}