A reusable window for editing simple spreadsheet-style tables. More...

#include <qgstableeditordialog.h>

Inheritance diagram for QgsTableEditorDialog:

[legend]

Signals
void	includeHeaderChanged (bool included)
	Emitted whenever the "include table header" setting is changed.

void	tableChanged ()
	Emitted whenever the table contents are changed.

Public Member Functions
	QgsTableEditorDialog (QWidget *parent=nullptr)
	Constructor for QgsTableEditorDialog with the specified parent widget.

bool	includeTableHeader () const
	Returns `true` if the table includes a header row.

QgsMapLayer *	layer () const
	Returns the (possibly `nullptr`) layer associated with the expression editor context.

void	registerExpressionContextGenerator (QgsExpressionContextGenerator *generator)
	Register an expression context generator class that will be used to retrieve an expression context for the editor when required.

void	setIncludeTableHeader (bool included)
	Sets whether the table includes a header row.

void	setLayer (QgsMapLayer *layer)
	Sets the layer to be used associated with the expression editor context.

void	setTable (QgsLayoutItemManualTable *table)
	Sets the table associated with the editor.

void	setTableColumnWidth (int column, double width)
	Sets the configured column width for the specified column.

void	setTableContents (const QgsTableContents &contents)
	Sets the contents to show in the editor widget.

bool	setTableContentsFromClipboard ()
	Parses the clipboard text into contents to show in the editor widget.

void	setTableHeaders (const QVariantList &headers)
	Sets the table headers.

void	setTableRowHeight (int row, double height)
	Sets the configured row height for the specified row.

QgsLayoutItemManualTable *	table () const
	Returns the manual table associated with the editor.

double	tableColumnWidth (int column)
	Returns the configured column width for the specified column, or 0 if an automatic width should be used for the column.

QgsTableContents	tableContents () const
	Returns the current contents of the editor widget table.

QVariantList	tableHeaders () const
	Returns the table header values.

double	tableRowHeight (int row)
	Returns the configured row height for the specified row, or 0 if an automatic height should be used for the row.

Protected Member Functions
void	closeEvent (QCloseEvent *) override

Detailed Description

A reusable window for editing simple spreadsheet-style tables.

Table content is retrieved and set using the QgsTableContents class. The editor has support for table foreground and background colors, and numeric formats.

Since: QGIS 3.12

Definition at line 44 of file qgstableeditordialog.h.

Constructor & Destructor Documentation

◆ QgsTableEditorDialog()

QgsTableEditorDialog::QgsTableEditorDialog ( QWidget * parent = nullptr )

Constructor for QgsTableEditorDialog with the specified parent widget.

Definition at line 34 of file qgstableeditordialog.cpp.

Member Function Documentation

◆ closeEvent()

void QgsTableEditorDialog::closeEvent ( QCloseEvent * )

overrideprotected

Definition at line 149 of file qgstableeditordialog.cpp.

◆ includeHeaderChanged

void QgsTableEditorDialog::includeHeaderChanged ( bool included )

signal

Emitted whenever the "include table header" setting is changed.

◆ includeTableHeader()

bool QgsTableEditorDialog::includeTableHeader ( ) const

Returns true if the table includes a header row.

See also: setIncludeTableHeader()

Definition at line 281 of file qgstableeditordialog.cpp.

◆ layer()

QgsMapLayer * QgsTableEditorDialog::layer ( ) const

Returns the (possibly nullptr) layer associated with the expression editor context.

Since: QGIS 3.40

Definition at line 156 of file qgstableeditordialog.cpp.

◆ registerExpressionContextGenerator()

void QgsTableEditorDialog::registerExpressionContextGenerator ( QgsExpressionContextGenerator * generator )

Register an expression context generator class that will be used to retrieve an expression context for the editor when required.

Since: QGIS 3.16

Definition at line 301 of file qgstableeditordialog.cpp.

◆ setIncludeTableHeader()

void QgsTableEditorDialog::setIncludeTableHeader ( bool included )

Sets whether the table includes a header row.

See also: includeTableHeader()

Definition at line 286 of file qgstableeditordialog.cpp.

◆ setLayer()

void QgsTableEditorDialog::setLayer ( QgsMapLayer * layer )

Sets the layer to be used associated with the expression editor context.

Since: QGIS 3.40

Definition at line 161 of file qgstableeditordialog.cpp.

◆ setTable()

void QgsTableEditorDialog::setTable ( QgsLayoutItemManualTable * table )

Sets the table associated with the editor.

Since: QGIS 3.42

Definition at line 175 of file qgstableeditordialog.cpp.

◆ setTableColumnWidth()

void QgsTableEditorDialog::setTableColumnWidth	(	int	column,
		double	width
	)

Sets the configured column width for the specified column.

Set width to 0 if an automatic width should be used for the column.

This should be called after a call to setTableContents().

See also: tableColumnWidth()

Definition at line 276 of file qgstableeditordialog.cpp.

◆ setTableContents()

void QgsTableEditorDialog::setTableContents ( const QgsTableContents & contents )

Sets the contents to show in the editor widget.

See also: tableContents()

Definition at line 247 of file qgstableeditordialog.cpp.

◆ setTableContentsFromClipboard()

bool QgsTableEditorDialog::setTableContentsFromClipboard ( )

Parses the clipboard text into contents to show in the editor widget.

Returns: true if the clipboard was successfully parsed

See also: tableContents()

Definition at line 212 of file qgstableeditordialog.cpp.

◆ setTableHeaders()

void QgsTableEditorDialog::setTableHeaders ( const QVariantList & headers )

Sets the table headers.

See also: tableHeaders()

Definition at line 296 of file qgstableeditordialog.cpp.

◆ setTableRowHeight()

void QgsTableEditorDialog::setTableRowHeight	(	int	row,
		double	height
	)

Sets the configured row height for the specified row.

Set height to 0 if an automatic height should be used for the row.

This should be called after a call to setTableContents().

See also: tableRowHeight()

Definition at line 271 of file qgstableeditordialog.cpp.

◆ table()

QgsLayoutItemManualTable * QgsTableEditorDialog::table ( ) const

Returns the manual table associated with the editor.

Since: QGIS 3.42

Definition at line 170 of file qgstableeditordialog.cpp.

◆ tableChanged

void QgsTableEditorDialog::tableChanged ( )

signal

Emitted whenever the table contents are changed.

◆ tableColumnWidth()

double QgsTableEditorDialog::tableColumnWidth ( int column )

Returns the configured column width for the specified column, or 0 if an automatic width should be used for the column.

See also: setTableColumnWidth()

Definition at line 266 of file qgstableeditordialog.cpp.

◆ tableContents()

QgsTableContents QgsTableEditorDialog::tableContents ( ) const

Returns the current contents of the editor widget table.

See also: setTableContents()

Definition at line 256 of file qgstableeditordialog.cpp.

◆ tableHeaders()

QVariantList QgsTableEditorDialog::tableHeaders ( ) const

Returns the table header values.

See also: setTableHeaders()

Definition at line 291 of file qgstableeditordialog.cpp.

◆ tableRowHeight()

double QgsTableEditorDialog::tableRowHeight ( int row )

Returns the configured row height for the specified row, or 0 if an automatic height should be used for the row.

See also: setTableRowHeight()

Definition at line 261 of file qgstableeditordialog.cpp.

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

/build/qgis-3.41.0+git20241228+57ec4277f5e+99sid/src/gui/tableeditor/qgstableeditordialog.h
/build/qgis-3.41.0+git20241228+57ec4277f5e+99sid/src/gui/tableeditor/qgstableeditordialog.cpp

Signals

Public Member Functions

Protected Member Functions