Class: QgsLayerTreeView¶
- class qgis.gui.QgsLayerTreeView¶
Bases:
PyQt5.QtWidgets.QTreeView
The
QgsLayerTreeView
class extends QTreeView and provides some additional functionality when working with a layer tree.The view updates expanded state of layer tree nodes and also listens to changes to expanded states in the layer tree.
The view keeps track of the current layer and emits a signal when the current layer has changed.
Allows the client to specify a context menu provider with custom actions. Also it comes with a set of default actions that can be used when building context menu.
See also
New in version 2.4.
QgsLayerTreeView(parent: QWidget = None) Constructor for QgsLayerTreeView
Methods
Adds an indicator to the given layer tree node.
Enhancement of QTreeView.collapseAll() that also records expanded state in layer tree nodes
columnCountChanged
columnResized
- param event
currentChanged
Gets current group node.
Returns the currently selected layer, or
None
if no layers is selected.Gets current legend node.
Gets current node.
Gets access to the default actions that may be used with the tree view
- param event
Enhancement of QTreeView.expandAll() that also records expanded state in layer tree nodes
Returns legend node for given proxy model tree
index
.Returns layer tree node for given proxy model tree
index
.Returns list of indicators associated with a particular layer tree node.
- param event
- param index
Returns width of contextual menu mark, at right of layer node items.
Gets access to the model casted to
QgsLayerTreeModel
Returns proxy model index for a given legend node.
Returns index for a given legend node.
Returns pointer to the context menu provider.
- param index
- param event
Returns proxy model index for a given node.
Returns source model index for a given node.
- param node
Returns the proxy model used by the view.
Force refresh of layer symbology.
Removes a previously added indicator to a layer tree node.
- param event
rowsAboutToBeRemoved
rowsInserted
rowsRemoved
scrollContentsBy
scrollDirtyRegion
Returns list of selected nodes filtered to just layer nodes
Gets list of selected layers
Gets list of selected layers, including those that are not directly selected, but their ancestor groups is selected.
Returns list of selected nodes
selectionChanged
Sets the currently selected
layer
.Set width of contextual menu mark, at right of layer node items.
Convenience methods which sets the visible state of the specified map
layer
.Sets provider for context menu.
Set the message bar to display messages from the layer tree
Overridden
setModel()
from base class.Set the show private layers to
showPrivate
Returns the show private layers status
- param node
- param index
Signals
Emitted when a current layer is changed [signal]
- actionEvent(self, QActionEvent)¶
- addIndicator(self, node: QgsLayerTreeNode, indicator: QgsLayerTreeViewIndicator)¶
Adds an indicator to the given layer tree node. Indicators are icons shown next to layer/group names in the layer tree view. They can be used to show extra information with tree nodes and they allow user interaction.
Does not take ownership of the indicator. One indicator object may be used for multiple layer tree nodes.
See also
See also
New in version 3.2.
- Parameters
node (QgsLayerTreeNode) –
indicator (QgsLayerTreeViewIndicator) –
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEditor(self, QWidget, QAbstractItemDelegate.EndEditHint)¶
- closeEvent(self, QCloseEvent)¶
- collapseAllNodes(self)¶
Enhancement of QTreeView.collapseAll() that also records expanded state in layer tree nodes
New in version 2.18.
- QgsLayerTreeView.columnCountChanged(self, int, int)
- columnMoved(self)¶
- QgsLayerTreeView.columnResized(self, int, int, int)
- commitData(self, QWidget)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, event: QContextMenuEvent)¶
- Parameters
event (QContextMenuEvent) –
- create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- QgsLayerTreeView.currentChanged(self, QModelIndex, QModelIndex)
- currentGroupNode(self) QgsLayerTreeGroup ¶
Gets current group node. If a layer is current node, the function will return parent group. May be
None
.- Return type
- currentLayer(self) QgsMapLayer ¶
Returns the currently selected layer, or
None
if no layers is selected.See also
- Return type
- currentLayerChanged¶
Emitted when a current layer is changed [signal]
- Parameters
layer (QgsMapLayer) –
- currentLegendNode(self) QgsLayerTreeModelLegendNode ¶
Gets current legend node. May be
None
if current node is not a legend node.New in version 2.14.
- Return type
- currentNode(self) QgsLayerTreeNode ¶
Gets current node. May be
None
- Return type
- customEvent(self, QEvent)¶
- defaultActions(self) QgsLayerTreeViewDefaultActions ¶
Gets access to the default actions that may be used with the tree view
- Return type
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- dirtyRegionOffset(self) QPoint ¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- drawBranches(self, QPainter, QRect, QModelIndex)¶
- drawFrame(self, QPainter)¶
- drawRow(self, QPainter, QStyleOptionViewItem, QModelIndex)¶
- drawTree(self, QPainter, QRegion)¶
- dropEvent(self, event: QDropEvent)¶
- Parameters
event (QDropEvent) –
- dropIndicatorPosition(self) QAbstractItemView.DropIndicatorPosition ¶
- edit(self, QModelIndex)¶
- edit(self, QModelIndex, QAbstractItemView.EditTrigger, QEvent) bool
- editorDestroyed(self, QObject)¶
- enterEvent(self, QEvent)¶
- event(self, QEvent) bool ¶
- eventFilter(self, QObject, QEvent) bool ¶
- executeDelayedItemsLayout(self)¶
- expandAllNodes(self)¶
Enhancement of QTreeView.expandAll() that also records expanded state in layer tree nodes
New in version 2.18.
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hideEvent(self, QHideEvent)¶
- horizontalOffset(self) int ¶
- horizontalScrollbarAction(self, int)¶
- horizontalScrollbarValueChanged(self, int)¶
- index2legendNode(self, index: QModelIndex) QgsLayerTreeModelLegendNode ¶
Returns legend node for given proxy model tree
index
. ReturnsNone
for invalid indexUnlike
QgsLayerTreeModel.index2legendNode()
, calling this method correctly accounts for mapping the view indexes through the view’s proxy model to the source model.New in version 3.18.
- Parameters
index (QModelIndex) –
- Return type
- index2node(self, index: QModelIndex) QgsLayerTreeNode ¶
Returns layer tree node for given proxy model tree
index
. Returns root node for invalid index. ReturnsNone
if index does not refer to a layer tree node (e.g. it is a legend node)Unlike
QgsLayerTreeModel.index2Node()
, calling this method correctly accounts for mapping the view indexes through the view’s proxy model to the source model.New in version 3.18.
- Parameters
index (QModelIndex) –
- Return type
- indexRowSizeHint(self, QModelIndex) int ¶
- indicators(self, node: QgsLayerTreeNode) List[QgsLayerTreeViewIndicator] ¶
Returns list of indicators associated with a particular layer tree node.
See also
See also
New in version 3.2.
- Parameters
node (QgsLayerTreeNode) –
- Return type
- initPainter(self, QPainter)¶
- initStyleOption(self, QStyleOptionFrame)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- isIndexHidden(self, QModelIndex) bool ¶
- isSignalConnected(self, QMetaMethod) bool ¶
- keyPressEvent(self, event: QKeyEvent)¶
- Parameters
event (QKeyEvent) –
- keyReleaseEvent(self, QKeyEvent)¶
- layerForIndex(self, index: QModelIndex) QgsMapLayer ¶
- Parameters
index (QModelIndex) –
- Return type
- layerMarkWidth(self) int ¶
Returns width of contextual menu mark, at right of layer node items.
See also
New in version 3.8.
- Return type
int
- layerTreeModel(self) QgsLayerTreeModel ¶
Gets access to the model casted to
QgsLayerTreeModel
- Return type
- leaveEvent(self, QEvent)¶
- legendNode2index(self, legendNode: QgsLayerTreeModelLegendNode) QModelIndex ¶
Returns proxy model 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.
Unlike
QgsLayerTreeModel.legendNode2index()
, calling this method correctly accounts for mapping the view indexes through the view’s proxy model to the source model.New in version 3.18.
- Parameters
legendNode (QgsLayerTreeModelLegendNode) –
- Return type
QModelIndex
- legendNode2sourceIndex(self, legendNode: QgsLayerTreeModelLegendNode) QModelIndex ¶
Returns 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.
New in version 3.18.
- Parameters
legendNode (QgsLayerTreeModelLegendNode) –
- Return type
QModelIndex
Returns pointer to the context menu provider. May be
None
- Return type
- metric(self, QPaintDevice.PaintDeviceMetric) int ¶
- modelRowsInserted(self, index: QModelIndex, start: int, end: int)¶
- Parameters
index (QModelIndex) –
start (int) –
end (int) –
- modelRowsRemoved(self)¶
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, QMouseEvent)¶
- mousePressEvent(self, QMouseEvent)¶
- mouseReleaseEvent(self, event: QMouseEvent)¶
- Parameters
event (QMouseEvent) –
- moveCursor(self, QAbstractItemView.CursorAction, Union[Qt.KeyboardModifiers, Qt.KeyboardModifier]) QModelIndex ¶
- moveEvent(self, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) Tuple[bool, int] ¶
- node2index(self, node: QgsLayerTreeNode) QModelIndex ¶
Returns proxy model index for a given node. If the node does not belong to the layer tree, the result is undefined
Unlike
QgsLayerTreeModel.node2index()
, calling this method correctly accounts for mapping the view indexes through the view’s proxy model to the source model.New in version 3.18.
- Parameters
node (QgsLayerTreeNode) –
- Return type
QModelIndex
- node2sourceIndex(self, node: QgsLayerTreeNode) QModelIndex ¶
Returns source model index for a given node. If the node does not belong to the layer tree, the result is undefined
New in version 3.18.
- Parameters
node (QgsLayerTreeNode) –
- Return type
QModelIndex
- onCurrentChanged(self)¶
- onExpandedChanged(self, node: QgsLayerTreeNode, expanded: bool)¶
- Parameters
node (QgsLayerTreeNode) –
expanded (bool) –
- onModelReset(self)¶
- paintEvent(self, QPaintEvent)¶
- proxyModel(self) QgsLayerTreeProxyModel ¶
Returns the proxy model used by the view.
This can be used to set filters controlling which layers are shown in the view.
New in version 3.18.
- Return type
- receivers(self, PYQT_SIGNAL) int ¶
- reexpand(self)¶
- refreshLayerSymbology(self, layerId: str)¶
Force refresh of layer symbology. Normally not needed as the changes of layer’s renderer are monitored by the model
- Parameters
layerId (str) –
- removeIndicator(self, node: QgsLayerTreeNode, indicator: QgsLayerTreeViewIndicator)¶
Removes a previously added indicator to a layer tree node. Does not delete the indicator.
See also
See also
New in version 3.2.
- Parameters
node (QgsLayerTreeNode) –
indicator (QgsLayerTreeViewIndicator) –
- resizeEvent(self, event: QResizeEvent)¶
- Parameters
event (QResizeEvent) –
- rowHeight(self, QModelIndex) int ¶
- QgsLayerTreeView.rowsAboutToBeRemoved(self, QModelIndex, int, int)
- QgsLayerTreeView.rowsInserted(self, QModelIndex, int, int)
- QgsLayerTreeView.rowsRemoved(self, QModelIndex, int, int)
- scheduleDelayedItemsLayout(self)¶
- QgsLayerTreeView.scrollContentsBy(self, int, int)
- QgsLayerTreeView.scrollDirtyRegion(self, int, int)
- selectedIndexes(self) List[QModelIndex] ¶
- selectedLayerNodes(self) List[QgsLayerTreeLayer] ¶
Returns list of selected nodes filtered to just layer nodes
- Return type
List[QgsLayerTreeLayer]
- selectedLayers(self) List[QgsMapLayer] ¶
Gets list of selected layers
- Return type
List[QgsMapLayer]
- selectedLayersRecursive(self) List[QgsMapLayer] ¶
Gets list of selected layers, including those that are not directly selected, but their ancestor groups is selected. If we have a group with two layers L1, L2 and just the group node is selected, this method returns L1 and L2, while
selectedLayers()
returns an empty list.New in version 3.4.
- Return type
List[QgsMapLayer]
- selectedNodes(self, skipInternal: bool = False) List[QgsLayerTreeNode] ¶
Returns list of selected nodes
- Parameters
skipInternal (bool = False) – If
True
, will ignore nodes which have an ancestor in the selection- Return type
List[QgsLayerTreeNode]
- QgsLayerTreeView.selectionChanged(self, QItemSelection, QItemSelection)
- selectionCommand(self, QModelIndex, event: QEvent = None) QItemSelectionModel.SelectionFlags ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setCurrentLayer(self, layer: QgsMapLayer)¶
Sets the currently selected
layer
.If
layer
isNone
then all layers will be deselected.See also
- Parameters
layer (QgsMapLayer) –
- setDirtyRegion(self, QRegion)¶
- setLayerMarkWidth(self, width: int)¶
Set width of contextual menu mark, at right of layer node items.
See also
New in version 3.8.
- Parameters
width (int) –
- setLayerVisible(self, layer: QgsMapLayer, visible: bool)¶
Convenience methods which sets the visible state of the specified map
layer
.See also
QgsLayerTreeNode.setItemVisibilityChecked()
New in version 3.10.
- Parameters
layer (QgsMapLayer) –
visible (bool) –
- setMenuProvider(self, menuProvider: QgsLayerTreeViewMenuProvider)¶
Sets provider for context menu. Takes ownership of the instance
- Parameters
menuProvider (QgsLayerTreeViewMenuProvider) –
- setMessageBar(self, messageBar: QgsMessageBar)¶
Set the message bar to display messages from the layer tree
New in version 3.14.
- Parameters
messageBar (QgsMessageBar) –
- setModel(self, model: QAbstractItemModel)¶
Overridden
setModel()
from base class. OnlyQgsLayerTreeModel
is an acceptable model.- Parameters
model (QAbstractItemModel) –
- setSelection(self, QRect, Union[QItemSelectionModel.SelectionFlags, QItemSelectionModel.SelectionFlag])¶
- setShowPrivateLayers(self, showPrivate: bool)¶
Set the show private layers to
showPrivate
New in version 3.18.
- Parameters
showPrivate (bool) –
- setState(self, QAbstractItemView.State)¶
- QgsLayerTreeView.setViewportMargins(self, int, int, int, int)
- setViewportMargins(self, QMargins) None ¶
- showEvent(self, QShowEvent)¶
- showPrivateLayers(self) bool ¶
Returns the show private layers status
New in version 3.18.
- Return type
bool
- sizeHintForColumn(self, int) int ¶
- startDrag(self, Union[Qt.DropActions, Qt.DropAction])¶
- state(self) QAbstractItemView.State ¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateEditorData(self)¶
- updateEditorGeometries(self)¶
- updateExpandedStateFromNode(self, node: QgsLayerTreeNode)¶
- Parameters
node (QgsLayerTreeNode) –
- updateExpandedStateToNode(self, index: QModelIndex)¶
- Parameters
index (QModelIndex) –
- updateGeometries(self)¶
- updateMicroFocus(self)¶
- verticalOffset(self) int ¶
- verticalScrollbarAction(self, int)¶
- verticalScrollbarValueChanged(self, int)¶
- viewOptions(self) QStyleOptionViewItem ¶
- viewportEvent(self, QEvent) bool ¶
- viewportMargins(self) QMargins ¶
- viewportSizeHint(self) QSize ¶
- visualRegionForSelection(self, QItemSelection) QRegion ¶
- wheelEvent(self, QWheelEvent)¶