GLG Toolkit, C / C++ API Library  Version 4.6
Data Types and Macros

Detailed Description

Macros

#define GLG_IH_CURR
 Specifies the ID of the current handler. More...
 
#define GLG_IH_GLOBAL
 The ID of the global data storage. More...
 
#define GLG_IH_NEW
 Specifies the ID of the just installed handler. More...
 

Typedefs

typedef GlgObject GlgIH
 Opaque type that represents an installable interface handler. More...
 
typedef void * GlgIHCallEvent
 Opaque type that represents installable interface handler events. More...
 
typedef void(* GlgIHEntryPoint) (GlgIH ih, GlgIHCallEvent call_event)
 An entry point that is invoked to handle user interaction logic of an installable interface handler. More...
 
typedef GlgLong GlgIHToken
 An installable interface handler token that identifies the event that needs to be handled. More...
 

Macro Definition Documentation

◆ GLG_IH_CURR

#define GLG_IH_CURR

Specifies the ID of the current handler.

It may be used when no handler ID supplied by the handler's ih parameter is available.

◆ GLG_IH_GLOBAL

#define GLG_IH_GLOBAL

The ID of the global data storage.

This ID can be used to access global data instead of the data of a specific interface handler.

◆ GLG_IH_NEW

#define GLG_IH_NEW

Specifies the ID of the just installed handler.

It can be used to specify the handler after it was created using GlgIHInstall and before it is started with GlgIHStart.

Typedef Documentation

◆ GlgIH

typedef GlgObject GlgIH

Opaque type that represents an installable interface handler.

◆ GlgIHCallEvent

typedef void* GlgIHCallEvent

Opaque type that represents installable interface handler events.

See GlgIHGetType and GlgIHGetToken for more information.

◆ GlgIHEntryPoint

typedef void(* GlgIHEntryPoint) (GlgIH ih, GlgIHCallEvent call_event)

An entry point that is invoked to handle user interaction logic of an installable interface handler.

Parameters
ihThe ID of the handler the entry point function belongs to. This ID can be used to access parameters stored in the handler's data storage.
call_eventThe user interface event to be handled.

The code of this function implements functionality of the handler. See GlgIHStart for an example of a handler code.

◆ GlgIHToken

An installable interface handler token that identifies the event that needs to be handled.

See GlgIHGetToken for more information.