wpAddKeyboardMappingsPage
This instance method is called to allow the object to add the Mappings page to its Settings notebook.
Syntax
_wpAddKeyboardMappingsPage(somSelf, hwndNotebook);
Parameters
- somSelf (WPKeyboard *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPKeyboard.
- 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 in order to replace or remove the Mappings 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
Definition:
#define INCL_WINWORKPLACE #include <os2.h> WPKeyboard *somSelf; /* Pointer to the object on which the method is being invoked. */ HWND hwndNotebook; /* Settings notebook handle. */ ULONG rc; /* Page identifier. */ rc = _wpAddKeyboardMappingsPage(somSelf, hwndNotebook);
This example overrides the method to eliminate this page from the object's Settings notebook.
SOM_Scope ULONG SOMLINK MyObj_wpAddKeyboardMappingsPage(MyObj *somSelf,
HWND hwndNotebook)
{
/* MyObjData *somThis = MyObjGetData(somSelf); */
MyObjMethodDebug("MyObj","MyObj_wpAddKeyboardMappingsPage");
/* return (parent_wpAddKeyboardMappingsPage(somSelf,hwndNotebook)); */
return ( SETTINGS_PAGE_REMOVED );
}