Subgroup: Attribute

Class: QgsAttributeTableView

class qgis.gui.QgsAttributeTableView

Bases: PyQt5.QtWidgets.QTableView

Provides a table view of features of a QgsVectorLayer.

This can either be used as a standalone widget. QgsBrowser features a reference implementation. Or this can be used within the QgsDualView stacked widget.

Methods

acceptDrops
accessibleDescription
accessibleName
actionEvent
actions
activateWindow
addAction
addActions
addScrollBarWidget
adjustSize
alternatingRowColors
autoFillBackground
autoScrollMargin
backgroundRole
baseSize
blockSignals
changeEvent
childAt childAt(self, int, int) -> QWidget
childEvent
children
childrenRect
childrenRegion
clearFocus
clearMask
clearSelection
clearSpans
close
closeEditor
closeEvent Saves geometry to the settings on close
closePersistentEditor
colorCount
columnAt
columnCountChanged
columnMoved
columnSpan
columnViewportPosition
columnWidth
commitData
connectNotify
contentsMargins
contentsRect
contextMenuEvent Is called when the context menu will be shown.
contextMenuPolicy
cornerWidget
create
createWindowContainer
currentChanged
currentIndex
cursor
customEvent
dataChanged
defaultDropAction
deleteLater
depth
destroy
devType
devicePixelRatio
devicePixelRatioF
devicePixelRatioFScale
dirtyRegionOffset
disconnect
disconnectNotify
dragDropMode
dragDropOverwriteMode
dragEnabled
dragEnterEvent
dragLeaveEvent
dragMoveEvent
drawFrame
dropEvent
dropIndicatorPosition
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
edit
editTriggers
editorDestroyed
effectiveWinId
ensurePolished
enterEvent
event
eventFilter This event filter is installed on the verticalHeader to intercept mouse press and release events.
executeDelayedItemsLayout
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]
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
gridStyle
hasAutoScroll
hasFocus
hasHeightForWidth
hasMouseTracking
hasTabletTracking
height
heightForWidth
heightMM
hide
hideColumn
hideEvent
hideRow
horizontalHeader
horizontalOffset
horizontalScrollBar
horizontalScrollBarPolicy
horizontalScrollMode
horizontalScrollbarAction
horizontalScrollbarValueChanged
iconSize
indexAt
indexWidget
inherits
initPainter
initStyleOption
inputMethodEvent
inputMethodHints
inputMethodQuery
insertAction
insertActions
installEventFilter
isActiveWindow
isAncestorOf
isColumnHidden
isCornerButtonEnabled
isEnabled
isEnabledTo
isFullScreen
isHidden
isIndexHidden
isLeftToRight
isMaximized
isMinimized
isModal
isRightToLeft
isRowHidden
isSignalConnected
isSortingEnabled
isVisible
isVisibleTo
isWidgetType
isWindow
isWindowModified
isWindowType
itemDelegate itemDelegate(self, QModelIndex) -> QAbstractItemDelegate
itemDelegateForColumn
itemDelegateForRow
keyPressEvent Called for key press events
keyReleaseEvent
keyboardGrabber
keyboardSearch
killTimer
layout
layoutDirection
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
mouseDoubleClickEvent
mouseGrabber
mouseMoveEvent Called for mouse move events on a table cell.
mousePressEvent Called for mouse press events on a table cell.
mouseReleaseEvent Called for mouse release events on a table cell.
move move(self, int, int)
moveCursor
moveEvent
moveToThread
nativeEvent
nativeParentWidget
nextInFocusChain
normalGeometry
objectName
openPersistentEditor
overrideWindowFlags
overrideWindowState
paintEngine
paintEvent
paintingActive
palette
parent
parentWidget
physicalDpiX
physicalDpiY
pos
previousInFocusChain
property
pyqtConfigure Each keyword argument is either the name of a Qt property or a Qt signal.
raise_
receivers
rect
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)
resizeColumnToContents
resizeColumnsToContents
resizeEvent
resizeRowToContents
resizeRowsToContents
restoreGeometry
rootIndex
rowAt
rowCountChanged
rowHeight
rowMoved
rowResized
rowSpan
rowViewportPosition
rowsAboutToBeRemoved
rowsInserted
saveGeometry
scheduleDelayedItemsLayout
scroll scroll(self, int, int, QRect)
scrollBarWidgets
scrollContentsBy
scrollDirtyRegion
scrollTo
scrollToBottom
scrollToTop
selectAll
selectColumn
selectRow
selectedIndexes
selectionBehavior
selectionChanged
selectionCommand
selectionMode
selectionModel
sender
senderSignalIndex
setAcceptDrops
setAccessibleDescription
setAccessibleName
setAlternatingRowColors
setAttribute
setAttributeTableConfig Set the attribute table config which should be used to control the appearance of the attribute table.
setAutoFillBackground
setAutoScroll
setAutoScrollMargin
setBackgroundRole
setBaseSize setBaseSize(self, QSize)
setColumnHidden
setColumnWidth
setContentsMargins setContentsMargins(self, QMargins)
setContextMenuPolicy
setCornerButtonEnabled
setCornerWidget
setCurrentIndex
setCursor
setDefaultDropAction
setDirtyRegion
setDisabled
setDragDropMode
setDragDropOverwriteMode
setDragEnabled
setDropIndicatorShown
setEditTriggers
setEnabled
setFeatureSelectionManager setFeatureSelectionManager
setFixedHeight
setFixedSize setFixedSize(self, int, int)
setFixedWidth
setFocus setFocus(self, Qt.FocusReason)
setFocusPolicy
setFocusProxy
setFont
setForegroundRole
setFrameRect
setFrameShadow
setFrameShape
setFrameStyle
setGeometry setGeometry(self, int, int, int, int)
setGraphicsEffect
setGridStyle
setHidden
setHorizontalHeader
setHorizontalScrollBar
setHorizontalScrollBarPolicy
setHorizontalScrollMode
setIconSize
setIndexWidget
setInputMethodHints
setItemDelegate
setItemDelegateForColumn
setItemDelegateForRow
setLayout
setLayoutDirection
setLineWidth
setLocale
setMask setMask(self, QRegion)
setMaximumHeight
setMaximumSize setMaximumSize(self, QSize)
setMaximumWidth
setMidLineWidth
setMinimumHeight
setMinimumSize setMinimumSize(self, QSize)
setMinimumWidth
setModel
setMouseTracking
setObjectName
setPalette
setParent setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
setProperty
setRootIndex
setRowHeight
setRowHidden
setSelection
setSelectionBehavior
setSelectionMode
setSelectionModel
setShortcutAutoRepeat
setShortcutEnabled
setShowGrid
setSizeAdjustPolicy
setSizeIncrement setSizeIncrement(self, QSize)
setSizePolicy setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
setSortingEnabled
setSpan
setState
setStatusTip
setStyle
setStyleSheet
setTabKeyNavigation
setTabOrder
setTabletTracking
setTextElideMode
setToolTip
setToolTipDuration
setUpdatesEnabled
setVerticalHeader
setVerticalScrollBar
setVerticalScrollBarPolicy
setVerticalScrollMode
setViewport
setViewportMargins
setVisible
setWhatsThis
setWindowFilePath
setWindowFlag
setWindowFlags
setWindowIcon
setWindowIconText
setWindowModality
setWindowModified
setWindowOpacity
setWindowRole
setWindowState
setWindowTitle
setWordWrap
setupViewport
sharedPainter
show
showColumn
showDropIndicator
showEvent
showFullScreen
showGrid
showMaximized
showMinimized
showNormal
showRow
signalsBlocked
size
sizeAdjustPolicy
sizeHint
sizeHintForColumn
sizeHintForIndex
sizeHintForRow
sizeIncrement
sizePolicy
sortByColumn
stackUnder
startDrag
startTimer
state
statusTip
style
styleSheet
tabKeyNavigation
tabletEvent
testAttribute
textElideMode
thread
timerEvent
toolTip
toolTipDuration
tr
underMouse
ungrabGesture
unsetCursor
unsetLayoutDirection
unsetLocale
update update(self, QModelIndex)
updateEditorData
updateEditorGeometries
updateGeometries
updateGeometry
updateMicroFocus
updatesEnabled
verticalHeader
verticalOffset
verticalScrollBar
verticalScrollBarPolicy
verticalScrollMode
verticalScrollbarAction
verticalScrollbarValueChanged
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
AdjustIgnored
AdjustToContents
AdjustToContentsOnFirstShow
AllEditTriggers
AnimatingState
AnyKeyPressed
BelowItem
Box
CollapsingState
ContiguousSelection
CurrentChanged
DoubleClicked
DragDrop
DragOnly
DragSelectingState
DraggingState
DrawChildren
DrawWindowBackground
DropOnly
EditKeyPressed
EditingState
EnsureVisible
ExpandingState
ExtendedSelection
HLine
IgnoreMask
InternalMove
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
SingleSelection
StyledPanel
Sunken
VLine
WinPanel
activated activated(self, QModelIndex) [signal]
clicked clicked(self, QModelIndex) [signal]
columnResized Emitted when a column in the view has been resized.
customContextMenuRequested customContextMenuRequested(self, QPoint) [signal]
destroyed destroyed(self, QObject = None) [signal]
doubleClicked doubleClicked(self, QModelIndex) [signal]
entered entered(self, QModelIndex) [signal]
finished finished(self) [signal]
iconSizeChanged iconSizeChanged(self, QSize) [signal]
objectNameChanged objectNameChanged(self, str) [signal]
pressed pressed(self, QModelIndex) [signal]
staticMetaObject
viewportEntered viewportEntered(self) [signal]
willShowContextMenu Is emitted, in order to provide a hook to add additional* menu entries to the context menu.
windowIconChanged windowIconChanged(self, QIcon) [signal]
windowIconTextChanged windowIconTextChanged(self, str) [signal]
windowTitleChanged windowTitleChanged(self, str) [signal]
actionEvent()
changeEvent()
childEvent()
closeEditor()
closeEvent(self, event: QCloseEvent)

Saves geometry to the settings on close

Parameters:event – not used
columnCountChanged()
columnMoved()
columnResized

Emitted when a column in the view has been resized.

Parameters:
  • column – column index (starts at 0)
  • width – new width in pixel

New in version 2.16: [signal]

commitData()
connectNotify()
contextMenuEvent(self, event: QContextMenuEvent)

Is called when the context menu will be shown. Emits a willShowContextMenu() signal, so the menu can be populated by other parts of the application.

Parameters:event – The associated event object.
create()
currentChanged()
customEvent()
dataChanged()
destroy()
dirtyRegionOffset()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
drawFrame()
dropEvent()
dropIndicatorPosition()
edit()
editorDestroyed()
enterEvent()
event()
eventFilter(self, object: QObject, event: QEvent) → bool

This event filter is installed on the verticalHeader to intercept mouse press and release events. These are used to disable / enable live synchronisation with the map canvas selection which can be slow due to recurring canvas repaints.

Parameters:
  • object – The object which is the target of the event.
  • event – The intercepted event
Returns:

Returns always false, so the event gets processed
executeDelayedItemsLayout()
finished

finished(self) [signal]

focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
horizontalOffset()
horizontalScrollbarAction()
horizontalScrollbarValueChanged()
initPainter()
initStyleOption()
inputMethodEvent()
isIndexHidden()
isSignalConnected()
keyPressEvent(self, event: QKeyEvent)

Called for key press events Disables selection change by only pressing an arrow key

Parameters:event – The mouse event
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent(self, event: QMouseEvent)

Called for mouse move events on a table cell. Disables selection change for these events.

Parameters:event – The mouse event
mousePressEvent(self, event: QMouseEvent)

Called for mouse press events on a table cell. Disables selection change for these events.

Parameters:event – The mouse event
mouseReleaseEvent(self, event: QMouseEvent)

Called for mouse release events on a table cell. Disables selection change for these events.

Parameters:event – The mouse event
moveCursor()
moveEvent()
nativeEvent()
paintEvent()
receivers()
repaintRequested(self, indexes: object)

repaintRequested(self)

resizeEvent()
rowCountChanged()
rowMoved()
rowResized()
rowsAboutToBeRemoved()
rowsInserted()
scheduleDelayedItemsLayout()
scrollContentsBy()
scrollDirtyRegion()
selectAll(self)
selectRow(self, row: int)
selectedIndexes()
selectionChanged()
selectionCommand()
sender()
senderSignalIndex()
setAttributeTableConfig(self, config: QgsAttributeTableConfig)

Set the attribute table config which should be used to control the appearance of the attribute table.

New in version 2.16.

setDirtyRegion()
setFeatureSelectionManager(self, featureSelectionManager: QgsIFeatureSelectionManager)

setFeatureSelectionManager

Parameters:featureSelectionManager – We will take ownership
setModel(self, filterModel: QgsAttributeTableFilterModel)
setSelection()
setState()
setViewportMargins()
sharedPainter()
showEvent()
sizeHintForColumn()
sizeHintForRow()
startDrag()
state()
tabletEvent()
timerEvent()
updateEditorData()
updateEditorGeometries()
updateGeometries()
updateMicroFocus()
verticalOffset()
verticalScrollbarAction()
verticalScrollbarValueChanged()
viewOptions()
viewportEvent()
viewportMargins()
viewportSizeHint()
visualRegionForSelection()
wheelEvent()
willShowContextMenu

Is emitted, in order to provide a hook to add additional* menu entries to the context menu.

Parameters:
  • menu – If additional QMenuItems are added, they will show up in the context menu.
  • atIndex – The QModelIndex, to which the context menu belongs. Relative to the source model.

In most cases, this will be a QgsAttributeTableFilterModel [signal]