QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Slots | Signals | Public Member Functions | Protected Attributes | Private Slots | Private Member Functions | List of all members
QgsLegendModel Class Reference

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

#include <qgslegendmodel.h>

Inheritance diagram for QgsLegendModel:
Inheritance graph
[legend]
Collaboration diagram for QgsLegendModel:
Collaboration graph
[legend]

Public Types

enum  ItemType { GroupItem = 0, LayerItem, ClassificationItem }
 

Public Slots

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

Signals

void layersChanged ()
 

Public Member Functions

 QgsLegendModel ()
 
 ~QgsLegendModel ()
 
void setLayerSetAndGroups (QgsLayerTreeGroup *rootGroup)
 Set layers and groups from a layer tree. More...
 
Q_DECL_DEPRECATED void setLayerSetAndGroups (const QStringList &layerIds, const QList< GroupLayerInfo > &groupInfo)
 Sets layer set and groups. More...
 
void setLayerSet (const QStringList &layerIds, double scaleDenominator=-1, QString rule="")
 
QStandardItem * addGroup (QString text=QString::null, int position=-1, QStandardItem *parentItem=0)
 Adds a group. More...
 
void updateItem (QStandardItem *item)
 Tries to automatically update a model entry (e.g. More...
 
void updateLayer (QStandardItem *layerItem)
 Updates the whole symbology of a layer. More...
 
void updateVectorV2ClassificationItem (QStandardItem *classificationItem, QgsSymbolV2 *symbol, QString itemText)
 Tries to update a single classification item. More...
 
void updateRasterClassificationItem (QStandardItem *classificationItem)
 
void updateItemText (QStandardItem *item)
 Update single item text using item userText and other properties like showFeatureCount. More...
 
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. More...
 
QMimeData * mimeData (const QModelIndexList &indexes) const
 For the drag operation. More...
 
QStringList mimeTypes () const
 
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 Implements the drop operation. More...
 
void setAutoUpdate (bool autoUpdate)
 
bool autoUpdate ()
 

Protected Attributes

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

Private Slots

void updateLayer ()
 

Private Member Functions

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

Detailed Description

A model that provides group, layer and classification items.

Definition at line 40 of file qgslegendmodel.h.

Member Enumeration Documentation

Enumerator
GroupItem 
LayerItem 
ClassificationItem 

Definition at line 46 of file qgslegendmodel.h.

Constructor & Destructor Documentation

QgsLegendModel::QgsLegendModel ( )
QgsLegendModel::~QgsLegendModel ( )

Definition at line 50 of file qgslegendmodel.cpp.

Member Function Documentation

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

Adds a group.

Parameters
textname of group (defaults to translation of "Group")
positioninsertion position (toplevel position (or -1 if it should be placed at the end of the legend).
parentItemparent item
Returns
a pointer to the added group

Definition at line 144 of file qgslegendmodel.cpp.

References layersChanged(), QgsComposerLegendItem::setUserText(), and tr.

Referenced by addGroupFromLayerTree(), and setLayerSetAndGroups().

void QgsLegendModel::addGroupFromLayerTree ( QgsLayerTreeGroup *  parentGroup,
QStandardItem *  parentItem 
)
private

Definition at line 60 of file qgslegendmodel.cpp.

References addGroup(), and addLayer().

Referenced by setLayerSetAndGroups().

void QgsLegendModel::addLayer ( QgsMapLayer theMapLayer,
double  scaleDenominator = -1,
QString  rule = "",
QStandardItem *  parentItem = 0 
)
slot
int QgsLegendModel::addRasterLayerItems ( QStandardItem *  layerItem,
QgsMapLayer rlayer 
)
private
int QgsLegendModel::addVectorLayerItemsV2 ( QStandardItem *  layerItem,
QgsVectorLayer vlayer,
double  scaleDenominator = -1,
QString  rule = "" 
)
private
bool QgsLegendModel::autoUpdate ( )
inline

Definition at line 104 of file qgslegendmodel.h.

Referenced by setAutoUpdate().

bool QgsLegendModel::dropMimeData ( const QMimeData *  data,
Qt::DropAction  action,
int  row,
int  column,
const QModelIndex &  parent 
)

Implements the drop operation.

Definition at line 812 of file qgslegendmodel.cpp.

References index, layersChanged(), and QgsComposerLegendItem::readXML().

Qt::ItemFlags QgsLegendModel::flags ( const QModelIndex &  index) const
void QgsLegendModel::layersChanged ( )
signal
QMimeData * QgsLegendModel::mimeData ( const QModelIndexList &  indexes) const

For the drag operation.

Definition at line 780 of file qgslegendmodel.cpp.

References QgsComposerLegendItem::writeXML().

QStringList QgsLegendModel::mimeTypes ( ) const

Definition at line 805 of file qgslegendmodel.cpp.

bool QgsLegendModel::readXML ( const QDomElement &  legendModelElem,
const QDomDocument &  doc 
)
void QgsLegendModel::removeLayer ( const QString &  layerId)
slot
bool QgsLegendModel::removeRows ( int  row,
int  count,
const QModelIndex &  parent = QModelIndex() 
)
virtual

Implemented to support drag operations.

Definition at line 752 of file qgslegendmodel.cpp.

void QgsLegendModel::setAutoUpdate ( bool  autoUpdate)
void QgsLegendModel::setLayerSet ( const QStringList &  layerIds,
double  scaleDenominator = -1,
QString  rule = "" 
)
void QgsLegendModel::setLayerSetAndGroups ( QgsLayerTreeGroup *  rootGroup)

Set layers and groups from a layer tree.

Note
added in 2.6

Definition at line 54 of file qgslegendmodel.cpp.

References addGroupFromLayerTree().

void QgsLegendModel::setLayerSetAndGroups ( const QStringList &  layerIds,
const QList< GroupLayerInfo > &  groupInfo 
)

Sets layer set and groups.

Deprecated:
in 2.6

Definition at line 79 of file qgslegendmodel.cpp.

References addGroup(), QgsComposerLayerItem::layerID(), and setLayerSet().

Qt::DropActions QgsLegendModel::supportedDropActions ( ) const

Definition at line 696 of file qgslegendmodel.cpp.

void QgsLegendModel::updateItem ( QStandardItem *  item)

Tries to automatically update a model entry (e.g.

a whole layer or only a single item)

Definition at line 420 of file qgslegendmodel.cpp.

References QgsComposerLegendItem::itemType(), QgsComposerLegendItem::LayerItem, and updateLayer().

void QgsLegendModel::updateItemText ( QStandardItem *  item)

Update single item text using item userText and other properties like showFeatureCount.

Definition at line 441 of file qgslegendmodel.cpp.

References updateLayerItemText(), updateRasterSymbolItemText(), updateSymbolV2ItemText(), and QgsComposerLegendItem::userText().

void QgsLegendModel::updateLayer ( QStandardItem *  layerItem)
void QgsLegendModel::updateLayer ( )
privateslot
void QgsLegendModel::updateLayerItemText ( QStandardItem *  layerItem)
private
void QgsLegendModel::updateRasterClassificationItem ( QStandardItem *  classificationItem)
inline

Definition at line 80 of file qgslegendmodel.h.

void QgsLegendModel::updateRasterSymbolItemText ( QStandardItem *  symbolItem)
private
void QgsLegendModel::updateSymbolV2ItemText ( QStandardItem *  symbolItem)
private
void QgsLegendModel::updateVectorV2ClassificationItem ( QStandardItem *  classificationItem,
QgsSymbolV2 symbol,
QString  itemText 
)
inline

Tries to update a single classification item.

Definition at line 78 of file qgslegendmodel.h.

bool QgsLegendModel::writeXML ( QDomElement &  composerLegendElem,
QDomDocument &  doc 
) const

Definition at line 622 of file qgslegendmodel.cpp.

References mAutoUpdate, and QgsComposerLegendItem::writeXML().

Referenced by QgsComposerLegend::writeXML().

Member Data Documentation

bool QgsLegendModel::mAutoUpdate
protected

True if the legend is auto updated when layers are added or removed from the map canvas.

Definition at line 137 of file qgslegendmodel.h.

Referenced by addLayer(), setAutoUpdate(), and writeXML().

bool QgsLegendModel::mHasTopLevelWindow
protected

True if this application has toplevel windows (normally true).

If this is false, this means that the application might not have a running x-server on unix systems and so QPixmap and QIcon cannot be used

Definition at line 134 of file qgslegendmodel.h.

Referenced by addRasterLayerItems(), addVectorLayerItemsV2(), QgsLegendModel(), and readXML().

QStringList QgsLegendModel::mLayerIds
protected

Definition at line 131 of file qgslegendmodel.h.

Referenced by setLayerSet().


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