Class: QgsFeatureListView

class qgis.gui.QgsFeatureListView(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QListView

Creates a feature list view

Parameters:parent – owner

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.

Methods

actionEvent
changeEvent
childEvent
closeEditor
closeEvent
commitData
connectNotify
contextMenuEvent
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
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
keyReleaseEvent
layerCache Returns the layer cache
leaveEvent
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveCursor
moveEvent
nativeEvent
paintEvent
parserErrorString Returns a detailed message about errors while parsing a QgsExpression.
receivers
rectForIndex
repaintRequested repaintRequested(self)
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 setFeatureSelectionManager
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 Is emitted, whenever the current edit selection has been changed.
displayExpressionChanged Is emitted, whenever the display expression is successfully changed
willShowContextMenu Is emitted, when the context menu is created to add the specific actions to it

Attributes

actionEvent()
changeEvent()
childEvent()
closeEditor()
closeEvent()
commitData()
connectNotify()
contextMenuEvent(self, event: QContextMenuEvent)
create()
currentChanged()
currentEditSelection(self) → object

Gets the currentEditSelection

Returns:A list of edited feature ids
currentEditSelectionChanged

Is emitted, whenever the current edit selection has been changed.

Parameters:feat – the feature, which will be edited. [signal]
customEvent()
dataChanged()
destroy()
dirtyRegionOffset()
disconnectNotify()
displayExpression(self) → str

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

Returns:A string containing the currend display expression

See also

QgsExpression

displayExpressionChanged

Is emitted, whenever the display expression is successfully changed

Parameters:expression – The expression that was applied [signal]
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
drawFrame()
dropEvent()
dropIndicatorPosition()
edit()
editorDestroyed()
enterEvent()
event()
eventFilter()
executeDelayedItemsLayout()
featureListModel(self) → QgsFeatureListModel

Gets the featureListModel used by this view

Returns:The model in use
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
horizontalOffset()
horizontalScrollbarAction()
horizontalScrollbarValueChanged()
initPainter()
initStyleOption()
inputMethodEvent()
isIndexHidden()
isSignalConnected()
keyPressEvent(self, event: QKeyEvent)
keyReleaseEvent()
layerCache(self) → QgsVectorLayerCache

Returns the layer cache

Returns:the layer cache used as backend
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent(self, event: QMouseEvent)
mousePressEvent(self, event: QMouseEvent)
mouseReleaseEvent(self, event: QMouseEvent)
moveCursor()
moveEvent()
nativeEvent()
paintEvent()
parserErrorString(self) → str

Returns a detailed message about errors while parsing a QgsExpression.

Returns:A message containing information about the parser error.
receivers()
rectForIndex()
repaintRequested(self, indexes: object)

repaintRequested(self)

resizeEvent()
rowsAboutToBeRemoved()
rowsInserted()
scheduleDelayedItemsLayout()
scrollContentsBy()
scrollDirtyRegion()
selectAll(self)

Select all currently visible features

selectedIndexes()
selectionChanged()
selectionCommand()
sender()
senderSignalIndex()
setCurrentFeatureEdited(self, state: bool)

Sets if the currently shown form has received any edit events so far.

Parameters:state – The state
setDirtyRegion()
setDisplayExpression(self, displayExpression: str) → bool

The display expression is an expression used to render the fields into a single string which is displaied.

Parameters:displayExpression – The expression used to render the feature

See also

QgsExpression

setEditSelection(self, fids: object)

Set the feature(s) to be edited

Parameters:fids – A list of features to be edited

setEditSelection(self, index: QModelIndex, command: Union[QItemSelectionModel.SelectionFlags, QItemSelectionModel.SelectionFlag]) Set the feature(s) to be edited

Parameters:
  • index – The selection to set
  • command – selection update mode
setFeatureSelectionManager(self, featureSelectionManager: QgsIFeatureSelectionManager)

setFeatureSelectionManager

Parameters:featureSelectionManager – We will take ownership
setModel(self, featureListModel: QgsFeatureListModel)

Set the QgsFeatureListModel which is used to retrieve information

Parameters:featureListModel – The model to use
setPositionForIndex()
setSelection()
setState()
setViewportMargins()
sharedPainter()
showEvent()
startDrag()
state()
tabletEvent()
timerEvent()
updateEditorData()
updateEditorGeometries()
updateGeometries()
updateMicroFocus()
verticalOffset()
verticalScrollbarAction()
verticalScrollbarValueChanged()
viewOptions()
viewportEvent()
viewportMargins()
viewportSizeHint()
visualRegionForSelection()
wheelEvent()
willShowContextMenu

Is emitted, when the context menu is created to add the specific actions to it

Parameters:
  • menu – is the already created context menu
  • atIndex – is the position of the current feature in the model [signal]