example_hooks.cpp

This is an example of how to use the hooks in a GPI to get notifications of ShapeUp events.

#include <ShapeUpAPI.h>

SURESULT __cdecl fnInit(SUExport *pExport)
{
    ...

    // Set-up our hook callback
    pExport->import.pfnHook = HookFunc;

    // In this example we send a zero as user data to the various
    // ShapeUp_AddXxxHook() functions. You can specify any value,
    // and this value can later be found when the hook function
    // is called.

    // We want notification when the user presses our toolbar buttons
    ShapeUp_AddToolBarButtonHook(0);

    // The idle hook is used to set the state of toolbar buttons (disabled/checked/...)
    ShapeUp_AddIdleHook(0);

    // We want notification when the user presses the left mouse button in the map window
    ShapeUp_AddLButtonDownHook(0);

    // We want notification when the user removes a layer from a workspace
    ShapeUp_AddRemoveLayerHook(0);

    ...
}

// ShapeUp will call this function when an event occurs
SURESULT __cdecl HookFunc(SUHANDLE hWorkspace, int hookType, SUHookData *args)
{
    AFX_MANAGE_STATE(AfxGetStaticModuleState());

    // args->userData contains the value specified when adding the hook
    // The args pointer is interpreted differently for different hook types.
    // For more info check the various hook type values.

    switch (hookType)
    {
    case HOOKTYPE_TOOLBARBUTTON:
        return OnToolBarButton(hWorkspace, (SUToolBarButtonHookData*) args);
    case HOOKTYPE_IDLE:
        return OnIdle(hWorkspace, args);
    case HOOKTYPE_LBUTTONDOWN:
        return OnLButtonDown(hWorkspace, (SUMouseHookData*) args);
    case HOOKTYPE_PREREMOVETHEME:
        return OnRemoveTheme(hWorkspace, (SUPreRemoveThemeHookData*) args);
    case ...:
        break;
    default:
        break;
    }

    return SURESULT_OK;
}

---