17 #include <QTextStream>
44 : QAbstractItemModel( parent )
45 , mRootNode( rootNode )
46 , mFlags( ShowLegend | AllowLegendChangeState | DeferredLegendInvalidation )
47 , mAutoCollapseLegendNodesCount( -1 )
48 , mLegendFilterByScale( 0 )
49 , mLegendFilterUsesExtent( false )
50 , mLegendMapViewMupp( 0 )
51 , mLegendMapViewDpi( 0 )
52 , mLegendMapViewScale( 0 )
69 if ( !
index.isValid() )
72 QObject *obj =
reinterpret_cast<QObject *
>(
index.internalPointer() );
73 return qobject_cast<QgsLayerTreeNode *>( obj );
107 return QModelIndex();
114 return QModelIndex();
121 return createIndex( row, column,
static_cast<QObject *
>( n->
children().at( row ) ) );
127 if ( !child.isValid() )
128 return QModelIndex();
141 return QModelIndex();
149 Q_ASSERT( parentNode );
152 if ( !grandParentNode )
153 return QModelIndex();
155 int row = grandParentNode->
children().indexOf( parentNode );
156 Q_ASSERT( row >= 0 );
158 return createIndex( row, 0,
static_cast<QObject *
>( parentNode ) );
171 if ( role == Qt::DisplayRole || role == Qt::EditRole )
179 QString name = nodeLayer->
name();
180 if ( nodeLayer->
customProperty( QStringLiteral(
"showFeatureCount" ), 0 ).toInt() && role == Qt::DisplayRole )
184 name += QStringLiteral(
" [%1]" ).arg( vlayer->
featureCount() );
189 else if ( role == Qt::DecorationRole &&
index.column() == 0 )
216 QPainter painter( &pixmap );
220 icon = QIcon( pixmap );
226 else if ( role == Qt::CheckStateRole )
250 f.setUnderline(
true );
256 f.setItalic( !f.italic() );
263 QBrush brush( qApp->palette().color( QPalette::Text ), Qt::SolidPattern );
269 QColor fadedTextColor = brush.color();
270 fadedTextColor.setAlpha( 128 );
271 brush.setColor( fadedTextColor );
276 else if ( role == Qt::ToolTipRole )
283 !layer->
title().isEmpty() ? layer->title() :
284 !layer->shortName().isEmpty() ? layer->shortName() :
287 title =
"<b>" + title.toHtmlEscaped() +
"</b>";
289 if ( layer->isSpatial() && layer->crs().isValid() )
291 if (
QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer ) )
294 title += tr(
" (%1)" ).arg( layer->crs().authid() ).toHtmlEscaped();
300 if ( !layer->abstract().isEmpty() )
303 const QStringList abstractLines = layer->abstract().split(
'\n' );
304 for (
const auto &l : abstractLines )
306 parts << l.toHtmlEscaped();
311 QString source( layer->publicSource() );
312 if ( source.size() > 1024 )
314 source = source.left( 1023 ) + QString( QChar( 0x2026 ) );
317 parts <<
"<i>" + source.toHtmlEscaped() +
"</i>";
319 return parts.join( QLatin1String(
"<br/>" ) );
330 if ( !
index.isValid() )
332 Qt::ItemFlags rootFlags = Qt::ItemFlags();
334 rootFlags |= Qt::ItemIsDropEnabled;
341 Qt::ItemFlags f = Qt::ItemIsEnabled | Qt::ItemIsSelectable;
344 f |= Qt::ItemIsEditable;
347 bool isEmbedded = node->
customProperty( QStringLiteral(
"embedded" ) ).toInt();
352 if ( !isEmbedded || ( isEmbedded && node->
parent() && !node->
parent()->
customProperty( QStringLiteral(
"embedded" ) ).toInt() ) )
353 f |= Qt::ItemIsDragEnabled;
357 f |= Qt::ItemIsUserCheckable;
360 f |= Qt::ItemIsDropEnabled;
372 bool res = sym->
setData( value, role );
380 return QAbstractItemModel::setData(
index, value, role );
382 if ( role == Qt::CheckStateRole )
387 bool checked =
static_cast< Qt::CheckState
>( value.toInt() ) == Qt::Checked;
388 if ( checked && node->
children().isEmpty() )
408 else if ( role == Qt::EditRole )
416 layer->
setName( value.toString() );
426 return QAbstractItemModel::setData(
index, value, role );
431 if ( !node || !node->
parent() )
432 return QModelIndex();
437 Q_ASSERT( row >= 0 );
438 return index( row, 0, parentIndex );
447 if ( child->
parent() == node )
450 return _isChildOfNode( child->
parent(), node );
453 static bool _isChildOfNodes(
QgsLayerTreeNode *child,
const QList<QgsLayerTreeNode *> &nodes )
457 if ( _isChildOfNode( child, n ) )
467 QList<QgsLayerTreeNode *> nodes;
468 const auto constList = list;
469 for (
const QModelIndex &
index : constList )
482 QList<QgsLayerTreeNode *> nodesFinal;
485 if ( !_isChildOfNodes( node, nodes ) )
516 emit dataChanged( idx, idx );
520 if ( oldNodeCount > 0 )
522 beginRemoveRows( idx, 0, oldNodeCount - 1 );
609 if ( useExpressions )
616 if ( enabled && !expr.isEmpty() )
618 exprs[ nodeLayer->layerId()] = expr;
623 if ( useExpressions && !useExtent && !polygonValid )
668 if ( scale != previousScale )
696 beginInsertRows(
node2index( node ), indexFrom, indexTo );
699 static QList<QgsLayerTreeLayer *> _layerNodesInSubtree(
QgsLayerTreeNode *node,
int indexFrom,
int indexTo )
701 QList<QgsLayerTreeNode *> children = node->
children();
702 QList<QgsLayerTreeLayer *> newLayerNodes;
703 for (
int i = indexFrom; i <= indexTo; ++i )
711 return newLayerNodes;
720 const auto subNodes = _layerNodesInSubtree( node, indexFrom, indexTo );
729 beginRemoveRows(
node2index( node ), indexFrom, indexTo );
732 const auto subNodes = _layerNodesInSubtree( node, indexFrom, indexTo );
797 QgsMapLayer *layer = qobject_cast<QgsMapLayer *>( sender() );
813 QgsMapLayer *layer = qobject_cast<QgsMapLayer *>( sender() );
827 QgsMapLayer *layer = qobject_cast<QgsMapLayer *>( sender() );
838 if ( nodeLayer->
customProperty( QStringLiteral(
"showFeatureCount" ) ).toInt() )
850 if (
index.isValid() )
854 void QgsLayerTreeModel::legendNodeSizeChanged()
861 if (
index.isValid() )
862 emit dataChanged(
index,
index, QVector<int> { Qt::SizeHintRole } );
868 if ( !nodeLayer->
layer() )
915 const auto constChildren = group->
children();
933 disconnect( nodeLayer,
nullptr,
this,
nullptr );
935 if ( !nodeLayer->
layer() )
946 disconnect( nodeLayer->
layer(),
nullptr,
this,
nullptr );
952 const auto constChildren = parentGroup->
children();
964 const auto constChildren = parentGroup->
children();
991 disconnect(
mRootNode,
nullptr,
this,
nullptr );
1002 int count = node->
children().count();
1005 emit dataChanged(
index( 0, 0, idx ),
index( count - 1, 0, idx ) );
1006 for (
int i = 0; i < count; ++i )
1022 emit dataChanged( idx, idx, QVector<int>() << Qt::FontRole << Qt::ForegroundRole );
1025 int count = node->
children().count();
1026 for (
int i = 0; i < count; ++i )
1032 return Qt::CopyAction | Qt::MoveAction;
1038 types << QStringLiteral(
"application/qgis.layertreemodeldata" );
1046 QModelIndexList sortedIndexes = indexes;
1047 std::sort( sortedIndexes.begin(), sortedIndexes.end(), std::less<QModelIndex>() );
1049 QList<QgsLayerTreeNode *> nodesFinal =
indexes2nodes( sortedIndexes,
true );
1051 if ( nodesFinal.isEmpty() )
1054 QMimeData *
mimeData =
new QMimeData();
1056 QDomDocument layerTreeDoc;
1057 QDomElement rootLayerTreeElem = layerTreeDoc.createElement( QStringLiteral(
"layer_tree_model_data" ) );
1063 layerTreeDoc.appendChild( rootLayerTreeElem );
1065 QString errorMessage;
1067 QDomDocument layerDefinitionsDoc( QStringLiteral(
"qgis-layer-definition" ) );
1070 QString txt = layerDefinitionsDoc.toString();
1072 mimeData->setData( QStringLiteral(
"application/qgis.layertreemodeldata" ), layerTreeDoc.toString().toUtf8() );
1073 mimeData->setData( QStringLiteral(
"application/qgis.application.pid" ), QString::number( QCoreApplication::applicationPid() ).toUtf8() );
1074 mimeData->setData( QStringLiteral(
"application/qgis.layertree.layerdefinitions" ), txt.toUtf8() );
1082 if ( action == Qt::IgnoreAction )
1085 if ( !
data->hasFormat( QStringLiteral(
"application/qgis.layertreemodeldata" ) ) )
1095 if (
parent.isValid() && row == -1 )
1101 qint64 qgisPid =
data->data( QStringLiteral(
"application/qgis.application.pid" ) ).toInt( &ok );
1103 if ( ok && qgisPid != QCoreApplication::applicationPid() )
1105 QByteArray encodedLayerDefinitionData =
data->data( QStringLiteral(
"application/qgis.layertree.layerdefinitions" ) );
1106 QDomDocument layerDefinitionDoc;
1107 if ( !layerDefinitionDoc.setContent( QString::fromUtf8( encodedLayerDefinitionData ) ) )
1110 QString errorMessage;
1112 emit
messageEmitted( tr(
"New layers added from another QGIS instance" ) );
1116 QByteArray encodedLayerTreeData =
data->data( QStringLiteral(
"application/qgis.layertreemodeldata" ) );
1118 QDomDocument layerTreeDoc;
1119 if ( !layerTreeDoc.setContent( QString::fromUtf8( encodedLayerTreeData ) ) )
1122 QDomElement rootLayerTreeElem = layerTreeDoc.documentElement();
1123 if ( rootLayerTreeElem.tagName() != QLatin1String(
"layer_tree_model_data" ) )
1126 QList<QgsLayerTreeNode *> nodes;
1128 QDomElement elem = rootLayerTreeElem.firstChildElement();
1129 while ( !elem.isNull() )
1135 elem = elem.nextSiblingElement();
1138 if ( nodes.isEmpty() )
1177 return mFlags.testFlag( f );
1187 QList<QgsLayerTreeModelLegendNode *> filtered;
1221 if (
QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( node->layerNode()->layer() ) )
1254 const auto constMLegend =
mLegend;
1257 qDeleteAll(
data.originalNodes );
1266 if (
mLegend.contains( nodeLayer ) )
1268 qDeleteAll(
mLegend[nodeLayer].originalNodes );
1269 delete mLegend[nodeLayer].tree;
1277 if ( !nodeL || !nodeL->
layer() )
1297 int widgetsCount = ml->
customProperty( QStringLiteral(
"embeddedWidgets/count" ), 0 ).toInt();
1298 while ( widgetsCount > 0 )
1300 lstNew.insert( 0,
new EmbeddedWidgetLegendNode( nodeL ) );
1305 QList<QgsLayerTreeModelLegendNode *> filteredLstNew =
filterLegendNodes( lstNew );
1307 const auto constLstNew = lstNew;
1310 n->setParent(
this );
1319 const auto constFilteredLstNew = filteredLstNew;
1336 int count = legendTree ? legendTree->
children[
nullptr].count() : filteredLstNew.count();
1338 if ( !filteredLstNew.isEmpty() )
1341 const QModelIndex nodeIndex {
node2index( nodeL ) };
1348 beginInsertRows(
node2index( nodeL ), 0, count - 1 );
1352 data.originalNodes = lstNew;
1353 data.activeNodes = filteredLstNew;
1354 data.embeddedNodeInParent = embeddedNode;
1355 data.tree = legendTree;
1359 if ( !filteredLstNew.isEmpty() )
1374 bool hasParentKeys =
false;
1379 hasParentKeys =
true;
1383 if ( !hasParentKeys )
1387 QHash<QString, QgsLayerTreeModelLegendNode *> rule2node;
1388 rule2node[QString()] =
nullptr;
1392 if ( ruleKey.isEmpty() )
1394 if ( rule2node.contains( ruleKey ) )
1396 rule2node[ruleKey] = n;
1421 context->setScaleFactor( dpi / 25.4 );
1422 context->setRendererScale( scale );
1425 return validData ? context.release() :
nullptr;
1431 return qobject_cast<QgsLayerTreeModelLegendNode *>(
reinterpret_cast<QObject *
>(
index.internalPointer() ) );
1443 int row =
data.tree->children[parentLegendNode].indexOf(
legendNode );
1444 return index( row, 0, parentIndex );
1450 return index( row, 0, parentIndex );
1455 Q_ASSERT( parentIndex.isValid() );
1458 return QModelIndex();
1460 return index( row, 0, parentIndex );
1468 return data.tree->children[node].count();
1476 if ( !
mLegend.contains( nL ) )
1481 return data.tree->children[
nullptr].count();
1483 int count =
data.activeNodes.count();
1490 Q_ASSERT(
mLegend.contains( nL ) );
1493 return createIndex( row, column,
static_cast<QObject *
>(
data.tree->children[
nullptr].at( row ) ) );
1495 return createIndex( row, column,
static_cast<QObject *
>(
data.activeNodes.at( row ) ) );
1503 return createIndex( row, column,
static_cast<QObject *
>(
data.tree->children[node].at( row ) ) );
1505 return QModelIndex();
1518 int row =
data.tree->children[grandParentNode].indexOf( parentNode );
1519 return createIndex( row, 0,
static_cast<QObject *
>( parentNode ) );
1533 return node->
data( role );
1539 Qt::ItemFlags f = node->
flags();
1541 f &= ~Qt::ItemIsUserCheckable;
1548 return static_cast< bool >(
mLegend[nodeLayer].embeddedNodeInParent );
1553 return mLegend[nodeLayer].embeddedNodeInParent;
1562 return QIcon( qvariant_cast<QPixmap>(
legendNode->
data( Qt::DecorationRole ) ) );
1568 if ( !
mLegend.contains( nodeLayer ) )
1569 return QList<QgsLayerTreeModelLegendNode *>();
1572 QList<QgsLayerTreeModelLegendNode *> lst(
data.activeNodes );
1573 if ( !skipNodeEmbeddedInParent &&
data.embeddedNodeInParent )
1574 lst.prepend(
data.embeddedNodeInParent );
1580 return mLegend.value( nodeLayer ).originalNodes;
1585 for (
auto it =
mLegend.constBegin(); it !=
mLegend.constEnd(); ++it )
1588 if ( layer->
layerId() == layerId )
1590 const auto activeNodes =
mLegend.value( layer ).activeNodes;
1629 QList<QgsSymbolLegendNode *> symbolNodes;
1630 QMap<QString, int> widthMax;
1638 widthMax[parentKey] = std::max( sz.width(), widthMax.contains( parentKey ) ? widthMax[parentKey] : 0 );
1640 symbolNodes.append( n );
1646 Q_ASSERT( widthMax[parentKey] > 0 );
1647 const int twiceMarginWidth = 2;
1648 n->setIconSize( QSize( widthMax[parentKey] + twiceMarginWidth, n->iconSize().rheight() + twiceMarginWidth ) );
@ UsersCannotToggleEditing
Indicates that users are not allowed to toggle editing for this layer. Note that this does not imply ...
@ RenderSymbolPreview
The render is for a symbol preview only and map based properties may not be available,...
static int scaleIconSize(int standardSize, bool applyDevicePixelRatio=false)
Scales an icon size to compensate for display pixel density, making the icon size hi-dpi friendly,...
static QPixmap getThemePixmap(const QString &name, const QColor &foreColor=QColor(), const QColor &backColor=QColor(), int size=16)
Helper to get a theme icon as a pixmap.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
A geometry is the spatial representation of a feature.
QgsWkbTypes::GeometryType type
static QIcon iconForLayer(const QgsMapLayer *layer)
Returns the icon corresponding to a specified map layer.
static bool loadLayerDefinition(const QString &path, QgsProject *project, QgsLayerTreeGroup *rootGroup, QString &errorMessage)
Loads the QLR at path into QGIS. New layers are added to given project into layer tree specified by r...
static bool exportLayerDefinition(const QString &path, const QList< QgsLayerTreeNode * > &selectedTreeNodes, QString &errorMessage)
Exports the selected layer tree nodes to a QLR file.
Layer tree group node serves as a container for layers and further groups.
void setName(const QString &n) override
Sets the group's name.
QString name() const override
Returns the group's name.
void insertChildNodes(int index, const QList< QgsLayerTreeNode * > &nodes)
Insert existing nodes at specified position.
QList< QgsLayerTreeLayer * > findLayers() const
Find all layer nodes.
QgsLayerTreeLayer * findLayer(QgsMapLayer *layer) const
Find layer node representing the map layer.
void removeChildren(int from, int count)
Remove child nodes from index "from".
Layer tree node points to a map layer.
QString layerId() const
Returns the ID for the map layer associated with this node.
void layerWillBeUnloaded()
Emitted when a previously available layer got unloaded (from layer registry).
void setName(const QString &n) override
Sets the layer's name.
QString name() const override
Returns the layer's name.
void layerLoaded()
Emitted when a previously unavailable layer got loaded.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
The QgsLegendRendererItem class is abstract interface for legend items returned from QgsMapLayerLegen...
virtual QVariant data(int role) const =0
Returns data associated with the item. Must be implemented in derived class.
NodeTypes
Types of legend nodes.
@ SimpleLegend
Simple label with icon legend node type.
@ RasterSymbolLegend
Raster symbol legend node type.
@ ImageLegend
Raster image legend node type.
@ DataDefinedSizeLegend
Marker symbol legend node type.
@ WmsLegend
WMS legend node type.
@ EmbeddedWidget
Embedded widget placeholder node type.
@ ColorRampLegend
Color ramp legend (since QGIS 3.18)
@ SymbolLegend
Vector symbol legend node type.
QgsLayerTreeLayer * layerNode() const
Returns pointer to the parent layer node.
virtual void invalidateMapBasedData()
Notification from model that information from associated map view has changed.
@ ParentRuleKeyRole
Rule key of the parent legend node - for legends with tree hierarchy (QString). Added in 2....
@ RuleKeyRole
Rule key of the node (QString)
@ NodeTypeRole
Type of node. Added in 3.16.
void sizeChanged()
Emitted when the size of this node changes.
void dataChanged()
Emitted on internal data change so the layer tree model can forward the signal to views.
virtual bool isEmbeddedInParent() const
virtual Qt::ItemFlags flags() const
Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled.
virtual bool setData(const QVariant &value, int role)
Sets some data associated with the item. Default implementation does nothing and returns false.
QTimer mDeferLegendInvalidationTimer
void legendInvalidateMapBasedData()
void connectToLayer(QgsLayerTreeLayer *nodeLayer)
int columnCount(const QModelIndex &parent=QModelIndex()) const override
QModelIndex node2index(QgsLayerTreeNode *node) const
Returns index for a given node. If the node does not belong to the layer tree, the result is undefine...
Flags flags() const
Returns OR-ed combination of model flags.
double mLegendFilterByScale
scale denominator for filtering of legend nodes (<= 0 means no filtering)
QList< QgsLayerTreeModelLegendNode * > layerLegendNodes(QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent=false)
Returns filtered list of active legend nodes attached to a particular layer node (by default it retur...
bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
bool setData(const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
int autoCollapseLegendNodes() const
Returns at what number of legend nodes the layer node should be collapsed. -1 means no auto-collapse ...
void nodeLayerWillBeUnloaded()
QVariant legendNodeData(QgsLayerTreeModelLegendNode *node, int role) const
double mLegendMapViewScale
void setRootGroup(QgsLayerTree *newRootGroup)
Reset the model and use a new root group node.
void setLegendFilterByMap(const QgsMapSettings *settings)
Force only display of legend nodes which are valid for given map settings.
QModelIndex legendNode2index(QgsLayerTreeModelLegendNode *legendNode)
Returns index for a given legend node.
void setLegendFilterByScale(double scale)
Force only display of legend nodes which are valid for a given scale.
~QgsLayerTreeModel() override
QVariant data(const QModelIndex &index, int role=Qt::DisplayRole) const override
std::unique_ptr< QgsMapSettings > mLegendFilterMapSettings
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...
void nodeCustomPropertyChanged(QgsLayerTreeNode *node, const QString &key)
QgsLayerTreeModel(QgsLayerTree *rootNode, QObject *parent=nullptr)
Construct a new tree model with given layer tree (root node must not be nullptr).
void connectToLayers(QgsLayerTreeGroup *parentGroup)
std::unique_ptr< QgsMapHitTest > mLegendFilterHitTest
QModelIndex parent(const QModelIndex &child) const override
bool mLegendFilterUsesExtent
whether to use map filtering
void setFlag(Flag f, bool on=true)
Enable or disable a model flag.
QModelIndex legendParent(QgsLayerTreeModelLegendNode *legendNode) const
void setLayerTreeNodeFont(int nodeType, const QFont &font)
Sets font for a particular type of layer tree node. nodeType should come from QgsLayerTreeNode::NodeT...
int legendNodeRowCount(QgsLayerTreeModelLegendNode *node) const
void nodeAddedChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
void setAutoCollapseLegendNodes(int nodeCount)
Sets at what number of legend nodes the layer node should be collapsed. Setting -1 disables the auto-...
void legendMapViewData(double *mapUnitsPerPixel, int *dpi, double *scale) const
Gets hints about map view - to be used in legend nodes.
QModelIndex currentIndex() const
Gets index of the item marked as current. Item marked as current is underlined.
void recursivelyEmitDataChanged(const QModelIndex &index=QModelIndex())
emit dataChanged() for layer tree node items
bool legendEmbeddedInParent(QgsLayerTreeLayer *nodeLayer) const
QHash< QgsLayerTreeLayer *, LayerLegendData > mLegend
Per layer data about layer's legend nodes.
void disconnectFromLayer(QgsLayerTreeLayer *nodeLayer)
void setCurrentIndex(const QModelIndex ¤tIndex)
Sets index of the current item. May be used by view. Item marked as current is underlined.
QIcon legendIconEmbeddedInParent(QgsLayerTreeLayer *nodeLayer) const
void layerFlagsChanged()
Emitted when layer flags have changed.
void nodeNameChanged(QgsLayerTreeNode *node, const QString &name)
Updates model when node's name has changed.
QPersistentModelIndex mCurrentIndex
Current index - will be underlined.
LayerLegendTree * tryBuildLegendTree(const QList< QgsLayerTreeModelLegendNode * > &nodes)
Qt::DropActions supportedDropActions() const override
void disconnectFromRootNode()
QModelIndex legendNodeIndex(int row, int column, QgsLayerTreeModelLegendNode *node) const
QgsRenderContext * createTemporaryRenderContext() const
Returns a temporary render context.
void invalidateLegendMapBasedData()
void setFlags(QgsLayerTreeModel::Flags f)
Sets OR-ed combination of model flags.
QgsLayerTree * rootGroup() const
Returns pointer to the root node of the layer tree. Always a non nullptr value.
void nodeWillRemoveChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
QgsLayerTreeNode * index2node(const QModelIndex &index) const
Returns layer tree node for given index.
QgsLayerTree * mRootNode
Pointer to the root node of the layer tree. Not owned by the model.
QStringList mimeTypes() const override
QMimeData * mimeData(const QModelIndexList &indexes) const override
void nodeRemovedChildren()
int rowCount(const QModelIndex &parent=QModelIndex()) const override
bool removeRows(int row, int count, const QModelIndex &parent=QModelIndex()) override
static int scaleIconSize(int standardSize)
Scales an layer tree model icon size to compensate for display pixel density, making the icon size hi...
void messageEmitted(const QString &message, Qgis::MessageLevel level=Qgis::MessageLevel::Info, int duration=5)
Emits a message than can be displayed to the user in a GUI class.
QgsLayerTreeModelLegendNode * legendNodeEmbeddedInParent(QgsLayerTreeLayer *nodeLayer) const
Returns legend node that may be embedded in parent (i.e.
QList< QgsLayerTreeNode * > indexes2nodes(const QModelIndexList &list, bool skipInternal=false) const
Convert a list of indexes to a list of layer tree nodes.
QModelIndex index(int row, int column, const QModelIndex &parent=QModelIndex()) const override
QList< QgsLayerTreeModelLegendNode * > filterLegendNodes(const QList< QgsLayerTreeModelLegendNode * > &nodes)
Filter nodes from QgsMapLayerLegend according to the current filtering rules.
QList< QgsLayerTreeModelLegendNode * > layerOriginalLegendNodes(QgsLayerTreeLayer *nodeLayer)
Returns original (unfiltered) list of legend nodes attached to a particular layer node.
int mAutoCollapseLegendNodesCount
Minimal number of nodes when legend should be automatically collapsed. -1 = disabled.
QMap< QString, QString > layerStyleOverrides() const
Gets map of map layer style overrides (key: layer ID, value: style name) where a different style shou...
Qt::ItemFlags legendNodeFlags(QgsLayerTreeModelLegendNode *node) const
void setLayerStyleOverrides(const QMap< QString, QString > &overrides)
Sets map of map layer style overrides (key: layer ID, value: style name) where a different style shou...
void nodeVisibilityChanged(QgsLayerTreeNode *node)
void refreshScaleBasedLayers(const QModelIndex &index=QModelIndex(), double previousScale=0.0)
Updates layer data for scale dependent layers, should be called when map scale changes.
void removeLegendFromLayer(QgsLayerTreeLayer *nodeLayer)
QModelIndex legendRootIndex(int row, int column, QgsLayerTreeLayer *nL) const
static QgsLayerTreeModelLegendNode * index2legendNode(const QModelIndex &index)
Returns legend node for given index.
double mLegendMapViewMupp
void legendNodeDataChanged()
QMap< QString, QString > mLayerStyleOverrides
Overrides of map layers' styles: key = layer ID, value = style XML.
void nodeWillAddChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
QFont layerTreeNodeFont(int nodeType) const
Gets font for a particular type of layer tree node. nodeType should come from QgsLayerTreeNode::NodeT...
void refreshLayerLegend(QgsLayerTreeLayer *nodeLayer)
Force a refresh of legend nodes of a layer node.
void addLegendToLayer(QgsLayerTreeLayer *nodeL)
bool testFlag(Flag f) const
Check whether a flag is enabled.
void disconnectFromLayers(QgsLayerTreeGroup *parentGroup)
void layerLegendChanged()
QModelIndex indexOfParentLayerTreeNode(QgsLayerTreeNode *parentNode) const
QSet< QgsLayerTreeLayer * > mInvalidatedNodes
Keep track of layer nodes for which the legend size needs to be recalculated.
@ ActionHierarchical
Check/uncheck action has consequences on children (or parents for leaf node)
@ AllowNodeChangeVisibility
Allow user to set node visibility with a checkbox.
@ ShowLegendAsTree
For legends that support it, will show them in a tree instead of a list (needs also ShowLegend)....
@ UseTextFormatting
Layer nodes will alter text appearance based on layer properties, such as scale based visibility.
@ AllowNodeReorder
Allow reordering with drag'n'drop.
@ ShowLegend
Add legend nodes for layer nodes.
@ DeferredLegendInvalidation
Defer legend model invalidation.
@ AllowNodeRename
Allow renaming of groups and layers.
@ AllowLegendChangeState
Allow check boxes for legend nodes (if supported by layer's legend)
@ UseEmbeddedWidgets
Layer nodes may optionally include extra embedded widgets (if used in QgsLayerTreeView)....
Flags mFlags
Sets of flags for the model.
void setLegendFilter(const QgsMapSettings *settings, bool useExtent=true, const QgsGeometry &polygon=QgsGeometry(), bool useExpressions=true)
Filter display of legend nodes for given map settings.
int legendRootRowCount(QgsLayerTreeLayer *nL) const
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.
This class is a base class for nodes in a layer tree.
@ NodeGroup
Container of other groups and layers.
@ NodeLayer
Leaf node pointing to a layer.
void removedChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
Emitted when one or more nodes has been removed from a node within the tree.
void nameChanged(QgsLayerTreeNode *node, QString name)
Emitted when the name of the node is changed.
bool isVisible() const
Returns whether a node is really visible (ie checked and all its ancestors checked as well)
void setCustomProperty(const QString &key, const QVariant &value)
Sets a custom property for the node. Properties are stored in a map and saved in project file.
virtual void writeXml(QDomElement &parentElement, const QgsReadWriteContext &context)=0
Write layer tree to XML.
static QgsLayerTreeNode * readXml(QDomElement &element, const QgsReadWriteContext &context)
Read layer tree from XML.
void willRemoveChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
Emitted when one or more nodes will be removed from a node within the tree.
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer. Properties are stored in a map and saved in project file.
void setExpanded(bool expanded)
Sets whether the node should be shown as expanded or collapsed in GUI.
NodeType nodeType() const
Find out about type of the node. It is usually shorter to use convenience functions from QgsLayerTree...
void customPropertyChanged(QgsLayerTreeNode *node, const QString &key)
Emitted when a custom property of a node within the tree has been changed or removed.
QgsLayerTreeNode * parent()
Gets pointer to the parent. If parent is nullptr, the node is a root node.
void addedChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
Emitted when one or more nodes have been added to a node within the tree.
QList< QgsLayerTreeNode * > children()
Gets list of children of the node. Children are owned by the parent.
void willAddChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
Emitted when one or more nodes will be added to a node within the tree.
void visibilityChanged(QgsLayerTreeNode *node)
Emitted when check state of a node within the tree has been changed.
virtual void setItemVisibilityCheckedRecursive(bool checked)
Check or uncheck a node and all its children (taking into account exclusion rules)
void setItemVisibilityChecked(bool checked)
Check or uncheck a node (independently of its ancestors or children)
bool itemVisibilityChecked() const
Returns whether a node is checked (independently of its ancestors or children)
void setItemVisibilityCheckedParentRecursive(bool checked)
Check or uncheck a node and all its parents.
static QString legendFilterByExpression(const QgsLayerTreeLayer &layer, bool *enabled=nullptr)
Returns the expression filter of a legend layer.
Namespace with helper functions for layer tree operations.
static bool isLayer(const QgsLayerTreeNode *node)
Check whether the node is a valid layer node.
static QgsLayerTreeLayer * toLayer(QgsLayerTreeNode *node)
Cast node to a layer.
static bool isGroup(QgsLayerTreeNode *node)
Check whether the node is a valid group node.
static QgsLayerTreeGroup * toGroup(QgsLayerTreeNode *node)
Cast node to a group.
Class that runs a hit test with given map settings.
QMap< QString, QString > LayerFilterExpression
Maps an expression string to a layer id.
static void applyLayerNodeProperties(QgsLayerTreeLayer *nodeLayer, QList< QgsLayerTreeModelLegendNode * > &nodes)
update according to layer node's custom properties (order of items, user labels for items)
The QgsMapLayerLegend class is abstract interface for implementations of legends for one map layer.
virtual QList< QgsLayerTreeModelLegendNode * > createLayerTreeModelLegendNodes(QgsLayerTreeLayer *nodeLayer)=0
Returns list of legend nodes to be used for a particular layer tree layer node.
Restore overridden layer style on destruction.
void setOverrideStyle(const QString &style)
Temporarily apply a different style to the layer.
Base class for all map layer types.
virtual bool isSpatial() const
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated w...
bool isInScaleRange(double scale) const
Tests whether the layer should be visible at the specified scale.
void legendChanged()
Signal emitted when legend of the layer has changed.
QgsMapLayerLegend * legend() const
Can be nullptr.
void editingStopped()
Emitted when edited changes have been successfully written to the data provider.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
void editingStarted()
Emitted when editing on this layer has started.
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
virtual Qgis::MapLayerProperties properties() const
Returns the map layer properties of this layer.
virtual bool isEditable() const
Returns true if the layer can be edited.
QString title() const
Returns the title of the layer used by QGIS Server in GetCapabilities request.
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
virtual bool isModified() const
Returns true if the layer has been modified since last commit/save.
void flagsChanged()
Emitted when layer's flags have been modified.
void layerModified()
Emitted when modifications has been done on layer.
The QgsMapSettings class contains configuration for rendering of the map.
bool hasValidSettings() const
Check whether the map settings are valid and can be used for rendering.
Perform transforms between map coordinates and device coordinates.
static QByteArray layerTreeNodesToUriList(const QList< QgsLayerTreeNode * > &nodes)
Returns encoded URI list from a list of layer tree nodes.
static QgsProject * instance()
Returns the QgsProject singleton instance.
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
T value(const QString &dynamicKeyPart=QString()) const
Returns settings value.
static const QgsSettingsEntryBool settingsLayerTreeShowFeatureCountForNewLayers
Settings entry show feature counts for newly added layers by default.
Implementation of legend node interface for displaying preview of vector symbols and their labels and...
void setIconSize(QSize sz)
Set the icon size.
QSize minimumIconSize() const
Calculates the minimum icon size to prevent cropping.
QVariant data(int role) const override
Returns data associated with the item. Must be implemented in derived class.
Represents a vector layer which manages a vector based data sets.
long long featureCount(const QString &legendKey) const
Number of features rendered with specified legend key.
static QString displayString(Type type) SIP_HOLDGIL
Returns a non-translated display string type for a WKB type, e.g., the geometry name used in WKT geom...
@ VectorLayer
Vector layer.
QSize iconSize(bool dockableToolbar)
Returns the user-preferred size of a window's toolbar icons.
QgsLayerTreeModelLegendNode * legendNode(const QString &rule, QgsLayerTreeModel &model)
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
#define QgsDebugMsgLevel(str, level)
Structure that stores all data associated with one map layer.
Structure that stores tree representation of map layer's legend.
QMap< QgsLayerTreeModelLegendNode *, QgsLayerTreeModelLegendNode * > parents
Pointer to parent for each active node. Top-level nodes have nullptr parent. Pointers are not owned.
QMap< QgsLayerTreeModelLegendNode *, QList< QgsLayerTreeModelLegendNode * > > children
List of children for each active node. Top-level nodes are under nullptr key. Pointers are not owned.