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

Manager view class. More...

#include <ilviews/manager/mgrview.h>

Public Member Functions

IlvManagerViewInteractorgetInteractor () const
 Returns the interactor. More...
 
IlvRegionOptimizergetRegionOptimizer () const
 Returns the region optimizer. More...
 
IlvTransformergetTransformer () const
 Returns the transformer. More...
 
IlvManagerGridgrid () const
 Returns the manager grid. More...
 
IlBoolean isVisible (int layer, IlBoolean filter=IlTrue) const
 Indicates the visibility of a layer in a manager view. More...
 
IlBoolean keepAspectRatio () const
 Indicates whether a manager view preserves the x/y ratio. More...
 
IlvManagermanager () const
 Returns the manager. More...
 
void setRegionOptimizer (IlvRegionOptimizer *optimizer)
 Sets the region optimizer. More...
 
IlvViewview () const
 Returns the view. More...
 

Detailed Description

Manager view class.

Library: ilvmgr

The IlvManager class uses an IlvMgrView to store the necessary information regarding each view associated with the manager, such as the instance of IlvView, the transformer used to draw in the view, the interactor, etc.
Instances of IlvMgrView should not be created or deleted; they are internally handled by the manager.

See Also
IlvManager, IlvManagerLayer, IlvManagerViewInteractor, IlvManagerGrid.

Member Function Documentation

IlvManagerViewInteractor* IlvMgrView::getInteractor ( ) const

Returns the interactor.

Returns
The view interactor associated with the manager view, or 0 if there is none.
See Also
IlvManager::getInteractor
IlvRegionOptimizer* IlvMgrView::getRegionOptimizer ( ) const

Returns the region optimizer.

The default value is 0. In this case, the manager view will use a default region optimizer.

Returns
The region optimizer, or 0 if there's none.
IlvTransformer* IlvMgrView::getTransformer ( ) const

Returns the transformer.

Returns
The transformer set on the manager view.
See Also
IlvManager::getTransformer.
IlvManagerGrid* IlvMgrView::grid ( ) const

Returns the manager grid.

Returns
The manager grid associated with the manager view, or 0 if there is none.
See Also
IlvManagerGrid::getGrid().
IlBoolean IlvMgrView::isVisible ( int  layer,
IlBoolean  filter = IlTrue 
) const

Indicates the visibility of a layer in a manager view.

Returns
IlTrue if the layer is visible for the manager view. The function does not check the global visibility of the layer, that is, the visibility from the manager point of view.
Parameters
layerThe index of the manager layer.
filterIf set to IlFalse, the function ignores the visibility filters set on the layer, otherwise they are called and taken into account.
IlBoolean IlvMgrView::keepAspectRatio ( ) const

Indicates whether a manager view preserves the x/y ratio.

Returns
IlTrue if the manager view automatically respects the aspect ratio (that is, the x/y ratio) when its transformer is changed.
See Also
IlvManager::isKeepingAspectRatio
IlvManager* IlvMgrView::manager ( ) const

Returns the manager.

Returns
The manager handling the manager view.
void IlvMgrView::setRegionOptimizer ( IlvRegionOptimizer optimizer)

Sets the region optimizer.

The previous region optimizer, if any, is deleted.

Parameters
optimizerThe new region optimizer.
IlvView* IlvMgrView::view ( ) const

Returns the view.

Returns
The IlvView instance associated with the manager and represented by the IlvMgrView.

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