A collection of overviews which are drawn above the map content in a QgsComposerMap. More...

#include <qgscomposermapoverview.h>

Inheritance diagram for QgsComposerMapOverviewStack:

Public Member Functions
	QgsComposerMapOverviewStack (QgsComposerMap *map)
	Constructor for QgsComposerMapOverviewStack. More...

virtual	~QgsComposerMapOverviewStack ()

void	addOverview (QgsComposerMapOverview *overview)
	Adds a new map overview to the stack and takes ownership of the overview. More...

QList< QgsComposerMapOverview *>	asList () const
	Returns a list of QgsComposerMapOverviews contained by the stack. More...

const QgsComposerMapOverview *	constOverview (const QString &overviewId) const
	Returns a const reference to an overview within the stack. More...

void	moveOverviewDown (const QString &overviewId)
	Moves an overview down the stack, causing it to be rendered below other overviews. More...

void	moveOverviewUp (const QString &overviewId)
	Moves an overview up the stack, causing it to be rendered above other overviews. More...

QgsComposerMapOverview &	operator[] (int idx)
	Returns a reference to an overview within the stack. More...

QgsComposerMapOverview *	overview (const QString &overviewId) const
	Returns a reference to an overview within the stack. More...

QgsComposerMapOverview *	overview (const int index) const
	Returns a reference to an overview within the stack. More...

bool	readXML (const QDomElement &elem, const QDomDocument &doc) override
	Sets the overview stack's state from a DOM document. More...

void	removeOverview (const QString &overviewId)
	Removes an overview from the stack and deletes the corresponding QgsComposerMapOverview. More...

Public Member Functions inherited from QgsComposerMapItemStack
	QgsComposerMapItemStack (QgsComposerMap *map)
	Constructor for QgsComposerMapItemStack. More...

virtual	~QgsComposerMapItemStack ()

bool	containsAdvancedEffects () const
	Returns whether any items within the stack contain advanced effects, such as blending modes. More...

void	drawItems (QPainter *painter)
	Draws the items from the stack on a specified painter. More...

int	size () const
	Returns the number of items in the stack. More...

virtual bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	Stores the state of the item stack in a DOM node. More...

Additional Inherited Members
Protected Member Functions inherited from QgsComposerMapItemStack
void	addItem (QgsComposerMapItem *item)
	Adds a new map item to the stack and takes ownership of the item. More...

QList< QgsComposerMapItem *>	asList () const
	Returns a list of QgsComposerMapItems contained by the stack. More...

const QgsComposerMapItem *	constItem (const QString &itemId) const
	Returns a const reference to an item within the stack. More...

QgsComposerMapItem *	item (const QString &itemId) const
	Returns a reference to an item within the stack. More...

QgsComposerMapItem *	item (const int index) const
	Returns a reference to an item within the stack. More...

void	moveItemDown (const QString &itemId)
	Moves an item up the stack, causing it to be rendered above other items. More...

void	moveItemUp (const QString &itemId)
	Moves an item up the stack, causing it to be rendered above other items. More...

QgsComposerMapItem &	operator[] (int idx)
	Returns a reference to an item within the stack. More...

void	removeItem (const QString &itemId)
	Removes an item from the stack and deletes the corresponding QgsComposerMapItem. More...

void	removeItems ()
	Clears the item stack and deletes all QgsComposerMapItems contained by the stack. More...

Protected Attributes inherited from QgsComposerMapItemStack
QgsComposerMap *	mComposerMap

QList< QgsComposerMapItem *>	mItems

Detailed Description

A collection of overviews which are drawn above the map content in a QgsComposerMap.

The overview stack controls which overviews are drawn and the order they are drawn in.

Note: added in QGIS 2.5

See also: QgsComposerMapOverview

Definition at line 39 of file qgscomposermapoverview.h.

Constructor & Destructor Documentation

◆ QgsComposerMapOverviewStack()

QgsComposerMapOverviewStack::QgsComposerMapOverviewStack ( QgsComposerMap * map )

Constructor for QgsComposerMapOverviewStack.

Parameters

map	QgsComposerMap the overview stack is attached to

Definition at line 310 of file qgscomposermapoverview.cpp.

◆ ~QgsComposerMapOverviewStack()

QgsComposerMapOverviewStack::~QgsComposerMapOverviewStack ( )

virtual

Definition at line 316 of file qgscomposermapoverview.cpp.

Member Function Documentation

◆ addOverview()

void QgsComposerMapOverviewStack::addOverview ( QgsComposerMapOverview * overview )

Adds a new map overview to the stack and takes ownership of the overview.

The overview will be added to the end of the stack, and rendered above any existing map overviews already present in the stack.

Parameters

overview QgsComposerMapOverview to add to the stack

Note: after adding a overview to the stack, update() should be called for the QgsComposerMap to prevent rendering artifacts

See also: removeOverview

Definition at line 321 of file qgscomposermapoverview.cpp.

◆ asList()

QList< QgsComposerMapOverview * > QgsComposerMapOverviewStack::asList ( ) const

Returns a list of QgsComposerMapOverviews contained by the stack.

Returns: list of overviews

Definition at line 366 of file qgscomposermapoverview.cpp.

◆ constOverview()

const QgsComposerMapOverview * QgsComposerMapOverviewStack::constOverview ( const QString & overviewId ) const

Returns a const reference to an overview within the stack.

Parameters

overviewId id for the QgsComposerMapOverview to find

Returns: const reference to overview, if found

See also: overview

Definition at line 341 of file qgscomposermapoverview.cpp.

◆ moveOverviewDown()

void QgsComposerMapOverviewStack::moveOverviewDown ( const QString & overviewId )

Moves an overview down the stack, causing it to be rendered below other overviews.

Parameters

overviewId id for the QgsComposerMapOverview to move down

Note: after moving an overview within the stack, update() should be called for the QgsComposerMap to redraw the map with the new overview stack order

See also: moveOverviewUp

Definition at line 336 of file qgscomposermapoverview.cpp.

◆ moveOverviewUp()

void QgsComposerMapOverviewStack::moveOverviewUp ( const QString & overviewId )

Moves an overview up the stack, causing it to be rendered above other overviews.

Parameters

overviewId id for the QgsComposerMapOverview to move up

Note: after moving an overview within the stack, update() should be called for the QgsComposerMap to redraw the map with the new overview stack order

See also: moveOverviewDown

Definition at line 331 of file qgscomposermapoverview.cpp.

◆ operator[]()

QgsComposerMapOverview & QgsComposerMapOverviewStack::operator[] ( int idx )

Returns a reference to an overview within the stack.

Parameters

idx	overview position in the stack

Returns: reference to overview if found

See also: constOverview; overview

Definition at line 359 of file qgscomposermapoverview.cpp.

◆ overview() [1/2]

QgsComposerMapOverview * QgsComposerMapOverviewStack::overview ( const QString & overviewId ) const

Returns a reference to an overview within the stack.

Parameters

overviewId id for the QgsComposerMapOverview to find

Returns: reference to overview if found

See also: constOverview

Definition at line 347 of file qgscomposermapoverview.cpp.

◆ overview() [2/2]

QgsComposerMapOverview * QgsComposerMapOverviewStack::overview ( const int index ) const

Returns a reference to an overview within the stack.

Parameters

index overview position in the stack

Returns: reference to overview if found

See also: constOverview

Definition at line 353 of file qgscomposermapoverview.cpp.

◆ readXML()

bool QgsComposerMapOverviewStack::readXML	(	const QDomElement &	elem,
		const QDomDocument &	doc
	)

overridevirtual

Sets the overview stack's state from a DOM document.

Parameters

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

Returns: true if read was successful

See also: writeXML

Implements QgsComposerMapItemStack.

Definition at line 381 of file qgscomposermapoverview.cpp.

◆ removeOverview()

void QgsComposerMapOverviewStack::removeOverview ( const QString & overviewId )

Removes an overview from the stack and deletes the corresponding QgsComposerMapOverview.

Parameters

overviewId id for the QgsComposerMapOverview to remove

Note: after removing an overview from the stack, update() should be called for the QgsComposerMap to prevent rendering artifacts

See also: addOverview

Definition at line 326 of file qgscomposermapoverview.cpp.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/composer/qgscomposermapoverview.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/composer/qgscomposermapoverview.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsComposerMapOverviewStack()

◆ ~QgsComposerMapOverviewStack()

Member Function Documentation

◆ addOverview()

◆ asList()

◆ constOverview()

◆ moveOverviewDown()

◆ moveOverviewUp()

◆ operator[]()

◆ overview() [1/2]

◆ overview() [2/2]

◆ readXML()

◆ removeOverview()