QGIS API Documentation
2.14.0-Essen
|
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=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 |
QgsLayerTreeModelLegendNode * | 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. 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 |
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 filtered list of active 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... | |
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... | |
Q_DECL_DEPRECATED const QgsMapSettings * | legendFilterByMap () const |
Returns the current map settings used for legend filtering. More... | |
double | legendFilterByScale () const |
const QgsMapSettings * | legendFilterMapSettings () 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... | |
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 | 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, 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 |
Public Member Functions inherited from QObject | |
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... | |
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) |
Static Protected Member Functions | |
static const QIcon & | iconGroup () |
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, 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... | |
double | mLegendFilterByScale |
scale denominator for filtering of legend nodes (<= 0 means no filtering) More... | |
QScopedPointer< QgsMapHitTest > | mLegendFilterHitTest |
QScopedPointer< QgsMapSettings > | mLegendFilterMapSettings |
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 | |
Properties inherited from QObject | |
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 49 of file qgslayertreemodel.h.
Definition at line 75 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 36 of file qgslayertreemodel.cpp.
QgsLayerTreeModel::~QgsLayerTreeModel | ( | ) |
Definition at line 54 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1110 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 162 of file qgslayertreemodel.h.
|
inline |
Definition at line 219 of file qgslayertreemodel.h.
|
override |
Definition at line 89 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 779 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 857 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 879 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 496 of file qgslayertreemodel.cpp.
|
override |
Definition at line 154 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 838 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 868 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 894 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 953 of file qgslayertreemodel.cpp.
|
protected |
Filter nodes from QgsMapLayerLegend according to the current filtering rules.
Definition at line 1045 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.
layerId | map layer ID |
ruleKey | legend node rule key |
Definition at line 1346 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 287 of file qgslayertreemodel.cpp.
QgsLayerTreeModel::Flags QgsLayerTreeModel::flags | ( | ) | const |
Return OR-ed combination of model flags.
Definition at line 1025 of file qgslayertreemodel.cpp.
|
staticprotected |
Definition at line 1035 of file qgslayertreemodel.cpp.
|
override |
Definition at line 95 of file qgslayertreemodel.cpp.
|
static |
Return legend node for given index.
Returns null for invalid index
Definition at line 1205 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 59 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 419 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 139 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 1376 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 445 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 733 of file qgslayertreemodel.cpp.
QList< QgsLayerTreeModelLegendNode * > QgsLayerTreeModel::layerLegendNodes | ( | QgsLayerTreeLayer * | nodeLayer | ) |
Return filtered list of active legend nodes attached to a particular layer node.
Definition at line 1336 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 749 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 450 of file qgslayertreemodel.cpp.
QList< QgsLayerTreeModelLegendNode * > QgsLayerTreeModel::layerOriginalLegendNodes | ( | QgsLayerTreeLayer * | nodeLayer | ) |
Return original (unfiltered) list of legend nodes attached to a particular layer node.
Definition at line 1341 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 638 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 538 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1088 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1323 of file qgslayertreemodel.cpp.
|
inline |
Returns the current map settings used for legend filtering.
Definition at line 186 of file qgslayertreemodel.h.
|
inline |
Definition at line 168 of file qgslayertreemodel.h.
|
inline |
Returns the current map settings used for the current legend filter (or null if none is enabled)
Definition at line 190 of file qgslayertreemodel.h.
|
protected |
Definition at line 1330 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1368 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 631 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 1211 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1306 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 767 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1314 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1276 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1239 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1286 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1265 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1249 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 929 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 921 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 383 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 669 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 704 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 711 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 721 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 690 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 695 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 648 of file qgslayertreemodel.cpp.
|
protectedslot |
Definition at line 679 of file qgslayertreemodel.cpp.
|
override |
Definition at line 117 of file qgslayertreemodel.cpp.
|
protected |
emit dataChanged() for layer tree node items
Definition at line 901 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 476 of file qgslayertreemodel.cpp.
|
inline |
Definition at line 215 of file qgslayertreemodel.h.
|
protected |
Definition at line 1099 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 1001 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 456 of file qgslayertreemodel.cpp.
|
override |
Definition at line 69 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 160 of file qgslayertreemodel.h.
|
inline |
Definition at line 217 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 501 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 324 of file qgslayertreemodel.cpp.
void QgsLayerTreeModel::setFlag | ( | QgsLayerTreeModel::Flag | f, |
bool | on = true |
||
) |
Enable or disable a model flag.
Definition at line 1017 of file qgslayertreemodel.cpp.
void QgsLayerTreeModel::setFlags | ( | const QgsLayerTreeModel::Flags & | f | ) |
Set OR-ed combination of model flags.
Definition at line 1012 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 643 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 513 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.
settings | Map settings. Setting a null pointer or invalid settings will disable any filter. Ownership is not changed, a copy is made |
useExtent | Whether to use the extent of the map settings as a first spatial filter on legend nodes |
polygon | If not empty, this polygon will be used instead of the map extent to filter legend nodes |
useExpressions | Whether to use legend node filter expressions |
Definition at line 566 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 561 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 551 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 618 of file qgslayertreemodel.cpp.
void QgsLayerTreeModel::setRootGroup | ( | QgsLayerTreeGroup * | newRootGroup | ) |
Reset the model and use a new root group node.
Definition at line 461 of file qgslayertreemodel.cpp.
|
overridevirtual |
Reimplemented from QAbstractItemModel.
Definition at line 916 of file qgslayertreemodel.cpp.
bool QgsLayerTreeModel::testFlag | ( | QgsLayerTreeModel::Flag | f | ) | const |
Check whether a flag is enabled.
Definition at line 1030 of file qgslayertreemodel.cpp.
|
protected |
Definition at line 1165 of file qgslayertreemodel.cpp.
|
protected |
Minimal number of nodes when legend should be automatically collapsed. -1 = disabled.
Definition at line 285 of file qgslayertreemodel.h.
|
protected |
Current index - will be underlined.
Definition at line 283 of file qgslayertreemodel.h.
|
protected |
Definition at line 337 of file qgslayertreemodel.h.
|
protected |
Set of flags for the model.
Definition at line 281 of file qgslayertreemodel.h.
|
protected |
Definition at line 326 of file qgslayertreemodel.h.
|
protected |
Definition at line 325 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 320 of file qgslayertreemodel.h.
|
protected |
Per layer data about layer's legend nodes.
Definition at line 323 of file qgslayertreemodel.h.
|
protected |
scale denominator for filtering of legend nodes (<= 0 means no filtering)
Definition at line 329 of file qgslayertreemodel.h.
|
protected |
Definition at line 332 of file qgslayertreemodel.h.
|
protected |
Definition at line 331 of file qgslayertreemodel.h.
|
protected |
Definition at line 335 of file qgslayertreemodel.h.
|
protected |
Definition at line 334 of file qgslayertreemodel.h.
|
protected |
Definition at line 336 of file qgslayertreemodel.h.
|
protected |
Pointer to the root node of the layer tree. Not owned by the model.
Definition at line 279 of file qgslayertreemodel.h.