A collection of grids which is drawn above the map content in a QgsComposerMap. More...

#include <qgscomposermapgrid.h>

Inheritance diagram for QgsComposerMapGridStack:

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

virtual	~QgsComposerMapGridStack ()

void	addGrid (QgsComposerMapGrid *grid)
	Adds a new map grid to the stack and takes ownership of the grid. More...

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

void	calculateMaxGridExtension (double &top, double &right, double &bottom, double &left) const
	Calculates the maximum distance grids within the stack extend beyond the QgsComposerMap's item rect. More...

const QgsComposerMapGrid *	constGrid (const QString &gridId) const
	Returns a const reference to a grid within the stack. More...

QgsComposerMapGrid *	grid (const QString &gridId) const
	Returns a reference to a grid within the stack. More...

QgsComposerMapGrid *	grid (const int index) const
	Returns a reference to a grid within the stack. More...

double	maxGridExtension () const
	Calculates the maximum distance grids within the stack extend beyond the QgsComposerMap's item rect. More...

void	moveGridDown (const QString &gridId)
	Moves a grid down the stack, causing it to be rendered below other grids. More...

void	moveGridUp (const QString &gridId)
	Moves a grid up the stack, causing it to be rendered above other grids. More...

QgsComposerMapGrid &	operator[] (int idx)
	Returns a reference to a grid within the stack. More...

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

void	removeGrid (const QString &gridId)
	Removes a grid from the stack and deletes the corresponding QgsComposerMapGrid. 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 grids which is drawn above the map content in a QgsComposerMap.

The grid stack controls which grids are drawn and the order they are drawn in.

Note: added in QGIS 2.5

See also: QgsComposerMapGrid

Definition at line 45 of file qgscomposermapgrid.h.

Constructor & Destructor Documentation

◆ QgsComposerMapGridStack()

QgsComposerMapGridStack::QgsComposerMapGridStack ( QgsComposerMap * map )

Constructor for QgsComposerMapGridStack.

Parameters

map	QgsComposerMap the grid stack is attached to

Definition at line 38 of file qgscomposermapgrid.cpp.

◆ ~QgsComposerMapGridStack()

QgsComposerMapGridStack::~QgsComposerMapGridStack ( )

virtual

Definition at line 44 of file qgscomposermapgrid.cpp.

Member Function Documentation

◆ addGrid()

void QgsComposerMapGridStack::addGrid ( QgsComposerMapGrid * grid )

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

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

Parameters

grid	QgsComposerMapGrid to add to the stack

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

See also: removeGrid

Definition at line 48 of file qgscomposermapgrid.cpp.

◆ asList()

QList< QgsComposerMapGrid * > QgsComposerMapGridStack::asList ( ) const

Returns a list of QgsComposerMapGrids contained by the stack.

Returns: list of grids

Definition at line 86 of file qgscomposermapgrid.cpp.

◆ calculateMaxGridExtension()

void QgsComposerMapGridStack::calculateMaxGridExtension	(	double &	top,
		double &	right,
		double &	bottom,
		double &	left
	)		const

Calculates the maximum distance grids within the stack extend beyond the QgsComposerMap's item rect.

This method calculates the distance for each side of the map item separately

Parameters

top	storage for top extension
right	storage for right extension
bottom	storage for bottom extension
left	storage for left extension

Note: added in QGIS 2.12

See also: maxGridExtension()

Definition at line 135 of file qgscomposermapgrid.cpp.

◆ constGrid()

const QgsComposerMapGrid * QgsComposerMapGridStack::constGrid ( const QString & gridId ) const

Returns a const reference to a grid within the stack.

Parameters

gridId id for the QgsComposerMapGrid to find

Returns: const reference to grid, if found

See also: grid

Definition at line 68 of file qgscomposermapgrid.cpp.

◆ grid() [1/2]

QgsComposerMapGrid * QgsComposerMapGridStack::grid ( const QString & gridId ) const

Returns a reference to a grid within the stack.

Parameters

gridId id for the QgsComposerMapGrid to find

Returns: reference to grid if found

See also: constGrid

Definition at line 74 of file qgscomposermapgrid.cpp.

◆ grid() [2/2]

QgsComposerMapGrid * QgsComposerMapGridStack::grid ( const int index ) const

Returns a reference to a grid within the stack.

Parameters

index grid position in the stack

Returns: reference to grid if found

See also: constGrid

Definition at line 80 of file qgscomposermapgrid.cpp.

◆ maxGridExtension()

double QgsComposerMapGridStack::maxGridExtension ( ) const

Calculates the maximum distance grids within the stack extend beyond the QgsComposerMap's item rect.

Returns: maximum grid extension

See also: calculateMaxGridExtension()

Definition at line 125 of file qgscomposermapgrid.cpp.

◆ moveGridDown()

void QgsComposerMapGridStack::moveGridDown ( const QString & gridId )

Moves a grid down the stack, causing it to be rendered below other grids.

Parameters

gridId id for the QgsComposerMapGrid to move down

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

See also: moveGridUp

Definition at line 63 of file qgscomposermapgrid.cpp.

◆ moveGridUp()

void QgsComposerMapGridStack::moveGridUp ( const QString & gridId )

Moves a grid up the stack, causing it to be rendered above other grids.

Parameters

gridId id for the QgsComposerMapGrid to move up

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

See also: moveGridDown

Definition at line 58 of file qgscomposermapgrid.cpp.

◆ operator[]()

QgsComposerMapGrid & QgsComposerMapGridStack::operator[] ( int idx )

Returns a reference to a grid within the stack.

Parameters

idx	grid position in the stack

Returns: reference to grid if found

See also: constGrid; grid

Definition at line 101 of file qgscomposermapgrid.cpp.

◆ readXML()

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

overridevirtual

Sets the grid 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 108 of file qgscomposermapgrid.cpp.

◆ removeGrid()

void QgsComposerMapGridStack::removeGrid ( const QString & gridId )

Removes a grid from the stack and deletes the corresponding QgsComposerMapGrid.

Parameters

gridId id for the QgsComposerMapGrid to remove

Note: after removing a grid from the stack, updateBoundingRect() and update() should be called for the QgsComposerMap to prevent rendering artifacts

See also: addGrid

Definition at line 53 of file qgscomposermapgrid.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsComposerMapGridStack()

◆ ~QgsComposerMapGridStack()

Member Function Documentation

◆ addGrid()

◆ asList()

◆ calculateMaxGridExtension()

◆ constGrid()

◆ grid() [1/2]

◆ grid() [2/2]

◆ maxGridExtension()

◆ moveGridDown()

◆ moveGridUp()

◆ operator[]()

◆ readXML()

◆ removeGrid()