QGIS API Documentation
2.12.0-Lyon
|
The QgsLayerTreeModel class is model implementation for Qt item views framework. More...
#include <qgslayertreemodel.h>
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=0) | |
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 |
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 |
QgsLayerTreeNode * | index2node (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 list of legend nodes attached to a particular layer node. More... | |
Q_DECL_DEPRECATED QgsLayerTreeLayer * | layerNodeForSymbologyNode (const QModelIndex &index) const |
Return layer node to which a legend node belongs to. 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... | |
const QgsMapSettings * | legendFilterByMap () const |
double | legendFilterByScale () const |
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... | |
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... | |
Q_DECL_DEPRECATED void | refreshLayerSymbology (QgsLayerTreeLayer *nodeLayer) |
bool | removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override |
QgsLayerTreeGroup * | rootGroup () 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 ¤tIndex) |
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 | 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... | |
![]() | |
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, QVariant > | itemData (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 |
![]() | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
virtual | ~QObject () |
bool | blockSignals (bool block) |
QObject * | child (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< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) 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 QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () 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) |
QThread * | thread () const |
Static Public Member Functions | |
static QgsLayerTreeModelLegendNode * | index2legendNode (const QModelIndex &index) |
Return legend node for given index. More... | |
![]() | |
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) |
Static Protected Member Functions | |
static const QIcon & | iconGroup () |
![]() | |
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, QString > | mLayerStyleOverrides |
Overrides of map layers' styles: key = layer ID, value = style XML. More... | |
QMap< QgsLayerTreeLayer *, LayerLegendData > | mLegend |
Per layer data about layer's legend nodes. More... | |
QScopedPointer< QgsMapHitTest > | mLegendFilterByMapHitTest |
QScopedPointer< QgsMapSettings > | mLegendFilterByMapSettings |
double | mLegendFilterByScale |
scale denominator for filtering of legend nodes (<= 0 means no filtering) More... | |
int | mLegendMapViewDpi |
double | mLegendMapViewMupp |
double | mLegendMapViewScale |
QgsLayerTreeGroup * | mRootNode |
Pointer to the root node of the layer tree. Not owned by the model. More... | |
Additional Inherited Members | |
![]() | |
objectName | |
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.
Definition at line 46 of file qgslayertreemodel.h.
Definition at line 72 of file qgslayertreemodel.h.
|
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 35 of file qgslayertreemodel.cpp.
QgsLayerTreeModel::~QgsLayerTreeModel | ( | ) |
Definition at line 53 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1077 of file qgslayertreemodel.cpp.
|
inline |
Return at what number of legend nodes the layer node should be collapsed. -1 means no auto-collapse (default).
Definition at line 144 of file qgslayertreemodel.h.
|
inline |
Definition at line 186 of file qgslayertreemodel.h.
|
override |
Definition at line 88 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 751 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 829 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 851 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 495 of file qgslayertreemodel.cpp.
|
override |
Definition at line 153 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 810 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 840 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 866 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 921 of file qgslayertreemodel.cpp.
|
protected |
Filter nodes from QgsMapLayerLegend according to the current filtering rules.
Definition at line 1013 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 286 of file qgslayertreemodel.cpp.
QgsLayerTreeModel::Flags QgsLayerTreeModel::flags | ( | ) | const |
Return OR-ed combination of model flags.
Definition at line 993 of file qgslayertreemodel.cpp.
|
staticprotected |
Definition at line 1003 of file qgslayertreemodel.cpp.
|
override |
Definition at line 94 of file qgslayertreemodel.cpp.
|
static |
Return legend node for given index.
Returns null for invalid index
Definition at line 1172 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 58 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.
Definition at line 418 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 138 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 1316 of file qgslayertreemodel.cpp.
bool QgsLayerTreeModel::isIndexSymbologyNode | ( | const QModelIndex & | index | ) | const |
Return true if index represents a legend node (instead of layer node)
Definition at line 444 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 705 of file qgslayertreemodel.cpp.
QList< QgsLayerTreeModelLegendNode * > QgsLayerTreeModel::layerLegendNodes | ( | QgsLayerTreeLayer * | nodeLayer | ) |
Return list of legend nodes attached to a particular layer node.
Definition at line 1303 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 721 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.
Definition at line 449 of file qgslayertreemodel.cpp.
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.
Definition at line 610 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 537 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1055 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1290 of file qgslayertreemodel.cpp.
|
inline |
Definition at line 157 of file qgslayertreemodel.h.
|
inline |
Definition at line 150 of file qgslayertreemodel.h.
|
protected |
Definition at line 1297 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1308 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.
Definition at line 603 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.
Definition at line 1178 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1273 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 739 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1281 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1243 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1206 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1253 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1232 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1216 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 901 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 893 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 382 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 641 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 676 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 683 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 693 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 662 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 667 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 620 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 651 of file qgslayertreemodel.cpp.
|
override |
Definition at line 116 of file qgslayertreemodel.cpp.
|
protected |
emit dataChanged() for layer tree node items
Definition at line 873 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 475 of file qgslayertreemodel.cpp.
|
inline |
Definition at line 182 of file qgslayertreemodel.h.
|
protected |
Definition at line 1066 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 969 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 455 of file qgslayertreemodel.cpp.
|
override |
Definition at line 68 of file qgslayertreemodel.cpp.
|
inline |
Set at what number of legend nodes the layer node should be collapsed. Setting -1 disables the auto-collapse (default).
Definition at line 142 of file qgslayertreemodel.h.
|
inline |
Definition at line 184 of file qgslayertreemodel.h.
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 500 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 323 of file qgslayertreemodel.cpp.
void QgsLayerTreeModel::setFlag | ( | QgsLayerTreeModel::Flag | f, |
bool | on = true |
||
) |
Enable or disable a model flag.
Definition at line 985 of file qgslayertreemodel.cpp.
void QgsLayerTreeModel::setFlags | ( | const QgsLayerTreeModel::Flags & | f | ) |
Set OR-ed combination of model flags.
Definition at line 980 of file qgslayertreemodel.cpp.
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.
Definition at line 615 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 512 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.
Definition at line 560 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
Definition at line 550 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.
Definition at line 590 of file qgslayertreemodel.cpp.
void QgsLayerTreeModel::setRootGroup | ( | QgsLayerTreeGroup * | newRootGroup | ) |
Reset the model and use a new root group node.
Definition at line 460 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 888 of file qgslayertreemodel.cpp.
bool QgsLayerTreeModel::testFlag | ( | QgsLayerTreeModel::Flag | f | ) | const |
Check whether a flag is enabled.
Definition at line 998 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1132 of file qgslayertreemodel.cpp.
|
protected |
Minimal number of nodes when legend should be automatically collapsed. -1 = disabled.
Definition at line 252 of file qgslayertreemodel.h.
|
protected |
Current index - will be underlined.
Definition at line 250 of file qgslayertreemodel.h.
|
protected |
Definition at line 301 of file qgslayertreemodel.h.
|
protected |
Set of flags for the model.
Definition at line 248 of file qgslayertreemodel.h.
|
protected |
Definition at line 290 of file qgslayertreemodel.h.
|
protected |
Definition at line 289 of file qgslayertreemodel.h.
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 284 of file qgslayertreemodel.h.
|
protected |
Per layer data about layer's legend nodes.
Definition at line 287 of file qgslayertreemodel.h.
|
protected |
Definition at line 296 of file qgslayertreemodel.h.
|
protected |
Definition at line 295 of file qgslayertreemodel.h.
|
protected |
scale denominator for filtering of legend nodes (<= 0 means no filtering)
Definition at line 293 of file qgslayertreemodel.h.
|
protected |
Definition at line 299 of file qgslayertreemodel.h.
|
protected |
Definition at line 298 of file qgslayertreemodel.h.
|
protected |
Definition at line 300 of file qgslayertreemodel.h.
|
protected |
Pointer to the root node of the layer tree. Not owned by the model.
Definition at line 246 of file qgslayertreemodel.h.