A collection of overviews which are drawn above the map content in a QgsComposerMap.
More...
#include <qgscomposermapoverview.h>
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
Constructor & Destructor Documentation
QgsComposerMapOverviewStack::QgsComposerMapOverviewStack |
( |
QgsComposerMap * |
map | ) |
|
QgsComposerMapOverviewStack::~QgsComposerMapOverviewStack |
( |
| ) |
|
|
virtual |
Member Function Documentation
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
-
- Note
- after adding a overview to the stack, update() should be called for the QgsComposerMap to prevent rendering artifacts
- See Also
- removeOverview
Returns a list of QgsComposerMapOverviews contained by the stack.
- Returns
- list of overviews
Reimplemented from QgsComposerMapItemStack.
Returns a const reference to an overview within the stack.
- Parameters
-
- Returns
- const reference to overview, if found
- See Also
- overview
void QgsComposerMapOverviewStack::moveOverviewDown |
( |
const QString & |
overviewId | ) |
|
Moves an overview down the stack, causing it to be rendered below other overviews.
- Parameters
-
- 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
void QgsComposerMapOverviewStack::moveOverviewUp |
( |
const QString & |
overviewId | ) |
|
Moves an overview up the stack, causing it to be rendered above other overviews.
- Parameters
-
- 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
Returns a reference to an overview within the stack.
- Parameters
-
- Returns
- reference to overview if found
- See Also
- constOverview
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
bool QgsComposerMapOverviewStack::readXML |
( |
const QDomElement & |
elem, |
|
|
const QDomDocument & |
doc |
|
) |
| |
|
virtual |
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.
void QgsComposerMapOverviewStack::removeOverview |
( |
const QString & |
overviewId | ) |
|
Removes an overview from the stack and deletes the corresponding QgsComposerMapOverview.
- Parameters
-
- Note
- after removing an overview from the stack, update() should be called for the QgsComposerMap to prevent rendering artifacts
- See Also
- addOverview
The documentation for this class was generated from the following files: