40 : QAbstractItemModel( parent )
41 , mRootNode( rootNode )
42 , mFlags( ShowLegend | AllowLegendChangeState | DeferredLegendInvalidation )
62 if ( !
index.isValid() )
65 QObject *obj =
reinterpret_cast<QObject *
>(
index.internalPointer() );
66 return qobject_cast<QgsLayerTreeNode *>( obj );
100 return QModelIndex();
107 return QModelIndex();
114 return createIndex( row, column,
static_cast<QObject *
>( n->
children().at( row ) ) );
120 if ( !child.isValid() )
121 return QModelIndex();
134 return QModelIndex();
142 Q_ASSERT( parentNode );
145 if ( !grandParentNode )
146 return QModelIndex();
148 int row = grandParentNode->
children().indexOf( parentNode );
149 Q_ASSERT( row >= 0 );
151 return createIndex( row, 0,
static_cast<QObject *
>( parentNode ) );
164 if ( role == Qt::DisplayRole || role == Qt::EditRole )
172 QString name = nodeLayer->
name();
174 if ( vlayer && nodeLayer->
customProperty( QStringLiteral(
"showFeatureCount" ), 0 ).toInt() && role == Qt::DisplayRole )
180 name += QStringLiteral(
" [%1%2]" ).arg(
181 estimatedCount ? QStringLiteral(
"≈" ) : QString(),
182 count != -1 ? QLocale().toString( count ) : tr(
"N/A" ) );
187 else if ( role == Qt::DecorationRole &&
index.column() == 0 )
212 QPixmap pixmap( icon.pixmap( iconSize, iconSize ) );
214 QPainter painter( &pixmap );
215 painter.drawPixmap( 0, 0, iconSize, iconSize,
QgsApplication::getThemePixmap( layer->
isModified() ? QStringLiteral(
"/mIconEditableEdits.svg" ) : QStringLiteral(
"/mActionToggleEditing.svg" ) ) );
218 icon = QIcon( pixmap );
224 else if ( role == Qt::CheckStateRole )
248 f.setUnderline(
true );
254 f.setItalic( !f.italic() );
261 QBrush brush( qApp->palette().color( QPalette::Text ), Qt::SolidPattern );
267 QColor fadedTextColor = brush.color();
268 fadedTextColor.setAlpha( 128 );
269 brush.setColor( fadedTextColor );
274 else if ( role == Qt::ToolTipRole )
280 QString title = !layer->
metadata().
title().isEmpty() ? layer->metadata().title() :
281 !layer->serverProperties()->title().isEmpty() ? layer->serverProperties()->title() :
282 !layer->serverProperties()->shortName().isEmpty() ? layer->serverProperties()->shortName() :
285 title =
"<b>" + title.toHtmlEscaped() +
"</b>";
287 if ( layer->isSpatial() && layer->crs().isValid() )
289 QString layerCrs = layer->crs().authid();
290 if ( !std::isnan( layer->crs().coordinateEpoch() ) )
292 layerCrs += QStringLiteral(
" @ %1" ).arg(
qgsDoubleToString( layer->crs().coordinateEpoch(), 3 ) );
294 if (
QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer ) )
297 title += tr(
" (%1)" ).arg( layerCrs ).toHtmlEscaped();
303 const QString abstract = !layer->metadata().abstract().isEmpty() ? layer->metadata().abstract() : layer->serverProperties()->abstract();
304 if ( !abstract.isEmpty() )
307 const QStringList abstractLines = abstract.split(
'\n' );
308 for (
const auto &l : abstractLines )
310 parts << l.toHtmlEscaped();
315 QString source( layer->publicSource() );
316 if ( source.size() > 1024 )
318 source = source.left( 1023 ) + QString( QChar( 0x2026 ) );
321 parts <<
"<i>" + source.toHtmlEscaped() +
"</i>";
324 const bool showFeatureCount = nodeLayer->
customProperty( QStringLiteral(
"showFeatureCount" ), 0 ).toBool();
326 if ( showFeatureCount && estimatedCount )
328 parts << tr(
"<b>Feature count is estimated</b> : the feature count is determined by the database statistics" );
331 return parts.join( QLatin1String(
"<br/>" ) );
342 if ( !
index.isValid() )
344 Qt::ItemFlags rootFlags = Qt::ItemFlags();
346 rootFlags |= Qt::ItemIsDropEnabled;
353 Qt::ItemFlags f = Qt::ItemIsEnabled | Qt::ItemIsSelectable;
356 f |= Qt::ItemIsEditable;
359 bool isEmbedded = node->
customProperty( QStringLiteral(
"embedded" ) ).toInt();
364 if ( !isEmbedded || ( isEmbedded && node->
parent() && !node->
parent()->
customProperty( QStringLiteral(
"embedded" ) ).toInt() ) )
365 f |= Qt::ItemIsDragEnabled;
369 f |= Qt::ItemIsUserCheckable;
372 f |= Qt::ItemIsDropEnabled;
384 bool res = sym->
setData( value, role );
392 return QAbstractItemModel::setData(
index, value, role );
394 if ( role == Qt::CheckStateRole )
399 bool checked =
static_cast< Qt::CheckState
>( value.toInt() ) == Qt::Checked;
400 if ( checked && node->
children().isEmpty() )
420 else if ( role == Qt::EditRole )
428 layer->
setName( value.toString() );
438 return QAbstractItemModel::setData(
index, value, role );
443 if ( !node || !node->
parent() )
444 return QModelIndex();
449 Q_ASSERT( row >= 0 );
450 return index( row, 0, parentIndex );
459 if ( child->
parent() == node )
462 return _isChildOfNode( child->
parent(), node );
465static bool _isChildOfNodes(
QgsLayerTreeNode *child,
const QList<QgsLayerTreeNode *> &nodes )
469 if ( _isChildOfNode( child, n ) )
479 QList<QgsLayerTreeNode *> nodes;
480 const auto constList = list;
481 for (
const QModelIndex &
index : constList )
494 QList<QgsLayerTreeNode *> nodesFinal;
497 if ( !_isChildOfNodes( node, nodes ) )
528 emit dataChanged( idx, idx );
532 if ( oldNodeCount > 0 )
534 beginRemoveRows( idx, 0, oldNodeCount - 1 );
618 std::unique_ptr< QgsLayerTreeFilterSettings >
filterSettings = std::make_unique< QgsLayerTreeFilterSettings >( *settings );
629 if ( useExpressions )
651 mFilterSettings = std::make_unique< QgsLayerTreeFilterSettings >( *settings );
654 bool hitTestWasRunning =
false;
661 hitTestWasRunning =
true;
664 std::unique_ptr< QgsMapHitTest > blockingHitTest;
668 blockingHitTest = std::make_unique< QgsMapHitTest >( *
mFilterSettings );
675 if ( !hitTestWasRunning )
680 blockingHitTest->run();
682 handleHitTestResults();
691 handleHitTestResults();
700void QgsLayerTreeModel::handleHitTestResults()
728 if ( scale != previousScale )
780 beginInsertRows(
node2index( node ), indexFrom, indexTo );
783static QList<QgsLayerTreeLayer *> _layerNodesInSubtree(
QgsLayerTreeNode *node,
int indexFrom,
int indexTo )
785 QList<QgsLayerTreeNode *> children = node->
children();
786 QList<QgsLayerTreeLayer *> newLayerNodes;
787 for (
int i = indexFrom; i <= indexTo; ++i )
795 return newLayerNodes;
804 const auto subNodes = _layerNodesInSubtree( node, indexFrom, indexTo );
813 beginRemoveRows(
node2index( node ), indexFrom, indexTo );
816 const auto subNodes = _layerNodesInSubtree( node, indexFrom, indexTo );
881 QgsMapLayer *layer = qobject_cast<QgsMapLayer *>( sender() );
897 QgsMapLayer *layer = qobject_cast<QgsMapLayer *>( sender() );
911 QgsMapLayer *layer = qobject_cast<QgsMapLayer *>( sender() );
922 if ( nodeLayer->
customProperty( QStringLiteral(
"showFeatureCount" ) ).toInt() )
934 if (
index.isValid() )
938void QgsLayerTreeModel::legendNodeSizeChanged()
945 if (
index.isValid() )
946 emit dataChanged(
index,
index, QVector<int> { Qt::SizeHintRole } );
949void QgsLayerTreeModel::hitTestTaskCompleted()
954 handleHitTestResults();
961 if ( !nodeLayer->
layer() )
1008 const auto constChildren = group->
children();
1026 disconnect( nodeLayer,
nullptr,
this,
nullptr );
1028 if ( !nodeLayer->
layer() )
1039 disconnect( nodeLayer->
layer(),
nullptr,
this,
nullptr );
1045 const auto constChildren = parentGroup->
children();
1057 const auto constChildren = parentGroup->
children();
1086 disconnect(
mRootNode,
nullptr,
this,
nullptr );
1097 int count = node->
children().count();
1100 emit dataChanged(
index( 0, 0, idx ),
index( count - 1, 0, idx ) );
1101 for (
int i = 0; i < count; ++i )
1117 emit dataChanged( idx, idx, QVector<int>() << Qt::FontRole << Qt::ForegroundRole );
1120 int count = node->
children().count();
1121 for (
int i = 0; i < count; ++i )
1127 return Qt::CopyAction | Qt::MoveAction;
1133 types << QStringLiteral(
"application/qgis.layertreemodeldata" );
1141 QModelIndexList sortedIndexes = indexes;
1142 std::sort( sortedIndexes.begin(), sortedIndexes.end(), std::less<QModelIndex>() );
1144 QList<QgsLayerTreeNode *> nodesFinal =
indexes2nodes( sortedIndexes,
true );
1146 if ( nodesFinal.isEmpty() )
1149 QMimeData *
mimeData =
new QMimeData();
1151 QDomDocument layerTreeDoc;
1152 QDomElement rootLayerTreeElem = layerTreeDoc.createElement( QStringLiteral(
"layer_tree_model_data" ) );
1158 layerTreeDoc.appendChild( rootLayerTreeElem );
1160 QString errorMessage;
1162 QDomDocument layerDefinitionsDoc( QStringLiteral(
"qgis-layer-definition" ) );
1165 QString txt = layerDefinitionsDoc.toString();
1167 mimeData->setData( QStringLiteral(
"application/qgis.layertreemodeldata" ), layerTreeDoc.toString().toUtf8() );
1168 mimeData->setData( QStringLiteral(
"application/qgis.application.pid" ), QString::number( QCoreApplication::applicationPid() ).toUtf8() );
1169 mimeData->setData( QStringLiteral(
"application/qgis.layertree.source" ), QStringLiteral(
":0x%1" ).arg(
reinterpret_cast<quintptr
>(
this ), 2 * QT_POINTER_SIZE, 16, QLatin1Char(
'0' ) ).toUtf8() );
1170 mimeData->setData( QStringLiteral(
"application/qgis.layertree.layerdefinitions" ), txt.toUtf8() );
1178 if ( action == Qt::IgnoreAction )
1181 if ( !
data->hasFormat( QStringLiteral(
"application/qgis.layertreemodeldata" ) ) )
1188 const QString restrictTypes(
data->data( QStringLiteral(
"application/qgis.restrictlayertreemodelsubclass" ) ) );
1189 if ( !restrictTypes.isEmpty() && restrictTypes != QString( metaObject()->className() ) )
1196 if (
parent.isValid() && row == -1 )
1202 qint64 qgisPid =
data->data( QStringLiteral(
"application/qgis.application.pid" ) ).toInt( &ok );
1204 if ( ok && qgisPid != QCoreApplication::applicationPid() )
1206 QByteArray encodedLayerDefinitionData =
data->data( QStringLiteral(
"application/qgis.layertree.layerdefinitions" ) );
1207 QDomDocument layerDefinitionDoc;
1208 if ( !layerDefinitionDoc.setContent( QString::fromUtf8( encodedLayerDefinitionData ) ) )
1211 QString errorMessage;
1213 emit
messageEmitted( tr(
"New layers added from another QGIS instance" ) );
1217 QByteArray encodedLayerTreeData =
data->data( QStringLiteral(
"application/qgis.layertreemodeldata" ) );
1219 QDomDocument layerTreeDoc;
1220 if ( !layerTreeDoc.setContent( QString::fromUtf8( encodedLayerTreeData ) ) )
1223 QDomElement rootLayerTreeElem = layerTreeDoc.documentElement();
1224 if ( rootLayerTreeElem.tagName() != QLatin1String(
"layer_tree_model_data" ) )
1227 QList<QgsLayerTreeNode *> nodes;
1229 QDomElement elem = rootLayerTreeElem.firstChildElement();
1230 while ( !elem.isNull() )
1236 elem = elem.nextSiblingElement();
1239 if ( nodes.isEmpty() )
1278 return mFlags.testFlag( f );
1288 QList<QgsLayerTreeModelLegendNode *> filtered;
1300 if ( !nodes.isEmpty() &&
mFilterSettings->layers().contains( nodes.at( 0 )->layerNode()->layer() ) )
1322 || node->data( Qt::CheckStateRole ).toInt() == Qt::Checked;
1326 if (
QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( node->layerNode()->layer() ) )
1330 ( it->contains( ruleKey ) ||
1331 ( !it->isEmpty() && isDataDefinedSize )
1366 const auto constMLegend =
mLegend;
1369 qDeleteAll(
data.originalNodes );
1386 if (
mLegend.contains( nodeLayer ) )
1388 qDeleteAll(
mLegend[nodeLayer].originalNodes );
1389 delete mLegend[nodeLayer].tree;
1397 if ( !nodeL || !nodeL->
layer() )
1417 int widgetsCount = ml->
customProperty( QStringLiteral(
"embeddedWidgets/count" ), 0 ).toInt();
1418 while ( widgetsCount > 0 )
1420 lstNew.insert( 0,
new EmbeddedWidgetLegendNode( nodeL ) );
1425 QList<QgsLayerTreeModelLegendNode *> filteredLstNew =
filterLegendNodes( lstNew );
1427 const auto constLstNew = lstNew;
1430 n->setParent(
this );
1439 const auto constFilteredLstNew = filteredLstNew;
1444 embeddedNode = legendNode;
1445 filteredLstNew.removeOne( legendNode );
1456 int count = legendTree ? legendTree->
children[
nullptr].count() : filteredLstNew.count();
1458 if ( !filteredLstNew.isEmpty() )
1461 const QModelIndex nodeIndex {
node2index( nodeL ) };
1468 beginInsertRows(
node2index( nodeL ), 0, count - 1 );
1473 data.activeNodes = filteredLstNew;
1474 data.embeddedNodeInParent = embeddedNode;
1475 data.tree = legendTree;
1479 if ( !filteredLstNew.isEmpty() )
1494 bool hasParentKeys =
false;
1499 hasParentKeys =
true;
1503 if ( !hasParentKeys )
1507 QHash<QString, QgsLayerTreeModelLegendNode *> rule2node;
1508 rule2node[QString()] =
nullptr;
1512 if ( ruleKey.isEmpty() )
1514 if ( rule2node.contains( ruleKey ) )
1516 rule2node[ruleKey] = n;
1541 context->setScaleFactor( dpi / 25.4 );
1548 context->setRendererScale( scale );
1551 return validData ? context.release() :
nullptr;
1557 return qobject_cast<QgsLayerTreeModelLegendNode *>(
reinterpret_cast<QObject *
>(
index.internalPointer() ) );
1569 int row =
data.tree->children[parentLegendNode].indexOf( legendNode );
1570 return index( row, 0, parentIndex );
1575 int row =
data.tree->children[
nullptr].indexOf( legendNode );
1576 return index( row, 0, parentIndex );
1581 Q_ASSERT( parentIndex.isValid() );
1582 int row =
data.activeNodes.indexOf( legendNode );
1584 return QModelIndex();
1586 return index( row, 0, parentIndex );
1602 if ( !
mLegend.contains( nL ) )
1609 int count =
data.activeNodes.count();
1616 Q_ASSERT(
mLegend.contains( nL ) );
1619 return createIndex( row, column,
static_cast<QObject *
>(
data.tree->children[
nullptr].at( row ) ) );
1621 return createIndex( row, column,
static_cast<QObject *
>(
data.activeNodes.at( row ) ) );
1629 return createIndex( row, column,
static_cast<QObject *
>(
data.tree->children[node].at( row ) ) );
1631 return QModelIndex();
1644 int row =
data.tree->children[grandParentNode].indexOf( parentNode );
1645 return createIndex( row, 0,
static_cast<QObject *
>( parentNode ) );
1659 return node->
data( role );
1665 Qt::ItemFlags f = node->
flags();
1667 f &= ~Qt::ItemIsUserCheckable;
1674 return static_cast< bool >(
mLegend[nodeLayer].embeddedNodeInParent );
1679 return mLegend[nodeLayer].embeddedNodeInParent;
1688 return QIcon( qvariant_cast<QPixmap>( legendNode->
data( Qt::DecorationRole ) ) );
1694 if ( !
mLegend.contains( nodeLayer ) )
1695 return QList<QgsLayerTreeModelLegendNode *>();
1698 QList<QgsLayerTreeModelLegendNode *> lst(
data.activeNodes );
1699 if ( !skipNodeEmbeddedInParent &&
data.embeddedNodeInParent )
1700 lst.prepend(
data.embeddedNodeInParent );
1706 return mLegend.value( nodeLayer ).originalNodes;
1711 for (
auto it =
mLegend.constBegin(); it !=
mLegend.constEnd(); ++it )
1714 if ( layer->
layerId() == layerId )
1716 const auto activeNodes =
mLegend.value( layer ).activeNodes;
1755 QList<QgsSymbolLegendNode *> symbolNodes;
1756 QMap<QString, int> widthMax;
1764 widthMax[parentKey] = std::max( sz.width(), widthMax.contains( parentKey ) ? widthMax[parentKey] : 0 );
1766 symbolNodes.append( n );
1772 Q_ASSERT( widthMax[parentKey] > 0 );
1773 const int twiceMarginWidth = 2;
1774 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 ...
@ SkipVisibilityCheck
If set, the standard visibility check should be skipped.
@ 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.
static QgsTaskManager * taskManager()
Returns the application's task manager, used for managing application wide background task handling.
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
Class for storing the component parts of a RDBMS data source URI (e.g.
bool useEstimatedMetadata() const
Returns true if estimated metadata should be used for the connection.
A geometry is the spatial representation of a feature.
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, Qgis::LayerTreeInsertionMethod insertMethod=Qgis::LayerTreeInsertionMethod::OptimalInInsertionGroup, const QgsLayerTreeRegistryBridge::InsertionPoint *insertPoint=nullptr)
Loads the QLR at path into QGIS.
static bool exportLayerDefinition(const QString &path, const QList< QgsLayerTreeNode * > &selectedTreeNodes, QString &errorMessage)
Exports the selected layer tree nodes to a QLR file.
Contains settings relating to filtering the contents of QgsLayerTreeModel and views.
void setFilterPolygon(const QgsGeometry &polygon)
Sets the optional filter polygon, used when testing for symbols to show in the legend.
void setLayerFilterExpressionsFromLayerTree(QgsLayerTree *tree)
Sets layer filter expressions using a layer tree.
void setFlags(Qgis::LayerTreeFilterFlags flags)
Sets the filter flags.
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.
@ SymbolLegend
Vector symbol legend node type.
@ ParentRuleKey
Rule key of the parent legend node - for legends with tree hierarchy (QString). Added in 2....
@ NodeType
Type of node. Added in 3.16.
@ RuleKey
Rule key of the node (QString)
@ IsDataDefinedSize
Set when a node is related to data defined size (title or separated legend items)....
virtual void invalidateMapBasedData()
Notification from model that information from associated map view has changed.
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.
QgsLayerTreeLayer * layerNode() const
Returns pointer to the parent layer node.
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()
void setFilterSettings(const QgsLayerTreeFilterSettings *settings=nullptr)
Sets the filter settings to use to filter legend nodes.
QVariant legendNodeData(QgsLayerTreeModelLegendNode *node, int role) const
void hitTestStarted()
Emitted when a hit test for visible legend items starts.
double mLegendMapViewScale
void setRootGroup(QgsLayerTree *newRootGroup)
Reset the model and use a new root group node.
Q_DECL_DEPRECATED 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
void hitTestCompleted()
Emitted when a hit test for visible legend items completes.
std::unique_ptr< QgsLayerTreeFilterSettings > mFilterSettings
QVariant data(const QModelIndex &index, int role=Qt::DisplayRole) const override
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)
QMap< QString, QSet< QString > > mHitTestResults
QModelIndex parent(const QModelIndex &child) const override
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.
bool hitTestInProgress() const
Returns true if a hit test for visible legend items is currently in progress.
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.
QSet< QgsScreenProperties > targetScreenProperties() const
Returns the target screen properties to use when generating icons.
QStringList mimeTypes() const override
QMimeData * mimeData(const QModelIndexList &indexes) const override
QSet< QgsScreenProperties > mTargetScreenProperties
void nodeRemovedChildren()
int rowCount(const QModelIndex &parent=QModelIndex()) const override
QPointer< QgsMapHitTestTask > mHitTestTask
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.
const QgsLayerTreeFilterSettings * filterSettings() const
Returns the filter settings to use to filter legend nodes.
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)
const QgsMapSettings * legendFilterMapSettings() const
Returns the current map settings used for the current legend filter (or nullptr if none is enabled)
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 waitForHitTestBlocking()
When a current hit test for visible legend items is in progress, calling this method will block until...
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)....
@ UseThreadedHitTest
Run legend hit tests in a background thread.
void addTargetScreenProperties(const QgsScreenProperties &properties)
Adds additional target screen properties to use when generating icons for Qt::DecorationRole data.
Flags mFlags
Sets of flags for the model.
Q_DECL_DEPRECATED 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.
QList< QgsLayerTreeNode * > children()
Gets list of children of the node. Children are owned by the parent.
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.
QgsLayerTreeNode * parent()
Gets pointer to the parent. If parent is nullptr, the node is a root node.
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.
void addedChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
Emitted when one or more nodes have been added to a node within the tree.
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.
Namespace with helper functions for layer tree operations.
static QgsLayerTreeLayer * toLayer(QgsLayerTreeNode *node)
Cast node to a layer.
static bool isLayer(const QgsLayerTreeNode *node)
Check whether the node is a valid layer node.
static bool isGroup(QgsLayerTreeNode *node)
Check whether the node is a valid group node.
static QgsLayerTreeGroup * toGroup(QgsLayerTreeNode *node)
Cast node to a group.
Executes a QgsMapHitTest in a background thread.
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.
QgsLayerMetadata metadata
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.
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.
Stores properties relating to a screen.
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.
long addTask(QgsTask *task, int priority=0)
Adds a task to the manager.
void taskCompleted()
Will be emitted by task to indicate its successful completion.
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.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
static QString displayString(Qgis::WkbType type)
Returns a non-translated display string type for a WKB type, e.g., the geometry name used in WKT geom...
#define Q_NOWARN_DEPRECATED_POP
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
#define Q_NOWARN_DEPRECATED_PUSH
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.
LayerLegendTree * tree
Optional pointer to a tree structure - see LayerLegendTree for details.
QList< QgsLayerTreeModelLegendNode * > originalNodes
Data structure for storage of legend nodes.
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.