rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvReshapeInteractor Class Reference

Interactor to resize graphic objects. More...

#include <ilviews/graphics/inter.h>

Inheritance diagram for IlvReshapeInteractor:
IlvInteractor

Public Member Functions

virtual void doIt (IlvGraphic *object, IlvRect &rect, const IlvTransformer *t=0)
 Finalizes the interaction by resizing the object. More...
 
virtual void drawGhost (IlvRect &rect, IlvView *view)
 Visual feedback during the interaction. More...
 
virtual IlBoolean handleEvent (IlvGraphic *obj, IlvEvent &event, const IlvTransformer *t)
 Handles events received by the interactor. More...
 
virtual void validate (IlvGraphic *obj, IlvRect &rect, const IlvTransformer *t=0)
 Allows you to modify the intermediate rectangle during the interaction. More...
 
- Public Member Functions inherited from IlvInteractor
virtual void abort (IlvGraphic *obj)
 Aborts the interactor. More...
 
virtual IlBoolean accept (const IlvGraphic *obj) const
 Indicates whether the current interactor can be associated with a given object. More...
 
virtual void endOperation ()
 Performs the actions needed when the interaction ends. More...
 
virtual void getCallbackTypes (IlUInt &count, const char *const **names, const IlSymbol *const **types) const
 Gets the number of register callback types for the interactor. More...
 
const char * getRegisteredName () const
 Returns the name of the predefined shared instance. More...
 
IlBoolean isAborted () const
 Indicates whether the current interactor is in an aborted state. More...
 
IlBoolean isInOperation () const
 Indicates whether the current interactor is in an interaction state. More...
 
void lock ()
 Locks the current instance. Increments the counter that is used to know how many objects reference the current instance. More...
 
virtual void startOperation ()
 Performs the actions needed when the interaction starts. More...
 
void unLock ()
 Unlocks the current instance. Decrements the reference counter. When the counter drops down to zero, the current instance is deleted. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvInteractor
static IlvInteractorGet (const char *name, IlBoolean=IlTrue)
 Returns a predefined shared interactor instance. More...
 

Detailed Description

Interactor to resize graphic objects.

Library: views

The IlvReshapeInteractor class lets the user resize an object by dragging its bounding box with the middle mouse button.

The registered name of this interactor is "Reshape".

See Also
IlvMoveInteractor, IlvMoveReshapeInteractor.

Member Function Documentation

virtual void IlvReshapeInteractor::doIt ( IlvGraphic object,
IlvRect rect,
const IlvTransformer t = 0 
)
virtual

Finalizes the interaction by resizing the object.

Called to resize the object to the new geometry provided by rect. After reshaping the object, this method calls the object's callback corresponding to the Reshape symbol.

Parameters
objectThe graphic object.
rectThe rectangle, in the object coordinate system.
tThe transformer applied to the view.
See Also
IlvGraphic::setCallback
virtual void IlvReshapeInteractor::drawGhost ( IlvRect rect,
IlvView view 
)
virtual

Visual feedback during the interaction.

Called to draw a preview image of the resulting user action. It is generally invoked by handleEvent as a response to user events.

Parameters
rectThe rectangle.
viewThe view where the object is displayed.
virtual IlBoolean IlvReshapeInteractor::handleEvent ( IlvGraphic g,
IlvEvent event,
const IlvTransformer t 
)
virtual

Handles events received by the interactor.

This method is the entry point of all events dispatched to this interactor.

Parameters
gThe graphic object that receives the event.
eventThe received event.
tThe transformer applied to the view in which the event occurred.
Returns
IlTrue if the event was successfully handled and IlFalse otherwise.

Implements IlvInteractor.

virtual void IlvReshapeInteractor::validate ( IlvGraphic obj,
IlvRect rect,
const IlvTransformer t = 0 
)
virtual

Allows you to modify the intermediate rectangle during the interaction.

Called for each mouse movement to modify the bounding box. The rectangle is provided in the view coordinate system and can be modified to satisfy any given constraint. When the mouse button is released, the IlvReshapeInteractor::doIt method is called.

Parameters
objThe graphic object.
rectThe rectangle provided by the interaction.
tThe transformer applied to the view.

© 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.