GLG Toolkit, JavaScript Library  Version 4.6
GlgIHHandlerInterface Interface Reference

Installable Interface Handler interface. More...

Detailed Description

Installable Interface Handler interface.

GlgIHHandlerInterface objects may be used by the Toolkit to implement functionality of the installable interface handlers. These handlers are used in editor applications, such as the GLG Diagram and GLG Process Diagram demos) that need to handle elaborate user interaction.

Use CreateGlgIHHandlerInterface to create a handler interface that can be used with IHInstall.

A simplified IHInstallAsInterface method can be used to create and install a handler interface.

Public Member Functions

void EntryPoint (GlgObject ih, GlgIHCallEvent call_event)
 The entry point is invoked with the user interface events; its source code implements user interaction logic of the installable event handler. More...
 

Static Public Member Functions

static GlgIHHandlerInterface CreateGlgIHHandlerInterface (Function entry_point_func)
 Constructor. More...
 

Member Function Documentation

◆ CreateGlgIHHandlerInterface()

static GlgIHHandlerInterface CreateGlgIHHandlerInterface ( Function  entry_point_func)
static

Constructor.

Creates a handler interface that can be used with IHInstall. The static method is invoked on the GLG Toolkit handle obtained via a 'new GlgToolkit()' call at the application start-up.

A simplified IHInstallAsInterface method can also be used to create and install a handler interface.

Parameters
entry_point_funcSpecifies function that implements the handler's interaction logic. The function's type signature must match the type signature of the EntryPoint method.
Returns
An opaque internal object representing GlgIHHandlerInterface.

◆ EntryPoint()

void EntryPoint ( GlgObject  ih,
GlgIHCallEvent  call_event 
)

The entry point is invoked with the user interface events; its source code implements user interaction logic of the installable event handler.

Parameters
ihThe
  1. Interface Handler Methods
object.
call_eventA user interface event received by installable interface handlers. The IHGetType and IHGetToken methods can be used to get the event's type and its token.

Refer to the description of the interface handler methods, such as IHInstall, IHStart, etc., for more information.