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
IlvMakeReliefRectangleInteractor Class Reference

Manager interactor class. More...

#include <ilviews/manager/mkrelfin.h>

Inheritance diagram for IlvMakeReliefRectangleInteractor:
IlvDragRectangleInteractor IlvManagerViewInteractor

Public Member Functions

 IlvMakeReliefRectangleInteractor (IlvManager *manager, IlvView *view, IlUShort button=IlvLeftButton, IlBoolean snap=IlTrue)
 Constructor. More...
 
 IlvMakeReliefRectangleInteractor (IlUShort button=IlvLeftButton, IlBoolean snap=IlTrue)
 Constructor. More...
 
virtual void doIt (IlvRect &rect)
 Finalizes the interaction by creating an IlvReliefRectangle object. More...
 
virtual void drawGhost ()
 Visual feedback during the interaction. More...
 
IlUShort getThickness () const
 Returns the relief thickness. More...
 
void setThickness (IlUShort t)
 Sets the thickness used to create the IlvReliefRectangle object. More...
 
- Public Member Functions inherited from IlvDragRectangleInteractor
 IlvDragRectangleInteractor (IlvManager *manager, IlvView *view, IlUShort button=IlvLeftButton, IlBoolean snap=IlTrue)
 Constructor. More...
 
virtual void abort ()
 Abort the interaction. More...
 
virtual void doPoint (const IlvPoint &p)
 Called when the selected rectangle is reduced to a point. More...
 
IlvRectgetRectangle ()
 Returns the selected rectangle. More...
 
virtual void handleEvent (IlvEvent &event)
 Handles keyboard and mouse events. More...
 
virtual void init ()
 Initialization, when the interactor is attached to a view. More...
 
- Public Member Functions inherited from IlvManagerViewInteractor
 IlvManagerViewInteractor (IlvManager *manager, IlvView *view)
 Constructor. 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...
 

Detailed Description

Manager interactor class.

Library: ilvmgr

Use this class to allow the user to create an IlvReliefRectangle object.

See Also
IlvManager, IlvMakeRectangleInteractor, IlvMakeReliefDiamondInteractor, IlvMakeRoundRectangleInteractor, IlvMakeEllipseInteractor, IlvMakeBitmapInteractor, IlvReliefRectangle.

Constructor & Destructor Documentation

IlvMakeReliefRectangleInteractor::IlvMakeReliefRectangleInteractor ( IlvManager manager,
IlvView view,
IlUShort  button = IlvLeftButton,
IlBoolean  snap = IlTrue 
)

Constructor.

Initializes a new instance of the IlvMakeReliefRectangleInteractor class.

Parameters
managerThe manager.
viewThe manager view.
buttonSpecifies the pointing device button used for dragging the rectangle.
snapIf set to IlTrue, the rectangle snaps to the manager grid points. Otherwise it does not.
IlvMakeReliefRectangleInteractor::IlvMakeReliefRectangleInteractor ( IlUShort  button = IlvLeftButton,
IlBoolean  snap = IlTrue 
)

Constructor.

Initializes a new instance of the IlvMakeReliefRectangleInteractor class.

Parameters
buttonSpecifies the pointing device button used for dragging the rectangle.
snapIf set to IlTrue, the rectangle snaps to the manager grid points. Otherwise it does not.

Member Function Documentation

virtual void IlvMakeReliefRectangleInteractor::doIt ( IlvRect rect)
virtual

Finalizes the interaction by creating an IlvReliefRectangle object.

Creates a new IlvReliefRectangle object in the manager from the rectangle provided during the interaction.

Parameters
rectThe rectangle.

Reimplemented from IlvDragRectangleInteractor.

virtual void IlvMakeReliefRectangleInteractor::drawGhost ( )
virtual

Visual feedback during the interaction.

Draws a rectangle using a special palette of the IlvManager object that draws in XOR mode.

Reimplemented from IlvDragRectangleInteractor.

IlUShort IlvMakeReliefRectangleInteractor::getThickness ( ) const

Returns the relief thickness.

Returns
The thickness used to create the IlvReliefRectangle object.
void IlvMakeReliefRectangleInteractor::setThickness ( IlUShort  t)

Sets the thickness used to create the IlvReliefRectangle object.

Parameters
tThe new thickness value.

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