User interface event data. More...

Detailed Description

User interface event data.

This object describes a user interface event received by custom interaction handlers. It is received as the call_event parameter of a handler's EntryPoint method and contains data used by the handler.

Public Attributes
Object	data1
	For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contain the value of the param1 parameter of SendMessage. More...

Object	data2
	For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contain the value of the param2 parameter of SendMessage. More...

Object	data3
	For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contain the value of the param3 parameter of SendMessage. More...

Object	data4
	For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contain the value of the param4 parameter of SendMessage. More...

GlgEvent	event_cs
	For type=NATIVE_EVENT, the native event that triggered the call. More...

GlgObject	event_viewport
	For type=NATIVE_EVENT, the event's viewport. More...

GlgObject	event_vl
	For type=NATIVE_EVENT, the event's light viewport, if any, or the viewport otherwise. More...

bool	flag
	Provides additional details of the HI_SETUP_EVENT and DI_SETUP_EVENT events. More...

GlgObject	glg_object
	The handler's viewport. More...

GlgObject	message
	For type=MESSAGE_EVENT, the message object. More...

String	message_name
	For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contains value of the message parameter of SendMessage. More...

Object	rval
	For message actions (type=MESSAGE_ACTION) triggered by SendMessage, the handler has to set this output parameter to the value that will be passed to the invoking SendMessage to be used as its return value. More...

byte	type
	Call event type, one of the GlgCallEventType constants. More...

bool	used
	For message actions (type=MESSAGE_ACTION) triggered by SendMessage, the handler must set this flag to a non-zero value if it handles the message, otherwise an error message is generated and false is returned by the invoking SendMessage. More...

Member Data Documentation

◆ data1

Object data1

For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contain the value of the param1 parameter of SendMessage.

◆ data2

Object data2

For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contain the value of the param2 parameter of SendMessage.

◆ data3

Object data3

For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contain the value of the param3 parameter of SendMessage.

◆ data4

Object data4

For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contain the value of the param4 parameter of SendMessage.

◆ event_cs

GlgEvent event_cs

For type=NATIVE_EVENT, the native event that triggered the call.

◆ event_viewport

GlgObject event_viewport

For type=NATIVE_EVENT, the event's viewport.

◆ event_vl

GlgObject event_vl

For type=NATIVE_EVENT, the event's light viewport, if any, or the viewport otherwise.

◆ flag

bool flag

Provides additional details of the HI_SETUP_EVENT and DI_SETUP_EVENT events.

For the hierarchy setup events (type=HI_SETUP_EVENT), the flag is set to true when the handler is invoked before hierarchy setup, and set to false when the handler is invoked after the setup.
For the drawing setup events (type=DI_SETUP_EVENT), the flag is set to true on the first drawing setup after the hierarchy setup.

◆ glg_object

GlgObject glg_object

The handler's viewport.

◆ message

GlgObject message

For type=MESSAGE_EVENT, the message object.

This message object may be sent by the children input objects inside the handler's viewport. It has the same content as the message object used by the InputCallback.

◆ message_name

String message_name

For message actions (type=MESSAGE_ACTION) triggered by SendMessage, contains value of the message parameter of SendMessage.

◆ rval

Object rval

For message actions (type=MESSAGE_ACTION) triggered by SendMessage, the handler has to set this output parameter to the value that will be passed to the invoking SendMessage to be used as its return value.

◆ type

byte type

Call event type, one of the GlgCallEventType constants.

◆ used

bool used

For message actions (type=MESSAGE_ACTION) triggered by SendMessage, the handler must set this flag to a non-zero value if it handles the message, otherwise an error message is generated and false is returned by the invoking SendMessage.