Provides a table view of features of a QgsVectorLayer. More...

#include <qgsattributetableview.h>

Inheritance diagram for QgsAttributeTableView:

Public Slots
virtual void	_q_selectRow (int row)

void	repaintRequested ()

void	repaintRequested (const QModelIndexList &indexes)

void	selectAll () override

virtual void	selectRow (int row)

Signals
void	columnResized (int column, int width)
	Emitted when a column in the view has been resized. More...

void	finished ()

void	willShowContextMenu (QMenu *menu, const QModelIndex &atIndex)
	Emitted in order to provide a hook to add additional* menu entries to the context menu. More...

Public Member Functions
	QgsAttributeTableView (QWidget *parent=nullptr)
	Constructor for QgsAttributeTableView. More...

bool	eventFilter (QObject object, QEvent event) override
	This event filter is installed on the verticalHeader to intercept mouse press and release events. More...

void	scrollToFeature (const QgsFeatureId &fid, int column=-1)
	Scroll to a feature with a given fid. More...

QList< QgsFeatureId >	selectedFeaturesIds () const
	Returns the selected features in the attribute table in table sorted order. More...

void	setAttributeTableConfig (const QgsAttributeTableConfig &config)
	Set the attribute table config which should be used to control the appearance of the attribute table. More...

void	setFeatureSelectionManager (QgsIFeatureSelectionManager *featureSelectionManager)
	setFeatureSelectionManager More...

virtual void	setModel (QgsAttributeTableFilterModel *filterModel)

Protected Member Functions
void	closeEvent (QCloseEvent *event) override
	Saves geometry to the settings on close. More...

void	contextMenuEvent (QContextMenuEvent *event) override
	Is called when the context menu will be shown. More...

void	keyPressEvent (QKeyEvent *event) override
	Called for key press events Disables selection change by only pressing an arrow key. More...

void	mouseMoveEvent (QMouseEvent *event) override
	Called for mouse move events on a table cell. More...

void	mousePressEvent (QMouseEvent *event) override
	Called for mouse press events on a table cell. More...

void	mouseReleaseEvent (QMouseEvent *event) override
	Called for mouse release events on a table cell. More...

Detailed Description

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.

Definition at line 48 of file qgsattributetableview.h.

Constructor & Destructor Documentation

◆ QgsAttributeTableView()

QgsAttributeTableView::QgsAttributeTableView ( QWidget * parent = nullptr )

Constructor for QgsAttributeTableView.

Definition at line 41 of file qgsattributetableview.cpp.

Member Function Documentation

◆ _q_selectRow

void QgsAttributeTableView::_q_selectRow ( int row )

virtualslot

Definition at line 427 of file qgsattributetableview.cpp.

◆ closeEvent()

void QgsAttributeTableView::closeEvent ( QCloseEvent * event )

overrideprotected

Saves geometry to the settings on close.

Parameters

event not used

Definition at line 308 of file qgsattributetableview.cpp.

◆ columnResized

void QgsAttributeTableView::columnResized	(	int	column,
		int	width
	)

signal

Emitted when a column in the view has been resized.

Parameters

column	column index (starts at 0)
width	new width in pixel

Since: QGIS 2.16

◆ contextMenuEvent()

void QgsAttributeTableView::contextMenuEvent ( QContextMenuEvent * event )

overrideprotected

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.

Definition at line 392 of file qgsattributetableview.cpp.

◆ eventFilter()

bool QgsAttributeTableView::eventFilter	(	QObject *	object,
		QEvent *	event
	)

override

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

Definition at line 72 of file qgsattributetableview.cpp.

◆ finished

void QgsAttributeTableView::finished ( )

signal

◆ keyPressEvent()

void QgsAttributeTableView::keyPressEvent ( QKeyEvent * event )

overrideprotected

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

Parameters

event The mouse event

Definition at line 349 of file qgsattributetableview.cpp.

◆ mouseMoveEvent()

void QgsAttributeTableView::mouseMoveEvent ( QMouseEvent * event )

overrideprotected

Called for mouse move events on a table cell.

Disables selection change for these events.

Parameters

event The mouse event

Definition at line 342 of file qgsattributetableview.cpp.

◆ mousePressEvent()

void QgsAttributeTableView::mousePressEvent ( QMouseEvent * event )

overrideprotected

Called for mouse press events on a table cell.

Disables selection change for these events.

Parameters

event The mouse event

Definition at line 315 of file qgsattributetableview.cpp.

◆ mouseReleaseEvent()

void QgsAttributeTableView::mouseReleaseEvent ( QMouseEvent * event )

overrideprotected

Called for mouse release events on a table cell.

Disables selection change for these events.

Parameters

event The mouse event

Definition at line 322 of file qgsattributetableview.cpp.

◆ repaintRequested [1/2]

void QgsAttributeTableView::repaintRequested ( )

slot

Definition at line 380 of file qgsattributetableview.cpp.

◆ repaintRequested [2/2]

void QgsAttributeTableView::repaintRequested ( const QModelIndexList & indexes )

slot

Definition at line 371 of file qgsattributetableview.cpp.

◆ scrollToFeature()

void QgsAttributeTableView::scrollToFeature	(	const QgsFeatureId &	fid,
		int	column = `-1`
	)

Scroll to a feature with a given fid.

Optionally a column can be specified, which will also bring that column into view.

Since: QGIS 3.16

Definition at line 534 of file qgsattributetableview.cpp.

◆ selectAll

void QgsAttributeTableView::selectAll ( )

overrideslot

Definition at line 385 of file qgsattributetableview.cpp.

◆ selectedFeaturesIds()

QList< QgsFeatureId > QgsAttributeTableView::selectedFeaturesIds ( ) const

Returns the selected features in the attribute table in table sorted order.

Returns: The selected features in the attribute table in the order sorted by the table.

Since: QGIS 3.4

Definition at line 135 of file qgsattributetableview.cpp.

◆ selectRow

void QgsAttributeTableView::selectRow ( int row )

virtualslot

Definition at line 422 of file qgsattributetableview.cpp.

◆ setAttributeTableConfig()

void QgsAttributeTableView::setAttributeTableConfig ( const QgsAttributeTableConfig & config )

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

Since: QGIS 2.16

Definition at line 93 of file qgsattributetableview.cpp.

◆ setFeatureSelectionManager()

void QgsAttributeTableView::setFeatureSelectionManager ( QgsIFeatureSelectionManager * featureSelectionManager )

setFeatureSelectionManager

Parameters

featureSelectionManager

Definition at line 194 of file qgsattributetableview.cpp.

◆ setModel()

void QgsAttributeTableView::setModel ( QgsAttributeTableFilterModel * filterModel )

virtual

Definition at line 158 of file qgsattributetableview.cpp.

◆ willShowContextMenu

void QgsAttributeTableView::willShowContextMenu	(	QMenu *	menu,
		const QModelIndex &	atIndex
	)

signal

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

The documentation for this class was generated from the following files:

/build/qgis-3.24.2+99sid/src/gui/attributetable/qgsattributetableview.h
/build/qgis-3.24.2+99sid/src/gui/attributetable/qgsattributetableview.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsAttributeTableView()

Member Function Documentation

◆ _q_selectRow

◆ closeEvent()

◆ columnResized

◆ contextMenuEvent()

◆ eventFilter()

◆ finished

◆ keyPressEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ repaintRequested [1/2]

◆ repaintRequested [2/2]

◆ scrollToFeature()

◆ selectAll

◆ selectedFeaturesIds()

◆ selectRow

◆ setAttributeTableConfig()

◆ setFeatureSelectionManager()

◆ setModel()

◆ willShowContextMenu