The HImManager class serves as a manager for IM callbacks.
More...
#include <HImManager.h>
|
virtual void | RegisterCallbacks () |
| This sets the default MVO callbacks.
|
|
virtual void | RegisterOneCallback (const char *callback_name, void *callback) |
|
virtual void | SetCallback (HC_KEY segment_key, const char *callback_type, const char *callback_name) |
|
virtual void | SetCallback (const char *callback_type, const char *callback_name) |
|
virtual void | ShowCallback (const char *callback_type, char *callback) |
|
virtual void | UnSetOneCallback (HC_KEY segment_key, const char *callback_type) |
|
virtual void | UnSetOneCallback (const char *callback_type) |
|
The HImManager class serves as a manager for IM callbacks.
HImManager is created on demand by HDB and should be accessed with the HIm macro's rather than directly with function calls. These should be used instead of HIC_ calls to allow MVO to function correctly.
This class is currently not much more than a wrapper over HIC_ calls. But should be used because future features may require it.
See HIC_ documentation for greater understanding of HOOPS IM in general.
◆ GetCurrentHImManager()
static HImManager* HImManager::GetCurrentHImManager |
( |
| ) |
|
|
static |
◆ RegisterOneCallback()
virtual void HImManager::RegisterOneCallback |
( |
const char * |
callback_name, |
|
|
void * |
callback |
|
) |
| |
|
virtual |
This method sets one callback. It should not be used directly but through the HImRegisterCallback macro instead.
- Parameters
-
callback_name | A null terminated string with the callback name. |
callback | A pointer to the callback function cast to a void * |
◆ SetCallback() [1/2]
virtual void HImManager::SetCallback |
( |
HC_KEY |
segment_key, |
|
|
const char * |
callback_type, |
|
|
const char * |
callback_name |
|
) |
| |
|
virtual |
This is a wrapper around HC_Set_Callback(). It should not be used directly but through the HImRegisterCallbackByKey macro instead.
- Parameters
-
segment_key | A segment to set the callback on. |
callback_type | A null terminated string with the callback type these are documented with HIC. |
callback_name | A null terminated string with the callback name. |
◆ SetCallback() [2/2]
virtual void HImManager::SetCallback |
( |
const char * |
callback_type, |
|
|
const char * |
callback_name |
|
) |
| |
|
virtual |
This is a wrapper around HC_Set_Callback(). It should not be used directly but through the HImRegisterCallback macro instead. This sets the callback in the currently open segment.
- Parameters
-
callback_type | A null terminated string with the callback type these are documented with HIC. |
callback_name | A null terminated string with the callback name. |
◆ ShowCallback()
virtual void HImManager::ShowCallback |
( |
const char * |
callback_type, |
|
|
char * |
callback |
|
) |
| |
|
virtual |
This is a wrapper around HC_Set_Callback(). It should not be used directly but thought the HImShowOneCallback macro instead. It operates on the curently open segment.
- Parameters
-
callback_type | A null terminated string with the callback type these are documented with HIC. |
callback | This is a write back string with the currently set callback for specified type |
◆ UnSetOneCallback() [1/2]
virtual void HImManager::UnSetOneCallback |
( |
HC_KEY |
segment_key, |
|
|
const char * |
callback_type |
|
) |
| |
|
virtual |
This is a wrapper around HC_Set_Callback(). It should not be used directly but through the HImUnSetOneCallbackByKey macro instead.
- Parameters
-
segment_key | A segment to unset the callback on. |
callback_type | A null terminated string with the callback type these are documented with HIC. |
◆ UnSetOneCallback() [2/2]
virtual void HImManager::UnSetOneCallback |
( |
const char * |
callback_type | ) |
|
|
virtual |
This is a wrapper around HC_Set_Callback(). It should not be used directly but through the HImUnSetOneCallback macro instead.
- Parameters
-
callback_type | A null terminated string with the callback type these are documented with HIC. |
The documentation for this class was generated from the following file: