An interactor that controls the visible area of a view by using a movable rectangle in another view. More...

#include <ilviews/manager/magview.h>

Inheritance diagram for IlvManagerMagViewInteractor:

Public Member Functions
virtual void	abort ()
	Aborts the interaction. More...

virtual void	adjustView (const IlvRect &rect)
	Adjusts the visible area of the target view according to the specified control rectangle. More...

virtual void	computeRectangle ()
	Computes the internal control rectangle according to the overview and the target transformer.

IlvDrawSelection *	getDrawSelection ()
	Returns the selection object used by the interactor in resizing mode. More...

IlvGraphic *	getGraphic () const
	Returns the graphic object used by the interactor as the magnifier. More...

IlvView *	getTarget () const
	Returns the target view of the interactor. More...

virtual void	handleEvent (IlvEvent &event)
	Handles events for the manager view. More...

virtual void	init ()
	Initialization, when the interactor is attached to a view. More...

IlBoolean	isAutoTranslating () const
	Checks if the auto translate mode is on or not. More...

IlBoolean	isAutoZoomConstrained () const
	Checks if the auto zoom mode is constrained. More...

IlBoolean	isAutoZooming () const
	Checks whether the auto zoom mode is on. More...

IlBoolean	isResizingAllowed () const
	Checks if the control rectangle can be resized. More...

virtual void	resetOverview ()
	Resets the overview. More...

void	setAutoTranslating (IlBoolean set)
	Enables or disables the auto translate mode. More...

void	setAutoZoomConstrained (IlBoolean set)

void	setAutoZooming (IlBoolean set)
	Enables or disables the auto zoom mode. More...

void	setDrawSelection (IlvDrawSelection *dr)
	Sets the selection object used by the interactor in resizing mode. More...

void	setGraphic (IlvGraphic *gr)
	Sets the graphic object used as the magnifier. More...

void	setResizingAllowed (IlBoolean allow)
	Specifies whether the control rectangle can be resized. More...

void	setTarget (IlvView *view)
	Sets the target view of the interactor. More...

Public Member Functions inherited from IlvManagerViewInteractor
	IlvManagerViewInteractor (IlvManager manager, IlvView view)
	Constructor. More...

virtual void	drawGhost ()
	Visual feedback during 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...

Detailed Description

An interactor that controls the visible area of a view by using a movable rectangle in another view.

This interactor is used to create an overview window. The overview window shows the entire contents of a manager while the main window shows only a part of the manager. When the interactor is set on the overview window, the rectangle drawn by the interactor shows the visible area of the manager in the main window. It changes the visible area of the main window when the rectangle in the overview window is moved. The view controlled by the interactor is called the target view. The rectangle drawn on the overview window is represented by a graphic object called the magnifier. It can be a filled rectangle or an empty rectangle. The auto zoom mode and the auto translate allow the overview to be automatically zoomed or translated to follow the display in the main window. Library: ilvmgr

Member Function Documentation

virtual void IlvManagerMagViewInteractor::abort ( )

virtual

Aborts the interaction.

Called by the manager when the user changes the current interactor. It resets the interactor to a state in which it appears to have never been launched. A common implementation is to erase the ghost image. Call this member function to inhibit the interactor action in particular circumstances.

Reimplemented from IlvManagerViewInteractor.

virtual void IlvManagerMagViewInteractor::adjustView ( const IlvRect & rect )

virtual

Adjusts the visible area of the target view according to the specified control rectangle.

Parameters

rect	The control rectangle.

IlvDrawSelection* IlvManagerMagViewInteractor::getDrawSelection ( )

Returns the selection object used by the interactor in resizing mode.

Returns: The selection object to use.

IlvGraphic* IlvManagerMagViewInteractor::getGraphic ( ) const

Returns the graphic object used by the interactor as the magnifier.

The default graphic object used is a framed grid where the frame is drawn with the background color of the object palette and the grid is drawn with the foreground color.

Returns: The graphic object used as the magnifier.

IlvView* IlvManagerMagViewInteractor::getTarget ( ) const

Returns the target view of the interactor.

The target view is the one controlled by the overview.

Returns: The target view.

virtual void IlvManagerMagViewInteractor::handleEvent ( IlvEvent & event )

virtual

Handles events for the manager view.

Called by the manager for which the interactor was created with every event it receives in the interactor view.

Implements IlvManagerViewInteractor.

virtual void IlvManagerMagViewInteractor::init ( )

virtual

Initialization, when the interactor is attached to a view.

Resets the interactor to its initial state.
Called by the manager whenever the interactor is associated with a view. An association of this kind is established by the member function IlvManager::setInteractor.

Reimplemented from IlvManagerViewInteractor.

IlBoolean IlvManagerMagViewInteractor::isAutoTranslating ( ) const

Checks if the auto translate mode is on or not.

Returns IlTrue if the auto translate mode is activated.

Returns: The status of the auto translate mode.

See Also: IlvManagerMagViewInteractor::setAutoTranslating

IlBoolean IlvManagerMagViewInteractor::isAutoZoomConstrained ( ) const

Checks if the auto zoom mode is constrained.

Returns: IlTrue if the auto zoom mode is constrained, IlFalse otherwise.

See Also: IlvManagerMagViewInteractor::setAutoZoomConstrained

IlBoolean IlvManagerMagViewInteractor::isAutoZooming ( ) const

Checks whether the auto zoom mode is on.

Returns IlTrue if the auto zoom mode is activated.

Returns: The status of auto zoom mode.

See Also: IlvManagerMagViewInteractor::setAutoZooming

IlBoolean IlvManagerMagViewInteractor::isResizingAllowed ( ) const

Checks if the control rectangle can be resized.

Returns: IlTrue if the control rectangle can be resized, IlFalse otherwise.

See Also: IlvManagerMagViewInteractor::setResizingAllowed

virtual void IlvManagerMagViewInteractor::resetOverview ( )

virtual

Resets the overview.

Resets the internal flags of the overview used to manage the auto zoom mode and the auto zoom constrained mode.

void IlvManagerMagViewInteractor::setAutoTranslating ( IlBoolean set )

Enables or disables the auto translate mode.

When the auto translate mode is enabled, the overview window automatically scrolls so that the visible area of the target view remains inside the overview window.
By default, this mode is disabled.

Parameters

set	Indicates whether auto translate must be enabled.

See Also: IlvManagerMagViewInteractor::isAutoTranslating

void IlvManagerMagViewInteractor::setAutoZoomConstrained ( IlBoolean set )

Constrains the auto zoom mode so that the overview is never less zoomed than its content.

See Also: IlvManagerMagViewInteractor::setAutoZooming; IlvManagerMagViewInteractor::isAutoZoomConstrained

void IlvManagerMagViewInteractor::setAutoZooming ( IlBoolean set )

Enables or disables the auto zoom mode.

With the auto zoom mode enabled, the overview automatically zooms when the target view is zoomed in or out to maintain a constant ratio between the zoom factor of the overview and the zoom factor of the target view. By default, this mode is disabled.

Parameters

set	Boolean indicating if auto zoom is enabled or not.

See Also: IlvManagerMagViewInteractor::isAutoZooming; IlvManagerMagViewInteractor::setAutoZoomConstrained

void IlvManagerMagViewInteractor::setDrawSelection ( IlvDrawSelection * dr )

Sets the selection object used by the interactor in resizing mode.

The interactor is the owner of the object so that its destructor will destroy it.

Parameters

dr	The selection object to use.

void IlvManagerMagViewInteractor::setGraphic ( IlvGraphic * gr )

Sets the graphic object used as the magnifier.

The default graphic object used is a framed grid where the frame is drawn with the background color of the object palette and the grid is drawn with the foreground color. The interactor is the owner of the graphic so that its destructor will destroy it.

Parameters

gr	The graphic object to use.

void IlvManagerMagViewInteractor::setResizingAllowed ( IlBoolean allow )

Specifies whether the control rectangle can be resized.

When resizing is allowed, a resizing handle appears at each corner of the control rectangle. The object used for the resizing handles is a subclass of IlvDrawSelection.

Parameters

allow Specifies whether the control rectangle can be resized.

See Also: IlvManagerMagViewInteractor::isResizingAllowed; IlvDrawSelection

void IlvManagerMagViewInteractor::setTarget ( IlvView * view )

Sets the target view of the interactor.

The target view is the one controlled by the overview.

Parameters

view	The target view.

Rogue Wave ViewsManager Package API Reference Guide

Public Member Functions

Detailed Description

Member Function Documentation

Rogue Wave Views
Manager Package API Reference Guide