QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsComposerMapOverviewStack Class Reference

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

#include <qgscomposermapoverview.h>

Inheritance diagram for QgsComposerMapOverviewStack:
Inheritance graph
[legend]

Public Member Functions

 QgsComposerMapOverviewStack (QgsComposerMap *map)
 Constructor for QgsComposerMapOverviewStack.
virtual ~QgsComposerMapOverviewStack ()
void addOverview (QgsComposerMapOverview *overview)
 Adds a new map overview to the stack and takes ownership of the overview.
void removeOverview (const QString &overviewId)
 Removes an overview from the stack and deletes the corresponding QgsComposerMapOverview.
void moveOverviewUp (const QString &overviewId)
 Moves an overview up the stack, causing it to be rendered above other overviews.
void moveOverviewDown (const QString &overviewId)
 Moves an overview down the stack, causing it to be rendered below other overviews.
const QgsComposerMapOverviewconstOverview (const QString &overviewId) const
 Returns a const reference to an overview within the stack.
QgsComposerMapOverviewoverview (const QString &overviewId) const
 Returns a reference to an overview within the stack.
QgsComposerMapOverviewoverview (const int index) const
 Returns a reference to an overview within the stack.
QgsComposerMapOverviewoperator[] (int idx)
 Returns a reference to an overview within the stack.
QList< QgsComposerMapOverview * > asList () const
 Returns a list of QgsComposerMapOverviews contained by the stack.
bool readXML (const QDomElement &elem, const QDomDocument &doc)
 Sets the overview stack's state from a DOM document.
- Public Member Functions inherited from QgsComposerMapItemStack
 QgsComposerMapItemStack (QgsComposerMap *map)
 Constructor for QgsComposerMapItemStack.
virtual ~QgsComposerMapItemStack ()
int size () const
 Returns the number of items in the stack.
virtual bool writeXML (QDomElement &elem, QDomDocument &doc) const
 Stores the state of the item stack in a DOM node.
void drawItems (QPainter *painter)
 Draws the items from the stack on a specified painter.
bool containsAdvancedEffects () const
 Returns whether any items within the stack contain advanced effects, such as blending modes.

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.
void removeItem (const QString &itemId)
 Removes an item from the stack and deletes the corresponding QgsComposerMapItem.
void moveItemUp (const QString &itemId)
 Moves an item up the stack, causing it to be rendered above other items.
void moveItemDown (const QString &itemId)
 Moves an item up the stack, causing it to be rendered above other items.
const QgsComposerMapItemconstItem (const QString &itemId) const
 Returns a const reference to an item within the stack.
QgsComposerMapItemitem (const QString &itemId) const
 Returns a reference to an item within the stack.
QgsComposerMapItemitem (const int index) const
 Returns a reference to an item within the stack.
void removeItems ()
 Clears the item stack and deletes all QgsComposerMapItems contained by the stack.
- Protected Attributes inherited from QgsComposerMapItemStack
QList< QgsComposerMapItem * > mItems
QgsComposerMapmComposerMap

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)

Constructor for QgsComposerMapOverviewStack.

Parameters
mapQgsComposerMap the overview stack is attached to
QgsComposerMapOverviewStack::~QgsComposerMapOverviewStack ( )
virtual

Member Function Documentation

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
overviewQgsComposerMapOverview 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
QList< QgsComposerMapOverview * > QgsComposerMapOverviewStack::asList ( ) const

Returns a list of QgsComposerMapOverviews contained by the stack.

Returns
list of overviews

Reimplemented from QgsComposerMapItemStack.

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

Returns a const reference to an overview within the stack.

Parameters
overviewIdid for the QgsComposerMapOverview to find
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
overviewIdid 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
void QgsComposerMapOverviewStack::moveOverviewUp ( const QString &  overviewId)

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

Parameters
overviewIdid 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
QgsComposerMapOverview & QgsComposerMapOverviewStack::operator[] ( int  idx)

Returns a reference to an overview within the stack.

Parameters
idxoverview position in the stack
Returns
reference to overview if found
See Also
constOverview
overview

Reimplemented from QgsComposerMapItemStack.

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

Returns a reference to an overview within the stack.

Parameters
overviewIdid for the QgsComposerMapOverview to find
Returns
reference to overview if found
See Also
constOverview
QgsComposerMapOverview * QgsComposerMapOverviewStack::overview ( const int  index) const

Returns a reference to an overview within the stack.

Parameters
indexoverview 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
elemis DOM node corresponding to a 'ComposerMap' tag
docDOM 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
overviewIdid 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

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