Class: QgsFeatureListView¶

class qgis.gui.QgsFeatureListView¶

Bases: PyQt5.QtWidgets.QListView

Shows a list of features and renders a edit button next to each feature.

Accepts a display expression to define the way, features are rendered. Uses a QgsFeatureListModel as source model.

QgsFeatureListView(parent: QWidget = None) Creates a feature list view

Parameters

parent –

owner

Methods

`actionEvent`
`changeEvent`
`childEvent`
`closeEditor`
`closeEvent`
`commitData`
`connectNotify`
`contextMenuEvent`	param event
`create`
`currentChanged`
`currentEditSelection`	Gets the currentEditSelection
`customEvent`
`dataChanged`
`destroy`
`dirtyRegionOffset`
`disconnectNotify`
`displayExpression`	Returns the expression which is currently used to render the features.
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`drawFrame`
`dropEvent`
`dropIndicatorPosition`
`edit`
`editFirstFeature`	editFirstFeature will try to edit the first feature of the list
`editLastFeature`	editLastFeature will try to edit the last feature of the list
`editNextFeature`	editNextFeature will try to edit next feature of the list
`editPreviousFeature`	editPreviousFeature will try to edit previous feature of the list
`editorDestroyed`
`enterEvent`
`event`
`eventFilter`
`executeDelayedItemsLayout`
`featureListModel`	Gets the featureListModel used by this view
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`hideEvent`
`horizontalOffset`
`horizontalScrollbarAction`
`horizontalScrollbarValueChanged`
`initPainter`
`initStyleOption`
`inputMethodEvent`
`isIndexHidden`
`isSignalConnected`
`keyPressEvent`	param event
`keyReleaseEvent`
`layerCache`	Returns the layer cache
`leaveEvent`
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`	param event
`mousePressEvent`	param event
`mouseReleaseEvent`	param event
`moveCursor`
`moveEvent`
`nativeEvent`
`paintEvent`
`parserErrorString`	Returns a detailed message about errors while parsing a `QgsExpression`.
`receivers`
`rectForIndex`
`repaintRequested`	param indexes
`resizeEvent`
`rowsAboutToBeRemoved`
`rowsInserted`
`scheduleDelayedItemsLayout`
`scrollContentsBy`
`scrollDirtyRegion`
`selectAll`	Select all currently visible features
`selectedIndexes`
`selectionChanged`
`selectionCommand`
`sender`
`senderSignalIndex`
`setCurrentFeatureEdited`	Sets if the currently shown form has received any edit events so far.
`setDirtyRegion`
`setDisplayExpression`	The display expression is an expression used to render the fields into a single string which is displaied.
`setEditSelection`	Set the feature(s) to be edited
`setFeatureSelectionManager`	type featureSelectionManager QgsIFeatureSelectionManager
`setModel`	Set the `QgsFeatureListModel` which is used to retrieve information
`setPositionForIndex`
`setSelection`
`setState`
`setViewportMargins`
`sharedPainter`
`showEvent`
`startDrag`
`state`
`tabletEvent`
`timerEvent`
`updateEditorData`
`updateEditorGeometries`
`updateGeometries`
`updateMicroFocus`
`verticalOffset`
`verticalScrollbarAction`
`verticalScrollbarValueChanged`
`viewOptions`
`viewportEvent`
`viewportMargins`
`viewportSizeHint`
`visualRegionForSelection`
`wheelEvent`

Signals

`currentEditSelectionChanged`	Emitted whenever the current edit selection has been changed.
`currentEditSelectionProgressChanged`	Emitted whenever the current edit selection has been changed.
`displayExpressionChanged`	Emitted whenever the display expression is successfully changed
`willShowContextMenu`	Emitted when the context menu is created to add the specific actions to it

actionEvent(self, QActionEvent)¶

changeEvent(self, QEvent)¶

childEvent(self, QChildEvent)¶

closeEditor(self, QWidget, QAbstractItemDelegate.EndEditHint)¶

closeEvent(self, QCloseEvent)¶

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)¶

QgsFeatureListView.currentChanged(self, QModelIndex, QModelIndex)

currentEditSelection(self) → object¶

Gets the currentEditSelection

Return type: object
Returns: A list of edited feature ids

currentEditSelectionChanged¶

Emitted whenever the current edit selection has been changed.

Parameters: feat (QgsFeature) – the feature, which will be edited. [signal]

currentEditSelectionProgressChanged¶

Emitted whenever the current edit selection has been changed.

Parameters

progress (int) – the position of the feature in the list
count (int) – the number of features in the list

New in version 3.8: [signal]

customEvent(self, QEvent)¶

QgsFeatureListView.dataChanged(self, QModelIndex, QModelIndex, roles: Iterable[int] = [])

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶

dirtyRegionOffset(self) → QPoint¶

disconnectNotify(self, QMetaMethod)¶

displayExpression(self) → str¶

Returns the expression which is currently used to render the features.

Return type: str
Returns: A string containing the currend display expression