A model that provides group, layer and classification items. More...

#include <qgslegendmodel.h>

Public Types
enum	ItemType { GroupItem = 0, LayerItem, ClassificationItem }

Public Slots
void	removeLayer (const QString &layerId)
void	addLayer (QgsMapLayer *theMapLayer, double scaleDenominator=-1, QString rule="")

Signals
void	layersChanged ()

Public Member Functions
	QgsLegendModel ()
	~QgsLegendModel ()
void	setLayerSetAndGroups (const QStringList &layerIds, const QList< GroupLayerInfo > &groupInfo)
	Sets layer set and groups.
void	setLayerSet (const QStringList &layerIds, double scaleDenominator=-1, QString rule="")
QStandardItem *	addGroup (QString text=QString::null, int position=-1)
	Adds a group.
void	updateItem (QStandardItem *item)
	Tries to automatically update a model entry (e.g.
void	updateLayer (QStandardItem *layerItem)
	Updates the whole symbology of a layer.
void	updateVectorV2ClassificationItem (QStandardItem classificationItem, QgsSymbolV2 symbol, QString itemText)
	Tries to update a single classification item.
void	updateRasterClassificationItem (QStandardItem *classificationItem)
void	updateItemText (QStandardItem *item)
	Update single item text using item userText and other properties like showFeatureCount.
bool	writeXML (QDomElement &composerLegendElem, QDomDocument &doc) const
bool	readXML (const QDomElement &legendModelElem, const QDomDocument &doc)
Qt::DropActions	supportedDropActions () const
Qt::ItemFlags	flags (const QModelIndex &index) const
virtual bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex())
	Implemented to support drag operations.
QMimeData *	mimeData (const QModelIndexList &indexes) const
	For the drag operation.
QStringList	mimeTypes () const
bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
	Implements the drop operation.
void	setAutoUpdate (bool autoUpdate)
bool	autoUpdate ()

Protected Attributes
QStringList	mLayerIds
bool	mHasTopLevelWindow
	True if this application has toplevel windows (normally true).
bool	mAutoUpdate
	True if the legend is auto updated when layers are added or removed from the map canvas.

Private Member Functions
int	addVectorLayerItemsV2 (QStandardItem layerItem, QgsVectorLayer vlayer, double scaleDenominator=-1, QString rule="")
	Adds classification items of vector layers using new symbology.
int	addRasterLayerItems (QStandardItem layerItem, QgsMapLayer rlayer)
	Adds item of raster layer.
void	updateLayerItemText (QStandardItem *layerItem)
void	updateSymbolV2ItemText (QStandardItem *symbolItem)
void	updateRasterSymbolItemText (QStandardItem *symbolItem)

Detailed Description

A model that provides group, layer and classification items.

Definition at line 39 of file qgslegendmodel.h.

Member Enumeration Documentation

enum QgsLegendModel::ItemType

Enumerator:

GroupItem
LayerItem
ClassificationItem

Definition at line 45 of file qgslegendmodel.h.

Constructor & Destructor Documentation

QgsLegendModel::QgsLegendModel ( )

Definition at line 35 of file qgslegendmodel.cpp.

References addLayer(), QgsMapLayerRegistry::instance(), mHasTopLevelWindow, and removeLayer().

QgsLegendModel::~QgsLegendModel ( )

Definition at line 49 of file qgslegendmodel.cpp.

Member Function Documentation

QStandardItem * QgsLegendModel::addGroup	(	QString	text = `QString::null`,
		int	position = `-1`
	)

Adds a group.

Parameters

text	name of group (defaults to translation of "Group")
position	insertion position (toplevel position (or -1 if it should be placed at the end of the legend).