ILDisplayEvents Interface Reference

The events for LDisplay control. Note: This interface is currently not available on Linux / MacOS platform. More...

Inheritance diagram for ILDisplayEvents:

Public Member Functions
void	KeyDown (int keyCode, LPVKeyboardModifiers modifiers)
void	KeyUp (int keyCode, LPVKeyboardModifiers modifiers)
void	MouseDoubleClick (LPVMouseButton buttons, LPVKeyboardModifiers modifiers, int x, int y)
void	MouseDown (LPVMouseButton buttons, LPVKeyboardModifiers modifiers, int x, int y)
void	MouseMove (LPVMouseButton buttons, LPVKeyboardModifiers modifiers, int x, int y)
void	MouseUp (LPVMouseButton buttons, LPVKeyboardModifiers modifiers, int x, int y)
void	MouseWheel (LPVMouseButton buttons, LPVKeyboardModifiers modifiers, int x, int y, int delta)
void	Refreshed ()
void	RegionDragFinished (int regionId)
void	RegionDragging (int regionId)
void	RegionRemoving (int regionId)
void	RegionRemovingAll ()

Detailed Description

The events for LDisplay control. Note: This interface is currently not available on Linux / MacOS platform.

Member Function Documentation

KeyDown()

void KeyDown	(	int	keyCode,
		LPVKeyboardModifiers	modifiers
	)

Fires when the user presses a key down and the display control has the keyboard focus.

Parameters

[in]	keyCode	The virtual-key codes of the pressed keys. See Virtual-Key Codes.
[in]	modifiers	The modifier keys pressed

KeyUp()

void KeyUp	(	int	keyCode,
		LPVKeyboardModifiers	modifiers
	)

Fires when the user releases a key and the display control has the keyboard focus.

Parameters

[in]	keyCode	The virtual-key codes of the pressed keys. See Virtual-Key Codes.
[in]	modifiers	The modifier keys pressed

MouseDoubleClick()

void MouseDoubleClick	(	LPVMouseButton	buttons,
		LPVKeyboardModifiers	modifiers,
		int	x,
		int	y
	)

Fires when the user double click a mouse button on the display control

Parameters

[in]	buttons	The double clicked mouse buttons, could be one or multiple buttons.
[in]	modifiers	The modifier keys pressed
[in]	x	The x-coordinate of the cursor position, relative to the upper-left corner of the display control's client area
[in]	y	The y-coordinate of the cursor position, relative to the upper-left corner of the display control's client area

MouseDown()

void MouseDown	(	LPVMouseButton	buttons,
		LPVKeyboardModifiers	modifiers,
		int	x,
		int	y
	)

Fires when the user presses a mouse button on the display control

Parameters

[in]	buttons	The pressed mouse buttons, could be one or multiple buttons.
[in]	modifiers	The modifier keys pressed
[in]	x	The x-coordinate of the cursor position, relative to the upper-left corner of the display control's client area
[in]	y	The y-coordinate of the cursor position, relative to the upper-left corner of the display control's client area

MouseMove()

void MouseMove	(	LPVMouseButton	buttons,
		LPVKeyboardModifiers	modifiers,
		int	x,
		int	y
	)

Fires when the user moves the mouse over the display control

Parameters

[in]	buttons	The pressed mouse buttons when moving, could be one or multiple buttons.
[in]	modifiers	The modifier keys pressed
[in]	x	The x-coordinate of the cursor position, relative to the upper-left corner of the display control's client area
[in]	y	The y-coordinate of the cursor position, relative to the upper-left corner of the display control's client area

MouseUp()

void MouseUp	(	LPVMouseButton	buttons,
		LPVKeyboardModifiers	modifiers,
		int	x,
		int	y
	)

Fires when the user releases a mouse button on the display control

Parameters

[in]	buttons	The released mouse buttons, should be only one button.
[in]	modifiers	The modifier keys pressed
[in]	x	The x-coordinate of the cursor position, relative to the upper-left corner of the display control's client area
[in]	y	The y-coordinate of the cursor position, relative to the upper-left corner of the display control's client area

MouseWheel()

void MouseWheel	(	LPVMouseButton	buttons,
		LPVKeyboardModifiers	modifiers,
		int	x,
		int	y,
		int	delta
	)

Fires when the user scrolls the mouse wheel on the display control

Parameters

[in]	buttons	The pressed mouse buttons when scrolling, could be one or multiple buttons.
[in]	modifiers	The modifier keys pressed
[in]	x	The x-coordinate of the cursor position, relative to the upper-left corner of the display control's client area
[in]	y	The y-coordinate of the cursor position, relative to the upper-left corner of the display control's client area
[in]	delta	the distance the wheel is scrolled

Refreshed()

void Refreshed

(

)

Fires when the display control has been redrawn.

RegionDragFinished()

void RegionDragFinished

(

int

regionId

)

Fires when the user released the left mouse button and finished dragging a region object.

Parameters

[in]

regionId

The region item's ID, you can then get back the object via GetRegionByID().

RegionDragging()

void RegionDragging

(

int

regionId

)

Fires when the user is dragging a region object.

Parameters

[in]

regionId

The region item's ID, you can then get back the object via GetRegionByID().

RegionRemoving()

void RegionRemoving

(

int

regionId

)

Fires before the region is removed from the display control

Parameters

[in]

regionId

The region item's ID, you can then get back the object via GetRegionByID().

RegionRemovingAll()

void RegionRemovingAll

(

)

Fires before the all regions are removed from the display control