An individual overview which is drawn above the map content in a QgsComposerMap, and shows the extent of another QgsComposerMap. More...

#include <qgscomposermapoverview.h>

Inheritance diagram for QgsComposerMapOverview:

[legend]

Public Slots
void	overviewExtentChanged ()
	Handles recentering of the map and redrawing of the map's overview.

Public Member Functions
	QgsComposerMapOverview (const QString &name, QgsComposerMap *map)
	Constructor for QgsComposerMapOverview.
virtual	~QgsComposerMapOverview ()
void	draw (QPainter *painter)
	Draws an overview.
bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	Stores overview state in DOM element.
bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Sets overview state from a DOM document.
bool	usesAdvancedEffects () const
	Returns true if the item is drawn using advanced effects, such as blend modes.
void	setFrameMap (const int mapId)
	Sets overview frame map.
int	frameMapId () const
	Returns id of source map.
void	setFrameSymbol (QgsFillSymbolV2 *symbol)
	Sets the fill symbol used for drawing the overview extent.
QgsFillSymbolV2 *	frameSymbol ()
	Gets the fill symbol used for drawing the overview extent.
const QgsFillSymbolV2 *	frameSymbol () const
	Gets the fill symbol used for drawing the overview extent.
QPainter::CompositionMode	blendMode () const
	Retrieves the blending mode used for drawing the overview.
void	setBlendMode (const QPainter::CompositionMode blendMode)
	Sets the blending mode used for drawing the overview.
bool	inverted () const
	Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.
void	setInverted (const bool inverted)
	Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.
bool	centered () const
	Returns whether the extent of the map is forced to center on the overview.
void	setCentered (const bool centered)
	Sets whether the extent of the map is forced to center on the overview.
void	connectSignals ()
	Reconnects signals for overview map, so that overview correctly follows changes to source map's extent.
Public Member Functions inherited from QgsComposerMapItem
	QgsComposerMapItem (const QString &name, QgsComposerMap *map)
	Constructor for QgsComposerMapItem.
virtual	~QgsComposerMapItem ()
virtual void	setComposerMap (QgsComposerMap *map)
	Sets composer map for the item.
virtual const QgsComposerMap *	composerMap () const
	Get composer map for the item.
QString	id () const
	Get the unique id for the map item.
virtual void	setName (const QString &name)
	Sets the friendly display name for the item.
virtual QString	name () const
	Get friendly display name for the item.
virtual void	setEnabled (const bool enabled)
	Controls whether the item will be drawn.
virtual bool	enabled () const
	Returns whether the item will be drawn.
Public Member Functions inherited from QgsComposerObject
	QgsComposerObject (QgsComposition *composition)
	Constructor.
virtual	~QgsComposerObject ()
const QgsComposition *	composition () const
	Returns the composition the item is attached to.
QgsComposition *	composition ()
QgsDataDefined *	dataDefinedProperty (const DataDefinedProperty property) const
	Returns a reference to the data defined settings for one of the item's data defined properties.
void	setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field)
	Sets parameters for a data defined property for the item.

Additional Inherited Members
Public Types inherited from QgsComposerObject
enum	DataDefinedProperty { NoProperty = 0, AllProperties, TestProperty, PresetPaperSize, PaperWidth, PaperHeight, NumPages, PaperOrientation, PageNumber, PositionX, PositionY, ItemWidth, ItemHeight, ItemRotation, Transparency, BlendMode, ExcludeFromExports, MapRotation, MapScale, MapXMin, MapYMin, MapXMax, MapYMax, MapAtlasMargin, PictureSource, SourceUrl }
	Data defined properties for different item types. More...
enum	PropertyValueType { EvaluatedValue = 0, OriginalValue }
	Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...
Signals inherited from QgsComposerObject
void	itemChanged ()
	Emitted when the item changes.
Protected Member Functions inherited from QgsComposerObject
bool	dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
	Evaluate a data defined property and return the calculated value.
Protected Attributes inherited from QgsComposerMapItem
QString	mName
	Friendly display name.
QgsComposerMap *	mComposerMap
	Associated composer map.
QString	mUuid
	Unique id.
bool	mEnabled
	True if item is to be displayed on map.

Detailed Description

An individual overview which is drawn above the map content in a QgsComposerMap, and shows the extent of another QgsComposerMap.

Note: added in QGIS 2.5

See Also: QgsComposerMapOverviewStack

Constructor & Destructor Documentation

QgsComposerMapOverview::QgsComposerMapOverview	(	const QString &	name,
		QgsComposerMap *	map
	)

Constructor for QgsComposerMapOverview.

Parameters

name	friendly display name for overview
map	QgsComposerMap the overview is attached to

QgsComposerMapOverview::~QgsComposerMapOverview ( )

virtual

Member Function Documentation

QPainter::CompositionMode QgsComposerMapOverview::blendMode ( ) const

inline

Retrieves the blending mode used for drawing the overview.

Returns: blending mode for overview

See Also: setBlendMode

bool QgsComposerMapOverview::centered ( ) const

inline

Returns whether the extent of the map is forced to center on the overview.

Returns: true if map will be centered on overview

See Also: setCentered

void QgsComposerMapOverview::connectSignals ( )

Reconnects signals for overview map, so that overview correctly follows changes to source map's extent.

void QgsComposerMapOverview::draw ( QPainter * painter )

virtual

Draws an overview.

Parameters

painter destination QPainter

Implements QgsComposerMapItem.

int QgsComposerMapOverview::frameMapId ( ) const

inline

Returns id of source map.

Returns: source map id, or -1 if no source map set

QgsFillSymbolV2* QgsComposerMapOverview::frameSymbol ( )

inline

Gets the fill symbol used for drawing the overview extent.

Returns: fill symbol for overview

See Also: setFrameSymbol

const QgsFillSymbolV2* QgsComposerMapOverview::frameSymbol ( ) const

inline

Gets the fill symbol used for drawing the overview extent.

Returns: fill symbol for overview

See Also: setFrameSymbol

bool QgsComposerMapOverview::inverted ( ) const

inline

Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.

Returns: true if overview frame is inverted

See Also: setInverted

void QgsComposerMapOverview::overviewExtentChanged ( )

slot

Handles recentering of the map and redrawing of the map's overview.

bool QgsComposerMapOverview::readXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc
	)

virtual

Sets overview state from a DOM document.

Parameters

itemElem	is DOM node corresponding to a 'ComposerMapOverview' tag
doc	is DOM document

See Also: writeXML

Reimplemented from QgsComposerMapItem.

void QgsComposerMapOverview::setBlendMode ( const QPainter::CompositionMode blendMode )

Sets the blending mode used for drawing the overview.

Parameters

blendMode blending mode for overview

See Also: blendMode

void QgsComposerMapOverview::setCentered ( const bool centered )

Sets whether the extent of the map is forced to center on the overview.

Parameters

centered set to true if map will be centered on overview

See Also: centered

void QgsComposerMapOverview::setFrameMap ( const int mapId )

Sets overview frame map.

Parameters

mapId source map id. -1 disables the overview frame

See Also: frameMapId

void QgsComposerMapOverview::setFrameSymbol ( QgsFillSymbolV2 * symbol )

Sets the fill symbol used for drawing the overview extent.

Parameters

symbol fill symbol for overview

See Also: frameSymbol

void QgsComposerMapOverview::setInverted ( const bool inverted )

Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.

Parameters

inverted set to true if overview frame is to be inverted

See Also: inverted

bool QgsComposerMapOverview::usesAdvancedEffects ( ) const

virtual

Returns true if the item is drawn using advanced effects, such as blend modes.

Returns: true if item uses advanced effects

Reimplemented from QgsComposerMapItem.

bool QgsComposerMapOverview::writeXML	(	QDomElement &	elem,
		QDomDocument &	doc
	)		const

virtual

Stores overview state in DOM element.

Parameters

elem	is DOM element corresponding to a 'ComposerMap' tag
doc	DOM document

See Also: readXML

Reimplemented from QgsComposerMapItem.

The documentation for this class was generated from the following files:

/tmp/buildd/qgis-2.6.0+wheezy1/src/core/composer/qgscomposermapoverview.h
/tmp/buildd/qgis-2.6.0+wheezy1/src/core/composer/qgscomposermapoverview.cpp

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation