31 #include <QContextMenuEvent>
32 #include <QHeaderView>
35 #ifdef ENABLE_MODELTEST
36 #include "modeltest.h"
47 setHeaderHidden(
true );
49 setDragEnabled(
true );
50 setAcceptDrops(
true );
51 setDropIndicatorShown(
true );
52 setEditTriggers( EditKeyPressed );
53 setExpandsOnDoubleClick(
false );
56 header()->setStretchLastSection(
false );
57 header()->setSectionResizeMode( QHeaderView::ResizeToContents );
60 setVerticalScrollMode( QAbstractItemView::ScrollPerPixel );
62 setSelectionMode( ExtendedSelection );
63 setDefaultDropAction( Qt::MoveAction );
67 setStyle(
new QgsLayerTreeViewProxyStyle(
this ) );
69 #if QT_VERSION < QT_VERSION_CHECK(5, 11, 0)
78 connect( horizontalScrollBar(), &QScrollBar::valueChanged,
this, &QgsLayerTreeView::onHorizontalScroll );
106 #ifdef ENABLE_MODELTEST
107 new ModelTest( mProxyModel,
this );
110 mProxyModel->setShowPrivateLayers( mShowPrivateLayers );
111 QTreeView::setModel( mProxyModel );
120 connect( treeModel, &QAbstractItemModel::dataChanged,
this, &QgsLayerTreeView::onDataChanged );
129 return mProxyModel ? qobject_cast<QgsLayerTreeModel *>( mProxyModel->sourceModel() ) :
nullptr;
154 setCurrentIndex( QModelIndex() );
180 QModelIndex idx = indexAt( event->pos() );
181 if ( !idx.isValid() )
182 setCurrentIndex( QModelIndex() );
185 if ( menu && menu->actions().count() != 0 )
186 menu->exec( mapToGlobal( event->pos() ) );
203 int widgetsCount = layer->customProperty( QStringLiteral(
"embeddedWidgets/count" ), 0 ).toInt();
205 for (
int i = 0; i < widgetsCount; ++i )
207 QString providerId = layer->customProperty( QStringLiteral(
"embeddedWidgets/%1/id" ).arg( i ) ).toString();
211 QWidget *wdgt = provider->createWidget( layer, i );
228 setIndexWidget( index, wdgt );
238 QStringList expandedNodeKeys = parentNode->
customProperty( QStringLiteral(
"expandedLegendNodes" ) ).toStringList();
239 if ( expandedNodeKeys.isEmpty() )
246 if ( expandedNodeKeys.contains( ruleKey ) )
252 QList<QgsLayerTreeNode *> children = parentNode->
children();
253 for (
int i = start; i <= end; ++i )
272 node->setExpanded( isExpanded( index ) );
277 QStringList lst = node->layerNode()->customProperty( QStringLiteral(
"expandedLegendNodes" ) ).toStringList();
278 bool expanded = isExpanded( index );
279 bool isInList = lst.contains( ruleKey );
280 if ( expanded && !isInList )
282 lst.append( ruleKey );
283 node->layerNode()->setCustomProperty( QStringLiteral(
"expandedLegendNodes" ), lst );
285 else if ( !expanded && isInList )
287 lst.removeAll( ruleKey );
288 node->layerNode()->setCustomProperty( QStringLiteral(
"expandedLegendNodes" ), lst );
296 QString layerCurrentID = layerCurrent ? layerCurrent->
id() : QString();
301 QModelIndex proxyModelNodeLayerIndex;
306 proxyModelNodeLayerIndex =
node2index( nodeLayer );
309 if ( ! proxyModelNodeLayerIndex.isValid() )
328 if ( isExpanded( idx ) != expanded )
329 setExpanded( idx, expanded );
332 void QgsLayerTreeView::onCustomPropertyChanged(
QgsLayerTreeNode *node,
const QString &key )
337 QSet<QString> expandedLegendNodes = qgis::listToSet( node->
customProperty( QStringLiteral(
"expandedLegendNodes" ) ).toStringList() );
343 if ( !key.isEmpty() )
359 const auto constChildren = node->
children();
388 return index2node( selectionModel()->currentIndex() );
420 QModelIndexList mapped;
421 const QModelIndexList selected = selectionModel()->selectedIndexes();
422 mapped.reserve( selected.size() );
423 for (
const QModelIndex &index : selected )
424 mapped << mProxyModel->mapToSource( index );
431 QList<QgsLayerTreeLayer *> layerNodes;
443 QList<QgsMapLayer *> list;
448 list << node->layer();
455 QModelIndexList mapped;
456 const QModelIndexList selected = selectionModel()->selectedIndexes();
457 mapped.reserve( selected.size() );
458 for (
const QModelIndex &index : selected )
459 mapped << mProxyModel->mapToSource( index );
463 return qgis::setToList( layersSet );
491 QStringList QgsLayerTreeView::viewOnlyCustomProperties()
493 return QStringList() << QStringLiteral(
"expandedLegendNodes" );
512 const auto constLayerLegendNodes = model->
layerLegendNodes( nodeLayer,
true );
516 if ( !parentKey.isEmpty() && !lst.contains( parentKey ) )
526 const auto constChildren = parent->
children();
554 if ( mMessageBar == messageBar )
557 mMessageBar = messageBar;
571 mShowPrivateLayers = showPrivate;
577 return mShowPrivateLayers;
587 if ( event->modifiers() & Qt::ControlModifier )
591 QTreeView::mouseReleaseEvent( event );
597 if ( event->key() == Qt::Key_Space )
601 if ( ! constSelectedNodes.isEmpty() )
603 bool isFirstNodeChecked = constSelectedNodes[0]->itemVisibilityChecked();
615 if ( event->modifiers() & Qt::ControlModifier )
619 QTreeView::keyPressEvent( event );
625 if ( event->keyboardModifiers() & Qt::AltModifier )
629 QTreeView::dropEvent( event );
642 header()->setMinimumSectionSize( viewport()->width() );
643 QTreeView::resizeEvent( event );
646 void QgsLayerTreeView::onHorizontalScroll(
int value )
649 viewport()->update();
652 void QgsLayerTreeView::onDataChanged(
const QModelIndex &topLeft,
const QModelIndex &bottomRight,
const QVector<int> &roles )
655 Q_UNUSED( bottomRight )
661 if ( roles.contains( Qt::SizeHintRole ) )
662 viewport()->update();
669 void QgsLayerTreeView::checkModel()
675 qDebug() <<
"----------------------------------------------";
682 for (
int i = 0; i < mProxyModel->rowCount(
node2index( node ) ); i++ )
686 debug( childNode, depth + 1 );
688 qDebug() <<
"Warning no child node!";
731 : QSortFilterProxyModel( parent )
732 , mLayerTreeModel( treeModel )
734 setSourceModel( treeModel );
739 if ( filterText == mFilterText )
742 mFilterText = filterText;
749 return nodeShown( node );
766 if ( !mFilterText.isEmpty() && !layer->
name().contains( mFilterText, Qt::CaseInsensitive ) )
768 if ( ! mShowPrivateLayers && layer->
flags().testFlag( QgsMapLayer::LayerFlag::Private ) )
778 return mShowPrivateLayers;
783 mShowPrivateLayers = showPrivate;
MessageLevel
Level for messages This will be used both for message log and message bar in application.
static const double UI_SCALE_FACTOR
UI scaling factor.
static QgsLayerTreeEmbeddedWidgetRegistry * layerTreeEmbeddedWidgetRegistry()
Returns the global layer tree embedded widget registry, used for registering widgets that may be embe...
Layer tree group node serves as a container for layers and further groups.
QgsLayerTreeLayer * findLayer(QgsMapLayer *layer) const
Find layer node representing the map layer.
Layer tree node points to a map layer.
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.
QgsLayerTreeLayer * layerNode() const
Returns pointer to the parent layer node.
@ ParentRuleKeyRole
Rule key of the parent legend node - for legends with tree hierarchy (QString). Added in 2....
@ RuleKeyRole
Rule key of the node (QString)
The QgsLayerTreeModel class is model implementation for Qt item views framework.
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...
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...
QModelIndex legendNode2index(QgsLayerTreeModelLegendNode *legendNode)
Returns index for a given legend node.
Qt::ItemFlags flags(const QModelIndex &index) const override
void setCurrentIndex(const QModelIndex ¤tIndex)
Sets index of the current item. May be used by view. Item marked as current is underlined.
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 messageEmitted(const QString &message, Qgis::MessageLevel level=Qgis::Info, int duration=5)
Emits a message than can be displayed to the user in a GUI class.
QgsLayerTreeNode * index2node(const QModelIndex &index) const
Returns layer tree node for given index.
int rowCount(const QModelIndex &parent=QModelIndex()) const override
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
static QgsLayerTreeModelLegendNode * index2legendNode(const QModelIndex &index)
Returns legend node for given index.
void refreshLayerLegend(QgsLayerTreeLayer *nodeLayer)
Force a refresh of legend nodes of a layer node.
@ ActionHierarchical
Check/uncheck action has consequences on children (or parents for leaf node)
@ UseEmbeddedWidgets
Layer nodes may optionally include extra embedded widgets (if used in QgsLayerTreeView)....
This class is a base class for nodes in a layer tree.
@ NodeGroup
Container of other groups and layers.
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.
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.
virtual QString name() const =0
Returns name of the 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.
QgsLayerTreeNode * parent()
Gets pointer to the parent. If parent is nullptr, the node is a root node.
QList< QgsLayerTreeNode * > children()
Gets list of children of the node. Children are owned by the parent.
bool isExpanded() const
Returns whether the node should be shown as expanded or collapsed in GUI.
void setItemVisibilityChecked(bool checked)
Check or uncheck a node (independently of its ancestors or children)
void expandedChanged(QgsLayerTreeNode *node, bool expanded)
Emitted when the collapsed/expanded state of a node within the tree has been changed.
The QgsLayerTreeProxyModel class is a proxy model for QgsLayerTreeModel, supports private layers and ...
bool showPrivateLayers() const
Returns if private layers are shown.
bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override
void setFilterText(const QString &filterText=QString())
Sets filter to filterText.
void setShowPrivateLayers(bool showPrivate)
Determines if private layers are shown.
QgsLayerTreeProxyModel(QgsLayerTreeModel *treeModel, QObject *parent)
Constructs QgsLayerTreeProxyModel with source model treeModel and a parent.
static QSet< QgsMapLayer * > collectMapLayersRecursive(const QList< QgsLayerTreeNode * > &nodes)
Returns map layers from the given list of layer tree nodes.
The QgsLayerTreeViewDefaultActions class serves as a factory of actions that can be used together wit...
Indicator that can be used in a layer tree view to display icons next to items of the layer tree.
void changed()
Emitted when the indicator changes state (e.g.
void expandAllNodes()
Enhancement of QTreeView::expandAll() that also records expanded state in layer tree nodes.
QList< QgsLayerTreeViewIndicator * > indicators(QgsLayerTreeNode *node) const
Returns list of indicators associated with a particular layer tree node.
void currentLayerChanged(QgsMapLayer *layer)
Emitted when a current layer is changed.
void collapseAllNodes()
Enhancement of QTreeView::collapseAll() that also records expanded state in layer tree nodes.
QModelIndex legendNode2index(QgsLayerTreeModelLegendNode *legendNode)
Returns proxy model index for a given legend node.
QgsLayerTreeViewDefaultActions * defaultActions()
Gets access to the default actions that may be used with the tree view.
QString mCurrentLayerID
Keeps track of current layer ID (to check when to emit signal about change of current layer)
void setModel(QAbstractItemModel *model) override
Overridden setModel() from base class. Only QgsLayerTreeModel is an acceptable model.
QHash< QgsLayerTreeNode *, QList< QgsLayerTreeViewIndicator * > > mIndicators
Storage of indicators used with the tree view.
QList< QgsLayerTreeLayer * > selectedLayerNodes() const
Returns list of selected nodes filtered to just layer nodes.
void removeIndicator(QgsLayerTreeNode *node, QgsLayerTreeViewIndicator *indicator)
Removes a previously added indicator to a layer tree node.
void refreshLayerSymbology(const QString &layerId)
Force refresh of layer symbology. Normally not needed as the changes of layer's renderer are monitore...
void dropEvent(QDropEvent *event) override
QgsLayerTreeView(QWidget *parent=nullptr)
Constructor for QgsLayerTreeView.
QgsMapLayer * currentLayer() const
Returns the currently selected layer, or nullptr if no layers is selected.
QgsLayerTreeViewMenuProvider * menuProvider() const
Returns pointer to the context menu provider. May be nullptr.
void onExpandedChanged(QgsLayerTreeNode *node, bool expanded)
QgsLayerTreeNode * index2node(const QModelIndex &index) const
Returns layer tree node for given proxy model tree index.
void resizeEvent(QResizeEvent *event) override
QList< QgsMapLayer * > selectedLayersRecursive() const
Gets list of selected layers, including those that are not directly selected, but their ancestor grou...
void mouseReleaseEvent(QMouseEvent *event) override
void updateExpandedStateFromNode(QgsLayerTreeNode *node)
QgsLayerTreeModelLegendNode * currentLegendNode() const
Gets current legend node.
QgsLayerTreeModel * layerTreeModel() const
Gets access to the model casted to QgsLayerTreeModel.
void setMenuProvider(QgsLayerTreeViewMenuProvider *menuProvider)
Sets provider for context menu. Takes ownership of the instance.
bool showPrivateLayers()
Returns the show private layers status.
void setLayerVisible(QgsMapLayer *layer, bool visible)
Convenience methods which sets the visible state of the specified map layer.
QModelIndex node2sourceIndex(QgsLayerTreeNode *node) const
Returns source model index for a given node.
QgsMapLayer * layerForIndex(const QModelIndex &index) const
QPoint mLastReleaseMousePos
Used by the item delegate for identification of which indicator has been clicked.
friend class QgsLayerTreeViewItemDelegate
void updateExpandedStateToNode(const QModelIndex &index)
QgsLayerTreeProxyModel * proxyModel() const
Returns the proxy model used by the view.
QgsLayerTreeViewMenuProvider * mMenuProvider
Context menu provider. Owned by the view.
QgsLayerTreeModelLegendNode * index2legendNode(const QModelIndex &index) const
Returns legend node for given proxy model tree index.
void contextMenuEvent(QContextMenuEvent *event) override
void keyPressEvent(QKeyEvent *event) override
void setMessageBar(QgsMessageBar *messageBar)
Set the message bar to display messages from the layer tree.
void addIndicator(QgsLayerTreeNode *node, QgsLayerTreeViewIndicator *indicator)
Adds an indicator to the given layer tree node.
void modelRowsInserted(const QModelIndex &index, int start, int end)
QList< QgsLayerTreeNode * > selectedNodes(bool skipInternal=false) const
Returns list of selected nodes.
void setLayerMarkWidth(int width)
Set width of contextual menu mark, at right of layer node items.
QModelIndex node2index(QgsLayerTreeNode *node) const
Returns proxy model index for a given node.
void setCurrentLayer(QgsMapLayer *layer)
Sets the currently selected layer.
void setShowPrivateLayers(bool showPrivate)
Set the show private layers to showPrivate.
QgsLayerTreeNode * currentNode() const
Gets current node. May be nullptr.
~QgsLayerTreeView() override
QgsLayerTreeGroup * currentGroupNode() const
Gets current group node. If a layer is current node, the function will return parent group....
QgsLayerTreeViewDefaultActions * mDefaultActions
helper class with default actions. Lazily initialized.
QList< QgsMapLayer * > selectedLayers() const
Gets list of selected layers.
QModelIndex legendNode2sourceIndex(QgsLayerTreeModelLegendNode *legendNode)
Returns index for a given legend node.
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.
Base class for all map layer types.
QgsMapLayer::LayerFlags flags() const
Returns the flags for this layer.
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
A bar for displaying non-blocking messages to the user.
void pushMessage(const QString &text, Qgis::MessageLevel level=Qgis::Info, int duration=-1)
A convenience method for pushing a message with the specified text to the bar.
QgsLayerTreeModelLegendNode * legendNode(const QString &rule, QgsLayerTreeModel &model)