IlvMakeMoveInteractor Class Reference

Manager interactor class. More...

#include <ilviews/manager/geointer.h>

Inheritance diagram for IlvMakeMoveInteractor:

Public Member Functions
	IlvMakeMoveInteractor (IlvManager *manager, IlvView *view, unsigned short button=IlvLeftButton)
	Constructor. More...
virtual void	doIt (IlvPos dx, IlvPos dy)
	Action performed to finalize the interaction. More...
virtual void	drawGhost ()
	Visual feedback during interaction. More...
IlUShort	getButton () const
	Gets the button used by the interactor.
virtual IlBoolean	handleEvent (IlvEvent &event)
	Handles keyboard and mouse events. More...
void	setButton (IlUShort b)
	Sets the mouse button used by the interactor. More...
void	useDefaultTransitionScheduler (IlBoolean value=IlTrue, IlUInt duration=1000)
	Tells the interactor whether to use the default transition scheduler to translate the view. More...
Public Member Functions inherited from IlvManagerViewInteractor
	IlvManagerViewInteractor (IlvManager *manager, IlvView *view)
	Initializes a new IlvManagerViewInteractor. More...
virtual void	abort ()
	Aborts the interaction. More...
virtual void	ensureVisible (const IlvPoint &point)
	Ensures the visibility of a given location. More...
IlvDisplay *	getDisplay () const
	Returns the display of the manager view. More...
IlvManager *	getManager () const
	Returns the manager. More...
IlvTransformer *	getTransformer () const
	Returns the transformer used with the manager view. More...
IlvView *	getView () const
	Returns the manager view. More...
virtual void	handleExpose (IlvRegion *clip=0)
	Called when the manager view receives an expose event. More...
virtual void	init ()
	Initialization, when the interactor is attached to a view. More...

Detailed Description

Manager interactor class.

Library: ilvmgr

Use this class to translate a view.

See also

IlvManager, IlvView, IlvTransformer.

Constructor & Destructor Documentation

IlvMakeMoveInteractor()

IlvMakeMoveInteractor::IlvMakeMoveInteractor	(	IlvManager *	manager,
		IlvView *	view,
		unsigned short	button = IlvLeftButton
	)

Constructor.

Initializes a new instance of the IlvMakeMoveInteractor class. Lets you specify the mouse button to use during the interaction.

Parameters

manager	The manager.
view	The manager view.
button	The mouse button to use.

Member Function Documentation

doIt()

virtual void IlvMakeMoveInteractor::doIt ( IlvPos  dx, IlvPos  dy  )

virtual

Action performed to finalize the interaction.

Translates the view by the specified offsets.

Parameters

dx	Horizontal translation offset.
dy	Vertical translation offset.

drawGhost()

virtual void IlvMakeMoveInteractor::drawGhost ( )

virtual

Visual feedback during interaction.

Draws a rectangle in XOR mode. The rectangle has the size of the client area of the view, showing where the translated view would be.

Reimplemented from IlvManagerViewInteractor.

handleEvent()

virtual IlBoolean IlvMakeMoveInteractor::handleEvent ( IlvEvent &  event )

virtual

Handles keyboard and mouse events.

Parameters

event

The event to handle.

Returns

IlTrue if the event is consumed, IlFalse otherwise.

Implements IlvManagerViewInteractor.

setButton()

void IlvMakeMoveInteractor::setButton

(

IlUShort

b

)

Sets the mouse button used by the interactor.

Parameters

b	Specifies the mouse button to use.

useDefaultTransitionScheduler()

void IlvMakeMoveInteractor::useDefaultTransitionScheduler	(	IlBoolean	value = IlTrue,
		IlUInt	duration = 1000
	)

Tells the interactor whether to use the default transition scheduler to translate the view.

Parameters

value	A Boolean value specifying whether to use or not the default transition scheduler to translate the view. If value is IlFalse, no transition scheduler will be used.
duration	The duration that the transition will take to complete. The value is a number of milliseconds.