GLG Toolkit, C / C++ API Library  Version 4.6

Detailed Description

Functions

GlgIH GlgIHGetCurrIH (void)
 Retrieves ID of the current active interface handler. More...
 
GlgIHEntryPoint GlgIHGetFunction (GlgIH ih)
 Returns function that implements the handler's logic. More...
 
GlgIHEntryPoint GlgIHGetPrevFunction (void)
 Returns function used to implement the parent handler of the currently active handler. More...
 
GlgIH GlgIHGetPrevIH (void)
 Retrieves ID of the currently active interface handler's parent handler. More...
 

Function Documentation

◆ GlgIHGetCurrIH()

GlgIH GlgIHGetCurrIH ( void  )

Retrieves ID of the current active interface handler.

The current active handler can also be accessed by using GLG_IH_CURR macro.

Returns
The current handler's ID.

◆ GlgIHGetFunction()

GlgIHEntryPoint GlgIHGetFunction ( GlgIH  ih)

Returns function that implements the handler's logic.

Parameters
ihHandler ID.
Returns
The handler's function.

The GLG_IH_CURR macro can be used as the ih parameter to access the current handler. The following example demonstrates the use of GlgIHGetFunction to identify the currently active handler.

extern GlgIHEntryPoint MyIH;
if( GlgIHGetFunction( GLG_IH_CURR ) == MyIH )
...
void(* GlgIHEntryPoint)(GlgIH ih, GlgIHCallEvent call_event)
An entry point that is invoked to handle user interaction logic of an installable interface handler.
Definition: GlgApi.h:11731
#define GLG_IH_CURR
Specifies the ID of the current handler.
Definition: GlgApi.h:11760
GlgIHEntryPoint GlgIHGetFunction(GlgIH ih)
Returns function that implements the handler's logic.

◆ GlgIHGetPrevFunction()

GlgIHEntryPoint GlgIHGetPrevFunction ( void  )

Returns function used to implement the parent handler of the currently active handler.

Returns
The parent handler's function.

The parent handler is the handler preceding the current handler on the handler stack.

◆ GlgIHGetPrevIH()

GlgIH GlgIHGetPrevIH ( void  )

Retrieves ID of the currently active interface handler's parent handler.

The parent handler is the handler preceding the current active handler on the stack of installed handlers.

Returns
The parent handler's ID.