rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Manager Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvMakeMoveInteractor Class Reference

Manager interactor class. More...

#include <ilviews/manager/geointer.h>

Inheritance diagram for IlvMakeMoveInteractor:
IlvManagerViewInteractor

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 void handleEvent (IlvEvent &event)
 Handles keyboard and mouse events. More...
 
void setButton (IlUShort b)
 Sets the 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)
 Constructor. More...
 
virtual void abort ()
 Aborts the interaction. More...
 
virtual void ensureVisible (const IlvPoint &point)
 Ensures the visibility of a given location. More...
 
IlvDisplaygetDisplay () const
 Returns the display of the manager view. More...
 
IlvManagergetManager () const
 Returns the manager. More...
 
IlvTransformergetTransformer () const
 Returns the transformer used with the manager view. More...
 
IlvViewgetView () 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 ( 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
managerThe manager.
viewThe manager view.
buttonThe mouse button to use.

Member Function Documentation

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

Action performed to finalize the interaction.

Translates the view by the specified offsets.

Parameters
dxHorizontal translation offset.
dyVertical translation offset.
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.

virtual void IlvMakeMoveInteractor::handleEvent ( IlvEvent event)
virtual

Handles keyboard and mouse events.

Parameters
eventThe event to handle.

Implements IlvManagerViewInteractor.

void IlvMakeMoveInteractor::setButton ( IlUShort  b)

Sets the button used by the interactor.

Parameters
buttonSpecifies the button to use.
void IlvMakeMoveInteractor::useDefaultTransitionScheduler ( IlBoolean  value = IlTrue,
IlUInt  duration = 1000 
)

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

Parameters
valueA 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.
durationThe duration that the transition will take to complete. The value is a number of milliseconds.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.