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

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

#include <qgscomposermapitem.h>

Inheritance diagram for QgsComposerMapItemStack:
Inheritance graph
[legend]

Public Member Functions

 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.
virtual bool readXML (const QDomElement &elem, const QDomDocument &doc)=0
 Sets the item stack's state from a DOM document.
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.

Protected Member Functions

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.
QgsComposerMapItemoperator[] (int idx)
 Returns a reference to an item within the stack.
QList< QgsComposerMapItem * > asList () const
 Returns a list of QgsComposerMapItems contained by the stack.
void removeItems ()
 Clears the item stack and deletes all QgsComposerMapItems contained by the stack.

Protected Attributes

QList< QgsComposerMapItem * > mItems
QgsComposerMapmComposerMap

Detailed Description

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

The item stack controls which items are drawn and the order they are drawn in.

Note
added in QGIS 2.5
See Also
QgsComposerMapItem

Constructor & Destructor Documentation

QgsComposerMapItemStack::QgsComposerMapItemStack ( QgsComposerMap map)

Constructor for QgsComposerMapItemStack.

Parameters
mapQgsComposerMap the item stack is attached to
QgsComposerMapItemStack::~QgsComposerMapItemStack ( )
virtual

Member Function Documentation

void QgsComposerMapItemStack::addItem ( QgsComposerMapItem item)
protected

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

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

Parameters
itemQgsComposerMapItem to add to the stack
Note
after adding an item to the stack update() should be called for the QgsComposerMap to prevent rendering artifacts
See Also
removeItem
QList< QgsComposerMapItem * > QgsComposerMapItemStack::asList ( ) const
protected

Returns a list of QgsComposerMapItems contained by the stack.

Returns
list of items

Reimplemented in QgsComposerMapGridStack, and QgsComposerMapOverviewStack.

const QgsComposerMapItem * QgsComposerMapItemStack::constItem ( const QString &  itemId) const
protected

Returns a const reference to an item within the stack.

Parameters
itemIdid for the QgsComposerMapItem to find
Returns
const reference to item, if found
See Also
item
bool QgsComposerMapItemStack::containsAdvancedEffects ( ) const

Returns whether any items within the stack contain advanced effects, such as blending modes.

Returns
true if item stack contains advanced effects
void QgsComposerMapItemStack::drawItems ( QPainter *  painter)

Draws the items from the stack on a specified painter.

Parameters
painterdestination QPainter
QgsComposerMapItem * QgsComposerMapItemStack::item ( const QString &  itemId) const
protected

Returns a reference to an item within the stack.

Parameters
itemIdid for the QgsComposerMapItem to find
Returns
reference to item if found
See Also
constItem
QgsComposerMapItem * QgsComposerMapItemStack::item ( const int  index) const
protected

Returns a reference to an item within the stack.

Parameters
indexitem position in the stack
Returns
reference to item if found
See Also
constItem
void QgsComposerMapItemStack::moveItemDown ( const QString &  itemId)
protected

Moves an item up the stack, causing it to be rendered above other items.

Parameters
itemIdid for the QgsComposerMapItem to move down
Note
after moving an item within the stack, update() should be called for the QgsComposerMap to redraw the map with the new item stack order
See Also
moveItemUp
void QgsComposerMapItemStack::moveItemUp ( const QString &  itemId)
protected

Moves an item up the stack, causing it to be rendered above other items.

Parameters
itemIdid for the QgsComposerMapItem to move up
Note
after moving an item within the stack, update() should be called for the QgsComposerMap to redraw the map with the new item stack order
See Also
moveItemDown
QgsComposerMapItem & QgsComposerMapItemStack::operator[] ( int  idx)
protected

Returns a reference to an item within the stack.

Parameters
idxitem position in the stack
Returns
reference to item if found
See Also
constItem
item
Note
not available in python bindings

Reimplemented in QgsComposerMapGridStack, and QgsComposerMapOverviewStack.

virtual bool QgsComposerMapItemStack::readXML ( const QDomElement &  elem,
const QDomDocument &  doc 
)
pure virtual

Sets the item 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

Implemented in QgsComposerMapGridStack, and QgsComposerMapOverviewStack.

void QgsComposerMapItemStack::removeItem ( const QString &  itemId)
protected

Removes an item from the stack and deletes the corresponding QgsComposerMapItem.

Parameters
itemIdid for the QgsComposerMapItem to remove
Note
after removing an item from the stack, update() should be called for the QgsComposerMap to prevent rendering artifacts
See Also
addItem
void QgsComposerMapItemStack::removeItems ( )
protected

Clears the item stack and deletes all QgsComposerMapItems contained by the stack.

int QgsComposerMapItemStack::size ( void  ) const
inline

Returns the number of items in the stack.

Returns
number of items in the stack
bool QgsComposerMapItemStack::writeXML ( QDomElement &  elem,
QDomDocument &  doc 
) const
virtual

Stores the state of the item stack in a DOM node.

Parameters
elemis DOM element corresponding to a 'ComposerMap' tag
docDOM document
Returns
true if write was successful
See Also
readXML

Member Data Documentation

QgsComposerMap* QgsComposerMapItemStack::mComposerMap
protected
QList< QgsComposerMapItem* > QgsComposerMapItemStack::mItems
protected

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