Subgroup: Feature

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.

Methods

acceptDrops
accessibleDescription
accessibleName
actionEvent
actions
activateWindow
addAction
addActions
addScrollBarWidget
adjustSize
alternatingRowColors
autoFillBackground
autoScrollMargin
backgroundRole
baseSize
batchSize
blockSignals
changeEvent
childAt	childAt(self, int, int) -> QWidget
childEvent
children
childrenRect
childrenRegion
clearFocus
clearMask
clearPropertyFlags
clearSelection
close
closeEditor
closeEvent
closePersistentEditor
colorCount
commitData
connectNotify
contentsMargins
contentsRect
contextMenuEvent
contextMenuPolicy
cornerWidget
create
createWindowContainer
currentChanged
currentEditSelection	Get the currentEditSelection
currentIndex
cursor
customEvent
dataChanged
defaultDropAction
deleteLater
depth
destroy
devType
devicePixelRatio
devicePixelRatioF
devicePixelRatioFScale
dirtyRegionOffset
disconnect
disconnectNotify
displayExpression	Returns the expression which is currently used to render the features.
dragDropMode
dragDropOverwriteMode
dragEnabled
dragEnterEvent
dragLeaveEvent
dragMoveEvent
drawFrame
dropEvent
dropIndicatorPosition
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
edit
editTriggers
editorDestroyed
effectiveWinId
ensurePolished
enterEvent
event
eventFilter
executeDelayedItemsLayout
featureListModel	Get the featureListModel used by this view
find
findChild	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
findChildren	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
flow
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPolicy
focusPreviousChild
focusProxy
focusWidget
font
fontInfo
fontMetrics
foregroundRole
frameGeometry
frameRect
frameShadow
frameShape
frameSize
frameStyle
frameWidth
geometry
getContentsMargins
grab
grabGesture
grabKeyboard
grabMouse	grabMouse(self, Union[QCursor, Qt.CursorShape])
grabShortcut
graphicsEffect
graphicsProxyWidget
gridSize
hasAutoScroll
hasFocus
hasHeightForWidth
hasMouseTracking
hasTabletTracking
height
heightForWidth
heightMM
hide
hideEvent
horizontalOffset
horizontalScrollBar
horizontalScrollBarPolicy
horizontalScrollMode
horizontalScrollbarAction
horizontalScrollbarValueChanged
iconSize
indexAt
indexWidget
inherits
initPainter
initStyleOption
inputMethodEvent
inputMethodHints
inputMethodQuery
insertAction
insertActions
installEventFilter
isActiveWindow
isAncestorOf
isEnabled
isEnabledTo
isFullScreen
isHidden
isIndexHidden
isLeftToRight
isMaximized
isMinimized
isModal
isRightToLeft
isRowHidden
isSelectionRectVisible
isSignalConnected
isVisible
isVisibleTo
isWidgetType
isWindow
isWindowModified
isWindowType
isWrapping
itemDelegate	itemDelegate(self, QModelIndex) -> QAbstractItemDelegate
itemDelegateForColumn
itemDelegateForRow
keyPressEvent
keyReleaseEvent
keyboardGrabber
keyboardSearch
killTimer
layerCache	Returns the layer cache
layout
layoutDirection
layoutMode
leaveEvent
lineWidth
locale
logicalDpiX
logicalDpiY
lower
mapFrom
mapFromGlobal
mapFromParent
mapTo
mapToGlobal
mapToParent
mask
maximumHeight
maximumSize
maximumViewportSize
maximumWidth
metaObject
metric
midLineWidth
minimumHeight
minimumSize
minimumSizeHint
minimumWidth
model
modelColumn
mouseDoubleClickEvent
mouseGrabber
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
move	move(self, int, int)
moveCursor
moveEvent
moveToThread
movement
nativeEvent
nativeParentWidget
nextInFocusChain
normalGeometry
objectName
openPersistentEditor
overrideWindowFlags
overrideWindowState
paintEngine
paintEvent
paintingActive
palette
parent
parentWidget
parserErrorString	Returns a detailed message about errors while parsing a QgsExpression.
physicalDpiX
physicalDpiY
pos
previousInFocusChain
property
pyqtConfigure	Each keyword argument is either the name of a Qt property or a Qt signal.
raise_
receivers
rect
rectForIndex
releaseKeyboard
releaseMouse
releaseShortcut
removeAction
removeEventFilter
render	render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))
repaint	repaint(self, int, int, int, int)
repaintRequested	repaintRequested(self)
reset
resetHorizontalScrollMode
resetVerticalScrollMode
resize	resize(self, int, int)
resizeEvent
resizeMode
restoreGeometry
rootIndex
rowsAboutToBeRemoved
rowsInserted
saveGeometry
scheduleDelayedItemsLayout
scroll	scroll(self, int, int, QRect)
scrollBarWidgets
scrollContentsBy
scrollDirtyRegion
scrollTo
scrollToBottom
scrollToTop
selectAll	Select all currently visible features
selectedIndexes
selectionBehavior
selectionChanged
selectionCommand
selectionMode
selectionModel
sender
senderSignalIndex
setAcceptDrops
setAccessibleDescription
setAccessibleName
setAlternatingRowColors
setAttribute
setAutoFillBackground
setAutoScroll
setAutoScrollMargin
setBackgroundRole
setBaseSize	setBaseSize(self, QSize)
setBatchSize
setContentsMargins	setContentsMargins(self, QMargins)
setContextMenuPolicy
setCornerWidget
setCurrentFeatureEdited	Sets if the currently shown form has received any edit events so far.
setCurrentIndex
setCursor
setDefaultDropAction
setDirtyRegion
setDisabled
setDisplayExpression	The display expression is an expression used to render the fields into a single string which is displaied.
setDragDropMode
setDragDropOverwriteMode
setDragEnabled
setDropIndicatorShown
setEditSelection	Set the feature(s) to be edited
setEditTriggers
setEnabled
setFeatureSelectionManager	setFeatureSelectionManager
setFixedHeight
setFixedSize	setFixedSize(self, int, int)
setFixedWidth
setFlow
setFocus	setFocus(self, Qt.FocusReason)
setFocusPolicy
setFocusProxy
setFont
setForegroundRole
setFrameRect
setFrameShadow
setFrameShape
setFrameStyle
setGeometry	setGeometry(self, int, int, int, int)
setGraphicsEffect
setGridSize
setHidden
setHorizontalScrollBar
setHorizontalScrollBarPolicy
setHorizontalScrollMode
setIconSize
setIndexWidget
setInputMethodHints
setItemDelegate
setItemDelegateForColumn
setItemDelegateForRow
setLayout
setLayoutDirection
setLayoutMode
setLineWidth
setLocale
setMask	setMask(self, QRegion)
setMaximumHeight
setMaximumSize	setMaximumSize(self, QSize)
setMaximumWidth
setMidLineWidth
setMinimumHeight
setMinimumSize	setMinimumSize(self, QSize)
setMinimumWidth
setModel	Set the QgsFeatureListModel which is used to retrieve information
setModelColumn
setMouseTracking
setMovement
setObjectName
setPalette
setParent	setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
setPositionForIndex
setProperty
setResizeMode
setRootIndex
setRowHidden
setSelection
setSelectionBehavior
setSelectionMode
setSelectionModel
setSelectionRectVisible
setShortcutAutoRepeat
setShortcutEnabled
setSizeAdjustPolicy
setSizeIncrement	setSizeIncrement(self, QSize)
setSizePolicy	setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
setSpacing
setState
setStatusTip
setStyle
setStyleSheet
setTabKeyNavigation
setTabOrder
setTabletTracking
setTextElideMode
setToolTip
setToolTipDuration
setUniformItemSizes
setUpdatesEnabled
setVerticalScrollBar
setVerticalScrollBarPolicy
setVerticalScrollMode
setViewMode
setViewport
setViewportMargins
setVisible
setWhatsThis
setWindowFilePath
setWindowFlag
setWindowFlags
setWindowIcon
setWindowIconText
setWindowModality
setWindowModified
setWindowOpacity
setWindowRole
setWindowState
setWindowTitle
setWordWrap
setWrapping
setupViewport
sharedPainter
show
showDropIndicator
showEvent
showFullScreen
showMaximized
showMinimized
showNormal
signalsBlocked
size
sizeAdjustPolicy
sizeHint
sizeHintForColumn
sizeHintForIndex
sizeHintForRow
sizeIncrement
sizePolicy
spacing
stackUnder
startDrag
startTimer
state
statusTip
style
styleSheet
tabKeyNavigation
tabletEvent
testAttribute
textElideMode
thread
timerEvent
toolTip
toolTipDuration
tr
underMouse
ungrabGesture
uniformItemSizes
unsetCursor
unsetLayoutDirection
unsetLocale
update	update(self, QModelIndex)
updateEditorData
updateEditorGeometries
updateGeometries
updateGeometry
updateMicroFocus
updatesEnabled
verticalOffset
verticalScrollBar
verticalScrollBarPolicy
verticalScrollMode
verticalScrollbarAction
verticalScrollbarValueChanged
viewMode
viewOptions
viewport
viewportEvent
viewportMargins
viewportSizeHint
visibleRegion
visualRect
visualRegionForSelection
whatsThis
wheelEvent
width
widthMM
winId
window
windowFilePath
windowFlags
windowHandle
windowIcon
windowIconText
windowModality
windowOpacity
windowRole
windowState
windowTitle
windowType
wordWrap
x
y

Attributes

AboveItem
Adjust
AdjustIgnored
AdjustToContents
AdjustToContentsOnFirstShow
AllEditTriggers
AnimatingState
AnyKeyPressed
Batched
BelowItem
Box
CollapsingState
ContiguousSelection
CurrentChanged
DoubleClicked
DragDrop
DragOnly
DragSelectingState
DraggingState
DrawChildren
DrawWindowBackground
DropOnly
EditKeyPressed
EditingState
EnsureVisible
ExpandingState
ExtendedSelection
Fixed
Free
HLine
IconMode
IgnoreMask
InternalMove
LeftToRight
ListMode
MoveDown
MoveEnd
MoveHome
MoveLeft
MoveNext
MovePageDown
MovePageUp
MovePrevious
MoveRight
MoveUp
MultiSelection
NoDragDrop
NoEditTriggers
NoFrame
NoSelection
NoState
OnItem
OnViewport
Panel
PdmDepth
PdmDevicePixelRatio
PdmDevicePixelRatioScaled
PdmDpiX
PdmDpiY
PdmHeight
PdmHeightMM
PdmNumColors
PdmPhysicalDpiX
PdmPhysicalDpiY
PdmWidth
PdmWidthMM
Plain
PositionAtBottom
PositionAtCenter
PositionAtTop
Raised
ScrollPerItem
ScrollPerPixel
SelectColumns
SelectItems
SelectRows
SelectedClicked
Shadow_Mask
Shape_Mask
SinglePass
SingleSelection
Snap
Static
StyledPanel
Sunken
TopToBottom
VLine
WinPanel
activated	activated(self, QModelIndex) [signal]
clicked	clicked(self, QModelIndex) [signal]
currentEditSelectionChanged	Is emitted, whenever the current edit selection has been changed.
customContextMenuRequested	customContextMenuRequested(self, QPoint) [signal]
destroyed	destroyed(self, QObject = None) [signal]
displayExpressionChanged	Is emitted, whenever the display expression is successfully changed
doubleClicked	doubleClicked(self, QModelIndex) [signal]
entered	entered(self, QModelIndex) [signal]
iconSizeChanged	iconSizeChanged(self, QSize) [signal]
indexesMoved	indexesMoved(self, object) [signal]
objectNameChanged	objectNameChanged(self, str) [signal]
pressed	pressed(self, QModelIndex) [signal]
staticMetaObject
viewportEntered	viewportEntered(self) [signal]
willShowContextMenu	Is emitted, when the context menu is created to add the specific actions to it
windowIconChanged	windowIconChanged(self, QIcon) [signal]
windowIconTextChanged	windowIconTextChanged(self, str) [signal]
windowTitleChanged	windowTitleChanged(self, str) [signal]

actionEvent()

changeEvent()

childEvent()

closeEditor()

closeEvent()

commitData()

connectNotify()

contextMenuEvent(self, event: QContextMenuEvent)

create()

currentChanged()

currentEditSelection(self) → object

Get 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

Get 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]