HImManager.h File Reference

Interface of the HImManager class. More...

#include "HTools.h"

Go to the source code of this file.

Classes

class  HImManager
 The HImManager class serves as a manager for IM callbacks. More...
 

Macros

#define HImRegisterCallback(callback_name, callback_function)
 
#define HImSetCallback(callback_type, callback_name)
 
#define HImSetCallbackByKey(segment_key, callback_type, callback_name)
 
#define HImShowCallback(callback_name, callback_type)
 
#define HImUnSetOneCallback(callback_type)
 
#define HImUnSetOneCallbackByKey(segment_key, callback_type)
 

Detailed Description

Interface of the HImManager class.

Defines the HImManager class along with macros for registering, setting and unsetting callbacks

Macro Definition Documentation

◆ HImRegisterCallback

#define HImRegisterCallback (   callback_name,
  callback_function 
)
Value:
do{ (HImManager::GetCurrentHImManager())->RegisterOneCallback( \
(const char *)callback_name, (void*)callback_function); }while(0);
static HImManager * GetCurrentHImManager()

This method associates a name with a function pointer.

◆ HImSetCallback

#define HImSetCallback (   callback_type,
  callback_name 
)
Value:
do{ (HImManager::GetCurrentHImManager())->SetCallback( \
(const char *)callback_type, (const char *)callback_name); }while(0);
static HImManager * GetCurrentHImManager()

This method associates a callback type with a registered callback function name in the currently open segment.

◆ HImSetCallbackByKey

#define HImSetCallbackByKey (   segment_key,
  callback_type,
  callback_name 
)
Value:
do{ (HImManager::GetCurrentHImManager())->SetCallback( \
segment_key, (const char *)callback_type, (const char *)callback_name); }while(0);
static HImManager * GetCurrentHImManager()

This method associates a callback type with a registered callback function name in the segment specified by segment_key.

◆ HImShowCallback

#define HImShowCallback (   callback_name,
  callback_type 
)
Value:
do{ (HImManager::GetCurrentHImManager())->ShowCallback( \
(const char *)callback_name, (char *)callback_type); }while(0);
static HImManager * GetCurrentHImManager()

This method writes the name of the callback_type assocation into the callback_name in the currently open segment.

◆ HImUnSetOneCallback

#define HImUnSetOneCallback (   callback_type)
Value:
do{ (HImManager::GetCurrentHImManager())->UnSetOneCallback( \
callback_type); }while(0);
static HImManager * GetCurrentHImManager()

This method removes a callback assocation in the currently open segment.

◆ HImUnSetOneCallbackByKey

#define HImUnSetOneCallbackByKey (   segment_key,
  callback_type 
)
Value:
do{ (HImManager::GetCurrentHImManager())->UnSetOneCallback( \
segment_key, (const char *)callback_type); }while(0);
static HImManager * GetCurrentHImManager()

This method removes the callback assocation in a segment specified by segment_key.