QGIS API Documentation  2.15.0-Master (94d88e6)
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
QgsLayerTreeModel Class Reference

The QgsLayerTreeModel class is model implementation for Qt item views framework. More...

#include <qgslayertreemodel.h>

Inheritance diagram for QgsLayerTreeModel:
Inheritance graph
[legend]

Classes

struct  LayerLegendData
 Structure that stores all data associated with one map layer. More...
 
struct  LayerLegendTree
 Structure that stores tree representation of map layer's legend. More...
 

Public Types

enum  Flag {
  ShowLegend = 0x0001, ShowSymbology = 0x0001, ShowRasterPreviewIcon = 0x0002, ShowLegendAsTree = 0x0004,
  DeferredLegendInvalidation = 0x0008, AllowNodeReorder = 0x1000, AllowNodeRename = 0x2000, AllowNodeChangeVisibility = 0x4000,
  AllowLegendChangeState = 0x8000, AllowSymbologyChangeState = 0x8000
}
 

Public Member Functions

 QgsLayerTreeModel (QgsLayerTreeGroup *rootNode, QObject *parent=nullptr)
 Construct a new tree model with given layer tree (root node must not be null pointer). More...
 
 ~QgsLayerTreeModel ()
 
int autoCollapseLegendNodes () const
 Return at what number of legend nodes the layer node should be collapsed. -1 means no auto-collapse (default). More...
 
Q_DECL_DEPRECATED int autoCollapseSymbologyNodes () const
 
int columnCount (const QModelIndex &parent=QModelIndex()) const override
 
QModelIndex currentIndex () const
 Get index of the item marked as current. Item marked as current is underlined. More...
 
QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const override
 
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
 
QgsLayerTreeModelLegendNodefindLegendNode (const QString &layerId, const QString &ruleKey) const
 Searches through the layer tree to find a legend node with a matching layer ID and rule key. More...
 
Qt::ItemFlags flags (const QModelIndex &index) const override
 
Flags flags () const
 Return OR-ed combination of model flags. More...
 
QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
 
QgsLayerTreeNodeindex2node (const QModelIndex &index) const
 Return layer tree node for given index. More...
 
QList< QgsLayerTreeNode * > indexes2nodes (const QModelIndexList &list, bool skipInternal=false) const
 Convert a list of indexes to a list of layer tree nodes. More...
 
Q_DECL_DEPRECATED bool isIndexSymbologyNode (const QModelIndex &index) const
 Return true if index represents a legend node (instead of layer node) More...
 
QList< QgsLayerTreeModelLegendNode * > layerLegendNodes (QgsLayerTreeLayer *nodeLayer)
 Return filtered list of active legend nodes attached to a particular layer node. More...
 
Q_DECL_DEPRECATED QgsLayerTreeLayerlayerNodeForSymbologyNode (const QModelIndex &index) const
 Return layer node to which a legend node belongs to. More...
 
QList< QgsLayerTreeModelLegendNode * > layerOriginalLegendNodes (QgsLayerTreeLayer *nodeLayer)
 Return original (unfiltered) list of legend nodes attached to a particular layer node. More...
 
QMap< QString, QStringlayerStyleOverrides () const
 Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one. More...
 
QFont layerTreeNodeFont (int nodeType) const
 Get font for a particular type of layer tree node. nodeType should come from QgsLayerTreeNode::NodeType enumeration. More...
 
Q_DECL_DEPRECATED const QgsMapSettingslegendFilterByMap () const
 Returns the current map settings used for legend filtering. More...
 
double legendFilterByScale () const
 
const QgsMapSettingslegendFilterMapSettings () const
 Returns the current map settings used for the current legend filter (or null if none is enabled) More...
 
void legendMapViewData (double *mapUnitsPerPixel, int *dpi, double *scale)
 Get hints about map view - to be used in legend nodes. More...
 
QModelIndex legendNode2index (QgsLayerTreeModelLegendNode *legendNode)
 Return index for a given legend node. More...
 
QMimeDatamimeData (const QModelIndexList &indexes) const override
 
QStringList mimeTypes () const override
 
QModelIndex node2index (QgsLayerTreeNode *node) const
 Return index for a given node. If the node does not belong to the layer tree, the result is undefined. More...
 
QModelIndex parent (const QModelIndex &child) const override
 
void refreshLayerLegend (QgsLayerTreeLayer *nodeLayer)
 Force a refresh of legend nodes of a layer node. More...
 
Q_DECL_DEPRECATED void refreshLayerSymbology (QgsLayerTreeLayer *nodeLayer)
 
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
 
QgsLayerTreeGrouprootGroup () const
 Return pointer to the root node of the layer tree. Always a non-null pointer. More...
 
int rowCount (const QModelIndex &parent=QModelIndex()) const override
 
void setAutoCollapseLegendNodes (int nodeCount)
 Set at what number of legend nodes the layer node should be collapsed. Setting -1 disables the auto-collapse (default). More...
 
Q_DECL_DEPRECATED void setAutoCollapseSymbologyNodes (int nodeCount)
 
void setCurrentIndex (const QModelIndex &currentIndex)
 Set index of the current item. May be used by view. Item marked as current is underlined. More...
 
bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
 
void setFlag (Flag f, bool on=true)
 Enable or disable a model flag. More...
 
void setFlags (const QgsLayerTreeModel::Flags &f)
 Set OR-ed combination of model flags. More...
 
void setLayerStyleOverrides (const QMap< QString, QString > &overrides)
 Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one. More...
 
void setLayerTreeNodeFont (int nodeType, const QFont &font)
 Set font for a particular type of layer tree node. nodeType should come from QgsLayerTreeNode::NodeType enumeration. More...
 
void setLegendFilter (const QgsMapSettings *settings, bool useExtent=true, const QgsGeometry &polygon=QgsGeometry(), bool useExpressions=true)
 Filter display of legend nodes for given map settings. More...
 
void setLegendFilterByMap (const QgsMapSettings *settings)
 Force only display of legend nodes which are valid for given map settings. More...
 
void setLegendFilterByScale (double scaleDenominator)
 Force only display of legend nodes which are valid for given scale denominator. More...
 
void setLegendMapViewData (double mapUnitsPerPixel, int dpi, double scale)
 Give the layer tree model hints about the currently associated map view so that legend nodes that use map units can be scaled currectly. More...
 
void setRootGroup (QgsLayerTreeGroup *newRootGroup)
 Reset the model and use a new root group node. More...
 
Qt::DropActions supportedDropActions () const override
 
bool testFlag (Flag f) const
 Check whether a flag is enabled. More...
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent)
 
virtual  ~QAbstractItemModel ()
 
virtual QModelIndex buddy (const QModelIndex &index) const
 
virtual bool canFetchMore (const QModelIndex &parent) const
 
virtual int columnCount (const QModelIndex &parent) const =0
 
void columnsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
 
void columnsInserted (const QModelIndex &parent, int start, int end)
 
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsRemoved (const QModelIndex &parent, int start, int end)
 
virtual QVariant data (const QModelIndex &index, int role) const =0
 
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight)
 
virtual void fetchMore (const QModelIndex &parent)
 
virtual bool hasChildren (const QModelIndex &parent) const
 
bool hasIndex (int row, int column, const QModelIndex &parent) const
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role) const
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent) const =0
 
bool insertColumn (int column, const QModelIndex &parent)
 
virtual bool insertColumns (int column, int count, const QModelIndex &parent)
 
bool insertRow (int row, const QModelIndex &parent)
 
virtual bool insertRows (int row, int count, const QModelIndex &parent)
 
virtual QMap< int, QVariantitemData (const QModelIndex &index) const
 
void layoutAboutToBeChanged ()
 
void layoutChanged ()
 
virtual QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits, QFlags< Qt::MatchFlag > flags) const
 
void modelAboutToBeReset ()
 
void modelReset ()
 
virtual QModelIndex parent (const QModelIndex &index) const =0
 
bool removeColumn (int column, const QModelIndex &parent)
 
virtual bool removeColumns (int column, int count, const QModelIndex &parent)
 
bool removeRow (int row, const QModelIndex &parent)
 
virtual void revert ()
 
const QHash< int, QByteArray > & roleNames () const
 
virtual int rowCount (const QModelIndex &parent) const =0
 
void rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
 
void rowsInserted (const QModelIndex &parent, int start, int end)
 
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsRemoved (const QModelIndex &parent, int start, int end)
 
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)
 
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
 
void setSupportedDragActions (QFlags< Qt::DropAction > actions)
 
QModelIndex sibling (int row, int column, const QModelIndex &index) const
 
virtual void sort (int column, Qt::SortOrder order)
 
virtual QSize span (const QModelIndex &index) const
 
virtual bool submit ()
 
Qt::DropActions supportedDragActions () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Static Public Member Functions

static QgsLayerTreeModelLegendNodeindex2legendNode (const QModelIndex &index)
 Return legend node for given index. More...
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Protected Slots

void invalidateLegendMapBasedData ()
 
void layerLegendChanged ()
 
void layerNeedsUpdate ()
 
void legendNodeDataChanged ()
 
void nodeAddedChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo)
 
void nodeCustomPropertyChanged (QgsLayerTreeNode *node, const QString &key)
 
void nodeLayerLoaded ()
 
void nodeLayerWillBeUnloaded ()
 
void nodeRemovedChildren ()
 
void nodeVisibilityChanged (QgsLayerTreeNode *node)
 
void nodeWillAddChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo)
 
void nodeWillRemoveChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo)
 

Protected Member Functions

void addLegendToLayer (QgsLayerTreeLayer *nodeL)
 
void connectToLayer (QgsLayerTreeLayer *nodeLayer)
 
void connectToLayers (QgsLayerTreeGroup *parentGroup)
 
void connectToRootNode ()
 
void disconnectFromLayer (QgsLayerTreeLayer *nodeLayer)
 
void disconnectFromLayers (QgsLayerTreeGroup *parentGroup)
 
void disconnectFromRootNode ()
 
QList< QgsLayerTreeModelLegendNode * > filterLegendNodes (const QList< QgsLayerTreeModelLegendNode * > &nodes)
 Filter nodes from QgsMapLayerLegend according to the current filtering rules. More...
 
QModelIndex indexOfParentLayerTreeNode (QgsLayerTreeNode *parentNode) const
 
void legendCleanup ()
 
bool legendEmbeddedInParent (QgsLayerTreeLayer *nodeLayer) const
 
QIcon legendIconEmbeddedInParent (QgsLayerTreeLayer *nodeLayer) const
 
void legendInvalidateMapBasedData ()
 
QVariant legendNodeData (QgsLayerTreeModelLegendNode *node, int role) const
 
Qt::ItemFlags legendNodeFlags (QgsLayerTreeModelLegendNode *node) const
 
QModelIndex legendNodeIndex (int row, int column, QgsLayerTreeModelLegendNode *node) const
 
int legendNodeRowCount (QgsLayerTreeModelLegendNode *node) const
 
QModelIndex legendParent (QgsLayerTreeModelLegendNode *legendNode) const
 
QModelIndex legendRootIndex (int row, int column, QgsLayerTreeLayer *nL) const
 
int legendRootRowCount (QgsLayerTreeLayer *nL) const
 
void recursivelyEmitDataChanged (const QModelIndex &index=QModelIndex())
 emit dataChanged() for layer tree node items More...
 
void refreshScaleBasedLayers (const QModelIndex &index=QModelIndex())
 Updates layer data for scale dependent layers, should be called when map scale changes. More...
 
void removeLegendFromLayer (QgsLayerTreeLayer *nodeLayer)
 
void tryBuildLegendTree (LayerLegendData &data)
 
- Protected Member Functions inherited from QAbstractItemModel
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 
void beginInsertRows (const QModelIndex &parent, int first, int last)
 
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 
void beginResetModel ()
 
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
 
QModelIndex createIndex (int row, int column, void *ptr) const
 
QModelIndex createIndex (int row, int column, int id) const
 
QModelIndex createIndex (int row, int column, quint32 id) const
 
void endInsertColumns ()
 
void endInsertRows ()
 
void endMoveColumns ()
 
void endMoveRows ()
 
void endRemoveColumns ()
 
void endRemoveRows ()
 
void endResetModel ()
 
QModelIndexList persistentIndexList () const
 
void reset ()
 
void resetInternalData ()
 
void setRoleNames (const QHash< int, QByteArray > &roleNames)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Static Protected Member Functions

static const QIconiconGroup ()
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 

Protected Attributes

int mAutoCollapseLegendNodesCount
 Minimal number of nodes when legend should be automatically collapsed. -1 = disabled. More...
 
QPersistentModelIndex mCurrentIndex
 Current index - will be underlined. More...
 
QTimer mDeferLegendInvalidationTimer
 
Flags mFlags
 Set of flags for the model. More...
 
QFont mFontGroup
 
QFont mFontLayer
 
QMap< QString, QStringmLayerStyleOverrides
 Overrides of map layers' styles: key = layer ID, value = style XML. More...
 
QMap< QgsLayerTreeLayer *, LayerLegendDatamLegend
 Per layer data about layer's legend nodes. More...
 
double mLegendFilterByScale
 scale denominator for filtering of legend nodes (<= 0 means no filtering) More...
 
QScopedPointer< QgsMapHitTestmLegendFilterHitTest
 
QScopedPointer< QgsMapSettingsmLegendFilterMapSettings
 
bool mLegendFilterUsesExtent
 whether to use map filtering More...
 
int mLegendMapViewDpi
 
double mLegendMapViewMupp
 
double mLegendMapViewScale
 
QgsLayerTreeGroupmRootNode
 Pointer to the root node of the layer tree. Not owned by the model. More...
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 

Detailed Description

The QgsLayerTreeModel class is model implementation for Qt item views framework.

The model can be used in any QTreeView, it is however recommended to use it with QgsLayerTreeView which brings additional functionality specific to layer tree handling.

The model listens to the changes in the layer tree and signals the changes as appropriate, so that any view that uses the model is updated accordingly.

Behavior of the model can be customized with flags. For example, whether to show legend or whether to allow changes to the layer tree.

See also
QgsLayerTreeView
Note
added in 2.4

Definition at line 49 of file qgslayertreemodel.h.

Member Enumeration Documentation

Enumerator
ShowLegend 

Add legend nodes for layer nodes.

ShowSymbology 

deprecated - use ShowLegend

ShowRasterPreviewIcon 

Will use real preview of raster layer as icon (may be slow)

ShowLegendAsTree 

For legends that support it, will show them in a tree instead of a list (needs also ShowLegend). Added in 2.8.

DeferredLegendInvalidation 

defer legend model invalidation

AllowNodeReorder 

Allow reordering with drag'n'drop.

AllowNodeRename 

Allow renaming of groups and layers.

AllowNodeChangeVisibility 

Allow user to set node visibility with a check box.

AllowLegendChangeState 

Allow check boxes for legend nodes (if supported by layer's legend)

AllowSymbologyChangeState 

deprecated - use AllowLegendChangeState

Definition at line 75 of file qgslayertreemodel.h.

Constructor & Destructor Documentation

QgsLayerTreeModel::QgsLayerTreeModel ( QgsLayerTreeGroup rootNode,
QObject parent = nullptr 
)
explicit

Construct a new tree model with given layer tree (root node must not be null pointer).

The root node is not transferred by the model.

Definition at line 36 of file qgslayertreemodel.cpp.

QgsLayerTreeModel::~QgsLayerTreeModel ( )

Definition at line 55 of file qgslayertreemodel.cpp.

Member Function Documentation

void QgsLayerTreeModel::addLegendToLayer ( QgsLayerTreeLayer nodeL)
protected

Definition at line 1153 of file qgslayertreemodel.cpp.

int QgsLayerTreeModel::autoCollapseLegendNodes ( ) const
inline

Return at what number of legend nodes the layer node should be collapsed. -1 means no auto-collapse (default).

Definition at line 162 of file qgslayertreemodel.h.

Q_DECL_DEPRECATED int QgsLayerTreeModel::autoCollapseSymbologyNodes ( ) const
inline
int QgsLayerTreeModel::columnCount ( const QModelIndex parent = QModelIndex()) const
override

Definition at line 90 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::connectToLayer ( QgsLayerTreeLayer nodeLayer)
protected

Definition at line 803 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::connectToLayers ( QgsLayerTreeGroup parentGroup)
protected

Definition at line 881 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::connectToRootNode ( )
protected

Definition at line 903 of file qgslayertreemodel.cpp.

QModelIndex QgsLayerTreeModel::currentIndex ( ) const

Get index of the item marked as current. Item marked as current is underlined.

Definition at line 517 of file qgslayertreemodel.cpp.

QVariant QgsLayerTreeModel::data ( const QModelIndex index,
int  role = Qt::DisplayRole 
) const
override

Definition at line 155 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::disconnectFromLayer ( QgsLayerTreeLayer nodeLayer)
protected

Definition at line 862 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::disconnectFromLayers ( QgsLayerTreeGroup parentGroup)
protected

Definition at line 892 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::disconnectFromRootNode ( )
protected

Definition at line 918 of file qgslayertreemodel.cpp.

bool QgsLayerTreeModel::dropMimeData ( const QMimeData data,
Qt::DropAction  action,
int  row,
int  column,
const QModelIndex parent 
)
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 995 of file qgslayertreemodel.cpp.

QList< QgsLayerTreeModelLegendNode * > QgsLayerTreeModel::filterLegendNodes ( const QList< QgsLayerTreeModelLegendNode * > &  nodes)
protected

Filter nodes from QgsMapLayerLegend according to the current filtering rules.

Definition at line 1087 of file qgslayertreemodel.cpp.

QgsLayerTreeModelLegendNode * QgsLayerTreeModel::findLegendNode ( const QString layerId,
const QString ruleKey 
) const

Searches through the layer tree to find a legend node with a matching layer ID and rule key.

Parameters
layerIdmap layer ID
ruleKeylegend node rule key
Returns
QgsLayerTreeModelLegendNode if found
Note
added in QGIS 2.14

Definition at line 1389 of file qgslayertreemodel.cpp.

Qt::ItemFlags QgsLayerTreeModel::flags ( const QModelIndex index) const
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 308 of file qgslayertreemodel.cpp.

QgsLayerTreeModel::Flags QgsLayerTreeModel::flags ( ) const

Return OR-ed combination of model flags.

Definition at line 1067 of file qgslayertreemodel.cpp.

const QIcon & QgsLayerTreeModel::iconGroup ( )
staticprotected

Definition at line 1077 of file qgslayertreemodel.cpp.

QModelIndex QgsLayerTreeModel::index ( int  row,
int  column,
const QModelIndex parent = QModelIndex() 
) const
override

Definition at line 96 of file qgslayertreemodel.cpp.

QgsLayerTreeModelLegendNode * QgsLayerTreeModel::index2legendNode ( const QModelIndex index)
static

Return legend node for given index.

Returns null for invalid index

Note
added in 2.6

Definition at line 1248 of file qgslayertreemodel.cpp.

QgsLayerTreeNode * QgsLayerTreeModel::index2node ( const QModelIndex index) const

Return layer tree node for given index.

Returns root node for invalid index. Returns null pointer if index does not refer to a layer tree node (e.g. it is a legend node)

Definition at line 60 of file qgslayertreemodel.cpp.

QList< QgsLayerTreeNode * > QgsLayerTreeModel::indexes2nodes ( const QModelIndexList &  list,
bool  skipInternal = false 
) const

Convert a list of indexes to a list of layer tree nodes.

Indices that do not represent layer tree nodes are skipped.

  • skipInternal If true, a node is included in the output list only if no parent node is in the list

Definition at line 440 of file qgslayertreemodel.cpp.

QModelIndex QgsLayerTreeModel::indexOfParentLayerTreeNode ( QgsLayerTreeNode parentNode) const
protected

Definition at line 140 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::invalidateLegendMapBasedData ( )
protectedslot

Definition at line 1419 of file qgslayertreemodel.cpp.

bool QgsLayerTreeModel::isIndexSymbologyNode ( const QModelIndex index) const

Return true if index represents a legend node (instead of layer node)

Deprecated:
use index2legendNode()

Definition at line 466 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::layerLegendChanged ( )
protectedslot

Definition at line 757 of file qgslayertreemodel.cpp.

QList< QgsLayerTreeModelLegendNode * > QgsLayerTreeModel::layerLegendNodes ( QgsLayerTreeLayer nodeLayer)

Return filtered list of active legend nodes attached to a particular layer node.

Note
added in 2.6
See also
layerOriginalLegendNodes()

Definition at line 1379 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::layerNeedsUpdate ( )
protectedslot

Definition at line 773 of file qgslayertreemodel.cpp.

QgsLayerTreeLayer * QgsLayerTreeModel::layerNodeForSymbologyNode ( const QModelIndex index) const

Return layer node to which a legend node belongs to.

Returns null pointer if index is not a legend node.

Deprecated:
use index2legendNode()->parent()

Definition at line 471 of file qgslayertreemodel.cpp.

QList< QgsLayerTreeModelLegendNode * > QgsLayerTreeModel::layerOriginalLegendNodes ( QgsLayerTreeLayer nodeLayer)

Return original (unfiltered) list of legend nodes attached to a particular layer node.

Note
added in 2.14
See also
layerLegendNodes()

Definition at line 1384 of file qgslayertreemodel.cpp.

QMap< QString, QString > QgsLayerTreeModel::layerStyleOverrides ( ) const

Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one.

Note
added in 2.10

Definition at line 662 of file qgslayertreemodel.cpp.

QFont QgsLayerTreeModel::layerTreeNodeFont ( int  nodeType) const

Get font for a particular type of layer tree node. nodeType should come from QgsLayerTreeNode::NodeType enumeration.

Definition at line 559 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::legendCleanup ( )
protected

Definition at line 1131 of file qgslayertreemodel.cpp.

bool QgsLayerTreeModel::legendEmbeddedInParent ( QgsLayerTreeLayer nodeLayer) const
protected

Definition at line 1366 of file qgslayertreemodel.cpp.

Q_DECL_DEPRECATED const QgsMapSettings* QgsLayerTreeModel::legendFilterByMap ( ) const
inline

Returns the current map settings used for legend filtering.

Deprecated:
It has been renamed to legendFilterMapSettings()

Definition at line 186 of file qgslayertreemodel.h.

double QgsLayerTreeModel::legendFilterByScale ( ) const
inline

Definition at line 168 of file qgslayertreemodel.h.

const QgsMapSettings* QgsLayerTreeModel::legendFilterMapSettings ( ) const
inline

Returns the current map settings used for the current legend filter (or null if none is enabled)

Note
added in 2.14

Definition at line 190 of file qgslayertreemodel.h.

QIcon QgsLayerTreeModel::legendIconEmbeddedInParent ( QgsLayerTreeLayer nodeLayer) const
protected

Definition at line 1373 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::legendInvalidateMapBasedData ( )
protected

Definition at line 1411 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::legendMapViewData ( double *  mapUnitsPerPixel,
int *  dpi,
double *  scale 
)

Get hints about map view - to be used in legend nodes.

Arguments that are not null will receive values. If there are no valid map view data (from previous call to setLegendMapViewData()), returned values are zeros.

Note
added in 2.6

Definition at line 655 of file qgslayertreemodel.cpp.

QModelIndex QgsLayerTreeModel::legendNode2index ( QgsLayerTreeModelLegendNode legendNode)

Return index for a given legend node.

If the legend node does not belong to the layer tree, the result is undefined. If the legend node is belongs to the tree but it is filtered out, invalid model index is returned.

Note
added in 2.6

Definition at line 1254 of file qgslayertreemodel.cpp.

QVariant QgsLayerTreeModel::legendNodeData ( QgsLayerTreeModelLegendNode node,
int  role 
) const
protected

Definition at line 1349 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::legendNodeDataChanged ( )
protectedslot

Definition at line 791 of file qgslayertreemodel.cpp.

Qt::ItemFlags QgsLayerTreeModel::legendNodeFlags ( QgsLayerTreeModelLegendNode node) const
protected

Definition at line 1357 of file qgslayertreemodel.cpp.

QModelIndex QgsLayerTreeModel::legendNodeIndex ( int  row,
int  column,
QgsLayerTreeModelLegendNode node 
) const
protected

Definition at line 1319 of file qgslayertreemodel.cpp.

int QgsLayerTreeModel::legendNodeRowCount ( QgsLayerTreeModelLegendNode node) const
protected

Definition at line 1282 of file qgslayertreemodel.cpp.

QModelIndex QgsLayerTreeModel::legendParent ( QgsLayerTreeModelLegendNode legendNode) const
protected

Definition at line 1329 of file qgslayertreemodel.cpp.

QModelIndex QgsLayerTreeModel::legendRootIndex ( int  row,
int  column,
QgsLayerTreeLayer nL 
) const
protected

Definition at line 1308 of file qgslayertreemodel.cpp.

int QgsLayerTreeModel::legendRootRowCount ( QgsLayerTreeLayer nL) const
protected

Definition at line 1292 of file qgslayertreemodel.cpp.

QMimeData * QgsLayerTreeModel::mimeData ( const QModelIndexList &  indexes) const
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 971 of file qgslayertreemodel.cpp.

QStringList QgsLayerTreeModel::mimeTypes ( ) const
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 963 of file qgslayertreemodel.cpp.

QModelIndex QgsLayerTreeModel::node2index ( QgsLayerTreeNode node) const

Return index for a given node. If the node does not belong to the layer tree, the result is undefined.

Definition at line 404 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::nodeAddedChildren ( QgsLayerTreeNode node,
int  indexFrom,
int  indexTo 
)
protectedslot

Definition at line 693 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::nodeCustomPropertyChanged ( QgsLayerTreeNode node,
const QString key 
)
protectedslot

Definition at line 728 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::nodeLayerLoaded ( )
protectedslot

Definition at line 735 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::nodeLayerWillBeUnloaded ( )
protectedslot

Definition at line 745 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::nodeRemovedChildren ( )
protectedslot

Definition at line 714 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::nodeVisibilityChanged ( QgsLayerTreeNode node)
protectedslot

Definition at line 719 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::nodeWillAddChildren ( QgsLayerTreeNode node,
int  indexFrom,
int  indexTo 
)
protectedslot

Definition at line 672 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::nodeWillRemoveChildren ( QgsLayerTreeNode node,
int  indexFrom,
int  indexTo 
)
protectedslot

Definition at line 703 of file qgslayertreemodel.cpp.

QModelIndex QgsLayerTreeModel::parent ( const QModelIndex child) const
override

Definition at line 118 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::recursivelyEmitDataChanged ( const QModelIndex index = QModelIndex())
protected

emit dataChanged() for layer tree node items

Definition at line 925 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::refreshLayerLegend ( QgsLayerTreeLayer nodeLayer)

Force a refresh of legend nodes of a layer node.

Not necessary to call when layer's renderer is changed as the model listens to these events.

Definition at line 497 of file qgslayertreemodel.cpp.

Q_DECL_DEPRECATED void QgsLayerTreeModel::refreshLayerSymbology ( QgsLayerTreeLayer nodeLayer)
inline
Deprecated:
use refreshLayerLegend()

Definition at line 215 of file qgslayertreemodel.h.

void QgsLayerTreeModel::refreshScaleBasedLayers ( const QModelIndex index = QModelIndex())
protected

Updates layer data for scale dependent layers, should be called when map scale changes.

Emits dataChanged() for all scale dependent layers.

Note
added in QGIS 2.16

Definition at line 939 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::removeLegendFromLayer ( QgsLayerTreeLayer nodeLayer)
protected

Definition at line 1142 of file qgslayertreemodel.cpp.

bool QgsLayerTreeModel::removeRows ( int  row,
int  count,
const QModelIndex parent = QModelIndex() 
)
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 1043 of file qgslayertreemodel.cpp.

QgsLayerTreeGroup * QgsLayerTreeModel::rootGroup ( ) const

Return pointer to the root node of the layer tree. Always a non-null pointer.

Definition at line 477 of file qgslayertreemodel.cpp.

int QgsLayerTreeModel::rowCount ( const QModelIndex parent = QModelIndex()) const
override

Definition at line 70 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setAutoCollapseLegendNodes ( int  nodeCount)
inline

Set at what number of legend nodes the layer node should be collapsed. Setting -1 disables the auto-collapse (default).

Definition at line 160 of file qgslayertreemodel.h.

Q_DECL_DEPRECATED void QgsLayerTreeModel::setAutoCollapseSymbologyNodes ( int  nodeCount)
inline
void QgsLayerTreeModel::setCurrentIndex ( const QModelIndex currentIndex)

Set index of the current item. May be used by view. Item marked as current is underlined.

Definition at line 522 of file qgslayertreemodel.cpp.

bool QgsLayerTreeModel::setData ( const QModelIndex index,
const QVariant value,
int  role = Qt::EditRole 
)
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 345 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setFlag ( QgsLayerTreeModel::Flag  f,
bool  on = true 
)

Enable or disable a model flag.

Definition at line 1059 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setFlags ( const QgsLayerTreeModel::Flags &  f)

Set OR-ed combination of model flags.

Definition at line 1054 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setLayerStyleOverrides ( const QMap< QString, QString > &  overrides)

Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one.

Note
added in 2.10

Definition at line 667 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setLayerTreeNodeFont ( int  nodeType,
const QFont font 
)

Set font for a particular type of layer tree node. nodeType should come from QgsLayerTreeNode::NodeType enumeration.

Definition at line 534 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setLegendFilter ( const QgsMapSettings settings,
bool  useExtent = true,
const QgsGeometry polygon = QgsGeometry(),
bool  useExpressions = true 
)

Filter display of legend nodes for given map settings.

Parameters
settingsMap settings. Setting a null pointer or invalid settings will disable any filter. Ownership is not changed, a copy is made
useExtentWhether to use the extent of the map settings as a first spatial filter on legend nodes
polygonIf not empty, this polygon will be used instead of the map extent to filter legend nodes
useExpressionsWhether to use legend node filter expressions
Note
added in 2.14

Definition at line 587 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setLegendFilterByMap ( const QgsMapSettings settings)

Force only display of legend nodes which are valid for given map settings.

Setting null pointer or invalid map settings will disable the functionality. Ownership of map settings pointer does not change, a copy is made.

Note
added in 2.6

Definition at line 582 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setLegendFilterByScale ( double  scaleDenominator)

Force only display of legend nodes which are valid for given scale denominator.

Setting value <= 0 will disable the functionality

Note
added in 2.6

Definition at line 572 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setLegendMapViewData ( double  mapUnitsPerPixel,
int  dpi,
double  scale 
)

Give the layer tree model hints about the currently associated map view so that legend nodes that use map units can be scaled currectly.

Note
added in 2.6

Definition at line 640 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::setRootGroup ( QgsLayerTreeGroup newRootGroup)

Reset the model and use a new root group node.

Note
added in 2.6

Definition at line 482 of file qgslayertreemodel.cpp.

Qt::DropActions QgsLayerTreeModel::supportedDropActions ( ) const
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 958 of file qgslayertreemodel.cpp.

bool QgsLayerTreeModel::testFlag ( QgsLayerTreeModel::Flag  f) const

Check whether a flag is enabled.

Definition at line 1072 of file qgslayertreemodel.cpp.

void QgsLayerTreeModel::tryBuildLegendTree ( LayerLegendData data)
protected
Note
not available in Python bindings

Definition at line 1208 of file qgslayertreemodel.cpp.

Member Data Documentation

int QgsLayerTreeModel::mAutoCollapseLegendNodesCount
protected

Minimal number of nodes when legend should be automatically collapsed. -1 = disabled.

Definition at line 291 of file qgslayertreemodel.h.

QPersistentModelIndex QgsLayerTreeModel::mCurrentIndex
protected

Current index - will be underlined.

Definition at line 289 of file qgslayertreemodel.h.

QTimer QgsLayerTreeModel::mDeferLegendInvalidationTimer
protected

Definition at line 346 of file qgslayertreemodel.h.

Flags QgsLayerTreeModel::mFlags
protected

Set of flags for the model.

Definition at line 287 of file qgslayertreemodel.h.

QFont QgsLayerTreeModel::mFontGroup
protected

Definition at line 332 of file qgslayertreemodel.h.

QFont QgsLayerTreeModel::mFontLayer
protected

Definition at line 331 of file qgslayertreemodel.h.

QMap<QString, QString> QgsLayerTreeModel::mLayerStyleOverrides
protected

Overrides of map layers' styles: key = layer ID, value = style XML.

This allows to show legend that is different from the current style of layers

Definition at line 326 of file qgslayertreemodel.h.

QMap<QgsLayerTreeLayer*, LayerLegendData> QgsLayerTreeModel::mLegend
protected

Per layer data about layer's legend nodes.

Definition at line 329 of file qgslayertreemodel.h.

double QgsLayerTreeModel::mLegendFilterByScale
protected

scale denominator for filtering of legend nodes (<= 0 means no filtering)

Definition at line 335 of file qgslayertreemodel.h.

QScopedPointer<QgsMapHitTest> QgsLayerTreeModel::mLegendFilterHitTest
protected

Definition at line 338 of file qgslayertreemodel.h.

QScopedPointer<QgsMapSettings> QgsLayerTreeModel::mLegendFilterMapSettings
protected

Definition at line 337 of file qgslayertreemodel.h.

bool QgsLayerTreeModel::mLegendFilterUsesExtent
protected

whether to use map filtering

Definition at line 341 of file qgslayertreemodel.h.

int QgsLayerTreeModel::mLegendMapViewDpi
protected

Definition at line 344 of file qgslayertreemodel.h.

double QgsLayerTreeModel::mLegendMapViewMupp
protected

Definition at line 343 of file qgslayertreemodel.h.

double QgsLayerTreeModel::mLegendMapViewScale
protected

Definition at line 345 of file qgslayertreemodel.h.

QgsLayerTreeGroup* QgsLayerTreeModel::mRootNode
protected

Pointer to the root node of the layer tree. Not owned by the model.

Definition at line 285 of file qgslayertreemodel.h.


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