LSMouseEvent Class Reference

The LSMouseEvent class represents events which indicate that some mouse action occurred in a view. More...

#include <lsmouseevent.h>

Inheritance diagram for LSMouseEvent:

Public Member Functions
	LSMouseEvent (ref_ptr< LSView > view, unsigned flags, POINT point)
	Constructor. More...
unsigned	getFlags () const
	Get the flags which indicate whether virtual keys are down. More...
POINT	getPoint () const
	Get the the x- and y- coordinate of the cursor. More...
Public Member Functions inherited from LSViewEvent
	LSViewEvent (ref_ptr< LSView > view)
	Constructor. More...
ref_ptr< LSView >	getView () const
	Gets the view instance for which the event is triggered. More...
Public Member Functions inherited from LSEvent
	LSEvent ()
	Constructor. More...
virtual	~LSEvent ()
	Destructor. More...
bool	isConsumed () const
	Query whether this event has been consumed. More...
void	consume ()
	Consumes this event if the event can be consumed. More...

Additional Inherited Members
Protected Member Functions inherited from LSRefType
void	ref () const
	Increments the internal reference counter. More...
void	unref () const
	Decrements the internal reference counter. More...

Detailed Description

The LSMouseEvent class represents events which indicate that some mouse action occurred in a view.

Version

SCENE API Version 2.0.0.

Constructor & Destructor Documentation

LSMouseEvent()

LSMouseEvent	(	ref_ptr< LSView >	view,
		unsigned	flags,
		POINT	point
	)

Constructor.

Parameters

view	The view for which the event was triggered
flags	Indicates whether various virtual keys are down.
point	Specifies the x- and y-coordinate of the cursor.

Version

SCENE API Version 2.0.0.

Member Function Documentation

getFlags()

unsigned getFlags

(

)

const

Get the flags which indicate whether virtual keys are down.

Returns

The flags which indicate whether virtual keys are down. This parameter can be any combination of the following values:

• MK_CONTROL - Set if the CTRL key is down.
• MK_LBUTTON - Set if the left mouse button is down.
• MK_MBUTTON - Set if the middle mouse button is down.
• MK_RBUTTON - Set if the right mouse button is down.
• MK_SHIFT - Set if the SHIFT key is down.

Version

SCENE API Version 2.0.0.

getPoint()

POINT getPoint

(

)

const

Get the the x- and y- coordinate of the cursor.

Returns

The the x- and y- coordinate of the cursor.

Version

SCENE API Version 2.0.0.