QGIS API Documentation  2.99.0-Master (b698612)
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, ShowRasterPreviewIcon = 0x0002, ShowLegendAsTree = 0x0004, DeferredLegendInvalidation = 0x0008,
  UseEmbeddedWidgets = 0x0010, AllowNodeReorder = 0x1000, AllowNodeRename = 0x2000, AllowNodeChangeVisibility = 0x4000,
  AllowLegendChangeState = 0x8000, ActionHierarchical = 0x10000
}
 

Public Member Functions

 QgsLayerTreeModel (QgsLayerTree *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...
 
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...
 
QList< QgsLayerTreeModelLegendNode * > layerLegendNodes (QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent=false)
 Return filtered list of active legend nodes attached to a particular layer node (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true) More...
 
QList< QgsLayerTreeModelLegendNode * > layerOriginalLegendNodes (QgsLayerTreeLayer *nodeLayer)
 Return original (unfiltered) list of legend nodes attached to a particular layer node. More...
 
QMap< QString, QString > 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. More...
 
QFont layerTreeNodeFont (int nodeType) const
 Get font for a particular type of layer tree node. nodeType should come from QgsLayerTreeNode::NodeType enumeration. More...
 
double legendFilterByScale () const
 Returns the scale which restricts the legend nodes which are visible. More...
 
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) const
 Get hints about map view - to be used in legend nodes. More...
 
QModelIndex legendNode2index (QgsLayerTreeModelLegendNode *legendNode)
 Return index for a given legend node. More...
 
QgsLayerTreeModelLegendNodelegendNodeEmbeddedInParent (QgsLayerTreeLayer *nodeLayer) const
 Return legend node that may be embedded in parent (i.e. More...
 
QMimeData * mimeData (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...
 
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
 
QgsLayerTreerootGroup () 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...
 
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 (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 scale)
 Force only display of legend nodes which are valid for a given scale. 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 (QgsLayerTree *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...
 

Static Public Member Functions

static QgsLayerTreeModelLegendNodeindex2legendNode (const QModelIndex &index)
 Return legend node for given index. More...
 

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 nodeNameChanged (QgsLayerTreeNode *node, const QString &name)
 Updates model when node's name has changed. More...
 
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)
 
LayerLegendTreetryBuildLegendTree (const QList< QgsLayerTreeModelLegendNode *> &nodes)
 

Static Protected Member Functions

static QIcon iconGroup ()
 

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, QString > mLayerStyleOverrides
 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...
 
std::unique_ptr< QgsMapHitTestmLegendFilterHitTest
 
std::unique_ptr< QgsMapSettingsmLegendFilterMapSettings
 
bool mLegendFilterUsesExtent
 whether to use map filtering More...
 
int mLegendMapViewDpi
 
double mLegendMapViewMupp
 
double mLegendMapViewScale
 
QgsLayerTreemRootNode = nullptr
 Pointer to the root node of the layer tree. Not owned by the model. More...
 

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
Since
QGIS 2.4

Definition at line 54 of file qgslayertreemodel.h.

Member Enumeration Documentation

◆ Flag

Enumerator
ShowLegend 

Add legend nodes for layer nodes.

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.

UseEmbeddedWidgets 

Layer nodes may optionally include extra embedded widgets (if used in QgsLayerTreeView). Added in 2.16.

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)

ActionHierarchical 

Check/uncheck action has consequences on children (or parents for leaf node)

Definition at line 91 of file qgslayertreemodel.h.

Constructor & Destructor Documentation

◆ QgsLayerTreeModel()

QgsLayerTreeModel::QgsLayerTreeModel ( QgsLayerTree 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 66 of file qgslayertreemodel.cpp.

◆ ~QgsLayerTreeModel()

QgsLayerTreeModel::~QgsLayerTreeModel ( )

Definition at line 85 of file qgslayertreemodel.cpp.

Member Function Documentation

◆ addLegendToLayer()

void QgsLayerTreeModel::addLegendToLayer ( QgsLayerTreeLayer nodeL)
protected

Definition at line 1196 of file qgslayertreemodel.cpp.

◆ autoCollapseLegendNodes()

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 184 of file qgslayertreemodel.h.

◆ columnCount()

int QgsLayerTreeModel::columnCount ( const QModelIndex &  parent = QModelIndex()) const
override

Definition at line 120 of file qgslayertreemodel.cpp.

◆ connectToLayer()

void QgsLayerTreeModel::connectToLayer ( QgsLayerTreeLayer nodeLayer)
protected

Definition at line 844 of file qgslayertreemodel.cpp.

◆ connectToLayers()

void QgsLayerTreeModel::connectToLayers ( QgsLayerTreeGroup parentGroup)
protected

Definition at line 922 of file qgslayertreemodel.cpp.

◆ connectToRootNode()

void QgsLayerTreeModel::connectToRootNode ( )
protected

Definition at line 944 of file qgslayertreemodel.cpp.

◆ currentIndex()

QModelIndex QgsLayerTreeModel::currentIndex ( ) const

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

Definition at line 549 of file qgslayertreemodel.cpp.

◆ data()

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

Definition at line 185 of file qgslayertreemodel.cpp.

◆ disconnectFromLayer()

void QgsLayerTreeModel::disconnectFromLayer ( QgsLayerTreeLayer nodeLayer)
protected

Definition at line 903 of file qgslayertreemodel.cpp.

◆ disconnectFromLayers()

void QgsLayerTreeModel::disconnectFromLayers ( QgsLayerTreeGroup parentGroup)
protected

Definition at line 933 of file qgslayertreemodel.cpp.

◆ disconnectFromRootNode()

void QgsLayerTreeModel::disconnectFromRootNode ( )
protected

Definition at line 960 of file qgslayertreemodel.cpp.

◆ dropMimeData()

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

Definition at line 1040 of file qgslayertreemodel.cpp.

◆ filterLegendNodes()

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

Filter nodes from QgsMapLayerLegend according to the current filtering rules.

Definition at line 1127 of file qgslayertreemodel.cpp.

◆ findLegendNode()

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
Since
QGIS 2.14

Definition at line 1488 of file qgslayertreemodel.cpp.

◆ flags() [1/2]

Qt::ItemFlags QgsLayerTreeModel::flags ( const QModelIndex &  index) const
override

Definition at line 346 of file qgslayertreemodel.cpp.

◆ flags() [2/2]

QgsLayerTreeModel::Flags QgsLayerTreeModel::flags ( ) const

Return OR-ed combination of model flags.

Definition at line 1112 of file qgslayertreemodel.cpp.

◆ iconGroup()

QIcon QgsLayerTreeModel::iconGroup ( )
staticprotected

Definition at line 1122 of file qgslayertreemodel.cpp.

◆ index()

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

Definition at line 126 of file qgslayertreemodel.cpp.

◆ index2legendNode()

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

Return legend node for given index.

Returns null for invalid index

Since
QGIS 2.6

Definition at line 1334 of file qgslayertreemodel.cpp.

◆ index2node()

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 90 of file qgslayertreemodel.cpp.

◆ indexes2nodes()

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 483 of file qgslayertreemodel.cpp.

◆ indexOfParentLayerTreeNode()

QModelIndex QgsLayerTreeModel::indexOfParentLayerTreeNode ( QgsLayerTreeNode parentNode) const
protected

Definition at line 170 of file qgslayertreemodel.cpp.

◆ invalidateLegendMapBasedData

void QgsLayerTreeModel::invalidateLegendMapBasedData ( )
protectedslot

Definition at line 1518 of file qgslayertreemodel.cpp.

◆ layerLegendChanged

void QgsLayerTreeModel::layerLegendChanged ( )
protectedslot

Definition at line 798 of file qgslayertreemodel.cpp.

◆ layerLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsLayerTreeModel::layerLegendNodes ( QgsLayerTreeLayer nodeLayer,
bool  skipNodeEmbeddedInParent = false 
)

Return filtered list of active legend nodes attached to a particular layer node (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true)

Since
QGIS 2.6
Note
Parameter skipNodeEmbeddedInParent added in QGIS 2.18
See also
layerOriginalLegendNodes()

Definition at line 1471 of file qgslayertreemodel.cpp.

◆ layerNeedsUpdate

void QgsLayerTreeModel::layerNeedsUpdate ( )
protectedslot

Definition at line 814 of file qgslayertreemodel.cpp.

◆ layerOriginalLegendNodes()

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

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

Since
QGIS 2.14
See also
layerLegendNodes()

Definition at line 1483 of file qgslayertreemodel.cpp.

◆ layerStyleOverrides()

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.

Since
QGIS 2.10

Definition at line 694 of file qgslayertreemodel.cpp.

◆ layerTreeNodeFont()

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 591 of file qgslayertreemodel.cpp.

◆ legendCleanup()

void QgsLayerTreeModel::legendCleanup ( )
protected

Definition at line 1174 of file qgslayertreemodel.cpp.

◆ legendEmbeddedInParent()

bool QgsLayerTreeModel::legendEmbeddedInParent ( QgsLayerTreeLayer nodeLayer) const
protected

Definition at line 1451 of file qgslayertreemodel.cpp.

◆ legendFilterByScale()

double QgsLayerTreeModel::legendFilterByScale ( ) const
inline

Returns the scale which restricts the legend nodes which are visible.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale <= 0 indicates that no scale filtering is being performed.

Since
QGIS 2.6
See also
setLegendFilterByScale()

Definition at line 202 of file qgslayertreemodel.h.

◆ legendFilterMapSettings()

const QgsMapSettings* QgsLayerTreeModel::legendFilterMapSettings ( ) const
inline

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

Since
QGIS 2.14

Definition at line 220 of file qgslayertreemodel.h.

◆ legendIconEmbeddedInParent()

QIcon QgsLayerTreeModel::legendIconEmbeddedInParent ( QgsLayerTreeLayer nodeLayer) const
protected

Definition at line 1462 of file qgslayertreemodel.cpp.

◆ legendInvalidateMapBasedData()

void QgsLayerTreeModel::legendInvalidateMapBasedData ( )
protected

Definition at line 1510 of file qgslayertreemodel.cpp.

◆ legendMapViewData()

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

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.

Since
QGIS 2.6

Definition at line 687 of file qgslayertreemodel.cpp.

◆ legendNode2index()

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.

Since
QGIS 2.6

Definition at line 1340 of file qgslayertreemodel.cpp.

◆ legendNodeData()

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

Definition at line 1434 of file qgslayertreemodel.cpp.

◆ legendNodeDataChanged

void QgsLayerTreeModel::legendNodeDataChanged ( )
protectedslot

Definition at line 832 of file qgslayertreemodel.cpp.

◆ legendNodeEmbeddedInParent()

QgsLayerTreeModelLegendNode * QgsLayerTreeModel::legendNodeEmbeddedInParent ( QgsLayerTreeLayer nodeLayer) const

Return legend node that may be embedded in parent (i.e.

its icon will be used for layer's icon).

Since
QGIS 2.18

Definition at line 1456 of file qgslayertreemodel.cpp.

◆ legendNodeFlags()

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

Definition at line 1442 of file qgslayertreemodel.cpp.

◆ legendNodeIndex()

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

Definition at line 1404 of file qgslayertreemodel.cpp.

◆ legendNodeRowCount()

int QgsLayerTreeModel::legendNodeRowCount ( QgsLayerTreeModelLegendNode node) const
protected

Definition at line 1369 of file qgslayertreemodel.cpp.

◆ legendParent()

QModelIndex QgsLayerTreeModel::legendParent ( QgsLayerTreeModelLegendNode legendNode) const
protected

Definition at line 1414 of file qgslayertreemodel.cpp.

◆ legendRootIndex()

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

Definition at line 1393 of file qgslayertreemodel.cpp.

◆ legendRootRowCount()

int QgsLayerTreeModel::legendRootRowCount ( QgsLayerTreeLayer nL) const
protected

Definition at line 1379 of file qgslayertreemodel.cpp.

◆ mimeData()

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

Definition at line 1013 of file qgslayertreemodel.cpp.

◆ mimeTypes()

QStringList QgsLayerTreeModel::mimeTypes ( ) const
override

Definition at line 1005 of file qgslayertreemodel.cpp.

◆ node2index()

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 447 of file qgslayertreemodel.cpp.

◆ nodeAddedChildren

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

Definition at line 725 of file qgslayertreemodel.cpp.

◆ nodeCustomPropertyChanged

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

Definition at line 769 of file qgslayertreemodel.cpp.

◆ nodeLayerLoaded

void QgsLayerTreeModel::nodeLayerLoaded ( )
protectedslot

Definition at line 776 of file qgslayertreemodel.cpp.

◆ nodeLayerWillBeUnloaded

void QgsLayerTreeModel::nodeLayerWillBeUnloaded ( )
protectedslot

Definition at line 786 of file qgslayertreemodel.cpp.

◆ nodeNameChanged

void QgsLayerTreeModel::nodeNameChanged ( QgsLayerTreeNode node,
const QString &  name 
)
protectedslot

Updates model when node's name has changed.

Since
QGIS 3.0

Definition at line 759 of file qgslayertreemodel.cpp.

◆ nodeRemovedChildren

void QgsLayerTreeModel::nodeRemovedChildren ( )
protectedslot

Definition at line 746 of file qgslayertreemodel.cpp.

◆ nodeVisibilityChanged

void QgsLayerTreeModel::nodeVisibilityChanged ( QgsLayerTreeNode node)
protectedslot

Definition at line 751 of file qgslayertreemodel.cpp.

◆ nodeWillAddChildren

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

Definition at line 704 of file qgslayertreemodel.cpp.

◆ nodeWillRemoveChildren

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

Definition at line 735 of file qgslayertreemodel.cpp.

◆ parent()

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

Definition at line 148 of file qgslayertreemodel.cpp.

◆ recursivelyEmitDataChanged()

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

emit dataChanged() for layer tree node items

Definition at line 967 of file qgslayertreemodel.cpp.

◆ refreshLayerLegend()

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 529 of file qgslayertreemodel.cpp.

◆ refreshScaleBasedLayers()

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.

Since
QGIS 2.16

Definition at line 981 of file qgslayertreemodel.cpp.

◆ removeLegendFromLayer()

void QgsLayerTreeModel::removeLegendFromLayer ( QgsLayerTreeLayer nodeLayer)
protected

Definition at line 1185 of file qgslayertreemodel.cpp.

◆ removeRows()

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

Definition at line 1088 of file qgslayertreemodel.cpp.

◆ rootGroup()

QgsLayerTree * QgsLayerTreeModel::rootGroup ( ) const

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

Definition at line 509 of file qgslayertreemodel.cpp.

◆ rowCount()

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

Definition at line 100 of file qgslayertreemodel.cpp.

◆ setAutoCollapseLegendNodes()

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 182 of file qgslayertreemodel.h.

◆ setCurrentIndex()

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 554 of file qgslayertreemodel.cpp.

◆ setData()

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

Definition at line 383 of file qgslayertreemodel.cpp.

◆ setFlag()

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

Enable or disable a model flag.

Definition at line 1104 of file qgslayertreemodel.cpp.

◆ setFlags()

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

Set OR-ed combination of model flags.

Definition at line 1099 of file qgslayertreemodel.cpp.

◆ setLayerStyleOverrides()

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.

Since
QGIS 2.10

Definition at line 699 of file qgslayertreemodel.cpp.

◆ setLayerTreeNodeFont()

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 566 of file qgslayertreemodel.cpp.

◆ setLegendFilter()

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
Since
QGIS 2.14

Definition at line 619 of file qgslayertreemodel.cpp.

◆ setLegendFilterByMap()

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.

Since
QGIS 2.6

Definition at line 614 of file qgslayertreemodel.cpp.

◆ setLegendFilterByScale()

void QgsLayerTreeModel::setLegendFilterByScale ( double  scale)

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

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. Setting scale <= 0 will disable the functionality.

Since
QGIS 2.6
See also
legendFilterByScale()

Definition at line 604 of file qgslayertreemodel.cpp.

◆ setLegendMapViewData()

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.

Since
QGIS 2.6

Definition at line 672 of file qgslayertreemodel.cpp.

◆ setRootGroup()

void QgsLayerTreeModel::setRootGroup ( QgsLayerTree newRootGroup)

Reset the model and use a new root group node.

Since
QGIS 2.6

Definition at line 514 of file qgslayertreemodel.cpp.

◆ supportedDropActions()

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

Definition at line 1000 of file qgslayertreemodel.cpp.

◆ testFlag()

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

Check whether a flag is enabled.

Definition at line 1117 of file qgslayertreemodel.cpp.

◆ tryBuildLegendTree()

QgsLayerTreeModel::LayerLegendTree * QgsLayerTreeModel::tryBuildLegendTree ( const QList< QgsLayerTreeModelLegendNode *> &  nodes)
protected
Note
not available in Python bindings

Definition at line 1277 of file qgslayertreemodel.cpp.

Member Data Documentation

◆ mAutoCollapseLegendNodesCount

int QgsLayerTreeModel::mAutoCollapseLegendNodesCount
protected

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

Definition at line 309 of file qgslayertreemodel.h.

◆ mCurrentIndex

QPersistentModelIndex QgsLayerTreeModel::mCurrentIndex
protected

Current index - will be underlined.

Definition at line 307 of file qgslayertreemodel.h.

◆ mDeferLegendInvalidationTimer

QTimer QgsLayerTreeModel::mDeferLegendInvalidationTimer
protected

Definition at line 378 of file qgslayertreemodel.h.

◆ mFlags

Flags QgsLayerTreeModel::mFlags
protected

Set of flags for the model.

Definition at line 305 of file qgslayertreemodel.h.

◆ mFontGroup

QFont QgsLayerTreeModel::mFontGroup
protected

Definition at line 364 of file qgslayertreemodel.h.

◆ mFontLayer

QFont QgsLayerTreeModel::mFontLayer
protected

Definition at line 363 of file qgslayertreemodel.h.

◆ mLayerStyleOverrides

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 358 of file qgslayertreemodel.h.

◆ mLegend

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

Per layer data about layer's legend nodes.

Definition at line 361 of file qgslayertreemodel.h.

◆ mLegendFilterByScale

double QgsLayerTreeModel::mLegendFilterByScale
protected

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

Definition at line 367 of file qgslayertreemodel.h.

◆ mLegendFilterHitTest

std::unique_ptr<QgsMapHitTest> QgsLayerTreeModel::mLegendFilterHitTest
protected

Definition at line 370 of file qgslayertreemodel.h.

◆ mLegendFilterMapSettings

std::unique_ptr<QgsMapSettings> QgsLayerTreeModel::mLegendFilterMapSettings
protected

Definition at line 369 of file qgslayertreemodel.h.

◆ mLegendFilterUsesExtent

bool QgsLayerTreeModel::mLegendFilterUsesExtent
protected

whether to use map filtering

Definition at line 373 of file qgslayertreemodel.h.

◆ mLegendMapViewDpi

int QgsLayerTreeModel::mLegendMapViewDpi
protected

Definition at line 376 of file qgslayertreemodel.h.

◆ mLegendMapViewMupp

double QgsLayerTreeModel::mLegendMapViewMupp
protected

Definition at line 375 of file qgslayertreemodel.h.

◆ mLegendMapViewScale

double QgsLayerTreeModel::mLegendMapViewScale
protected

Definition at line 377 of file qgslayertreemodel.h.

◆ mRootNode

QgsLayerTree* QgsLayerTreeModel::mRootNode = nullptr
protected

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

Definition at line 303 of file qgslayertreemodel.h.


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