ImageGear Professional v18.2 > API Reference Guide > ARTGUI Component API Reference > ARTGUI Component Callback Functions Reference > LPFNART_GUI_TOOLBARNOTIFYFUNC |
This callback, if registered, gets called when a user presses a button on the toolbar, or when the toolbar is closed via the close menu or 'x' on the mini-menu bar.
Copy Code
|
|
---|---|
typedef BOOL (FAR PASCAL* LPFNART_GUI_TOOLBARNOTIFYFUNC)( LPVOID lpPrivate, DWORD dwButtonID, UINT nReason ); |
Name | Type | Description |
lpPrivate | LPVOID | A far pointer to private data being passed to the callback. |
dwButtonID | DWORD | The ID for the button that was pressed. These are defined in ARTGUI.H and begin with ART_BUTTON_. |
nReason | UINT | The reason that the callback is being called. These are defined in ARTGUI.H and include: ART_GUI_TOOLBAR_BUTTON_SELECTED, ART_GUI_TOOLBAR_NONE_SELECTED, ART_GUI_TOOLBAR_HIDDEN, ART_GUI_TOOLBAR_DESTROYED, |
The return value is ignored at this time.
This function does not process image pixels.
None
In order to use this callback, it must be registered with ART using the ART_callback_register() function. |
This callback passes dwButtonID and nReason to let you know what triggered the callback. dwButtonID is the button that was pressed. Each button has a unique ID:
ART_GUI_TOOLBAR_BUTTON_SELECTED | The button dwButtonID was pressed. |
ART_GUI_TOOLBAR_NONE_SELECTED | The user presses a button; no other buttons are pressed. |
ART_GUI_TOOLBAR_HIDDEN | The user pressed 'x' or closed the toolbar. |
ART_GUI_TOOLBAR_DESTROYED | The developer called the Windows API function DestroyWindow() and passed the handle of the toolbar window. |