View source for WpAddMouseMappingsPage

{{DISPLAYTITLE:wpAddMouseMappingsPage}}
This instance method is called to allow the object to add the '''Mappings''' page to its Settings notebook.

==Syntax==
_wpAddMouseMappingsPage(somSelf, hwndNotebook)

==Parameters==
;''somSelf'' ([[WPMouse]] *) - input
:Pointer to the object on which the method is being invoked.
:Points to an object of class WPMouse.

;''hwndNotebook'' ([[HWND]]) - input
:Settings notebook handle.

==Returns==
;''rc'' (ULONG) - returns
:Page identifier.
:A return value of 0 indicates that an error occurred.

==How to Override==
The 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.

==Usage==
This method must be called only from within an override of the [[wpAddSettingsPages]] method.

==Example Code==
<PRE>
#define INCL_WINWORKPLACE
#include <os2.h>

WPMouse      *somSelf;        /* Pointer to the object on which the method is being invoked. */
HWND          hwndNotebook;  /* Settings notebook handle. */
ULONG         rc;            /* Page identifier. */

rc = _wpAddMouseMappingsPage(somSelf, hwndNotebook);
</PRE>
This example overrides the method to eliminate this page from the object's Settings notebook.
<PRE>
SOM_Scope ULONG   SOMLINK MyObj_wpAddMouseMappingsPage(MyObj *somSelf,
                HWND hwndNotebook)
{
    /* MyObjData *somThis = MyObjGetData(somSelf); */
    MyObjMethodDebug("MyObj","MyObj_wpAddMouseMappingsPage");

/* return (parent_wpAddMouseMappingsPage(somSelf,hwndNotebook)); */

    return ( SETTINGS_PAGE_REMOVED );
}
</PRE>

==Related Methods==
* [[wpAddSettingsPages]]
* [[wpInsertSettingsPage]]

[[Category:Workplace Instance Methods]]