QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A reusable widget for editing simple spreadsheet-style tables. More...
#include <qgstableeditorwidget.h>
Public Slots | |
void | clearSelectedCells () |
Clears the contents of the currently selected cells. | |
void | deleteColumns () |
Deletes all columns associated with the current selected cells. | |
void | deleteRows () |
Deletes all rows associated with the current selected cells. | |
void | expandColumnSelection () |
Expands out the selection to include whole columns associated with the current selected cells. | |
void | expandRowSelection () |
Expands out the selection to include whole rows associated with the current selected cells. | |
void | insertColumnsAfter () |
Inserts new columns after the current selection. | |
void | insertColumnsBefore () |
Inserts new columns before the current selection. | |
void | insertRowsAbove () |
Inserts new rows above the current selection. | |
void | insertRowsBelow () |
Inserts new rows below the current selection. | |
void | mergeSelectedCells () |
Merges selected table cells. | |
void | setIncludeTableHeader (bool included) |
Sets whether the table includes a header row. | |
void | setSelectionBackgroundColor (const QColor &color) |
Sets the background color for the currently selected cells. | |
void | setSelectionCellProperty (const QgsProperty &property) |
Sets the cell contents QgsProperty for the currently selected cells. | |
void | setSelectionColumnWidth (double height) |
Sets the column width (in millimeters) for the currently selected columns, or 0 for automatic column width. | |
Q_DECL_DEPRECATED void | setSelectionForegroundColor (const QColor &color) |
Sets the foreground color for the currently selected cells. | |
void | setSelectionHorizontalAlignment (Qt::Alignment alignment) |
Sets the horizontal alignment for the currently selected cells. | |
void | setSelectionRowHeight (double height) |
Sets the row height (in millimeters) for the currently selected rows, or 0 for automatic row height. | |
void | setSelectionTextFormat (const QgsTextFormat &format) |
Sets the text format for the selected cells. | |
void | setSelectionVerticalAlignment (Qt::Alignment alignment) |
Sets the vertical alignment for the currently selected cells. | |
void | setTableHeaders (const QVariantList &headers) |
Sets the table headers. | |
void | splitSelectedCells () |
Splits (un-merges) selected table cells. | |
Signals | |
void | activeCellChanged () |
Emitted whenever the active (or selected) cell changes in the widget. | |
void | tableChanged () |
Emitted whenever the table contents are changed. | |
Public Member Functions | |
QgsTableEditorWidget (QWidget *parent=nullptr) | |
Constructor for QgsTableEditorWidget with the specified parent widget. | |
~QgsTableEditorWidget () override | |
bool | canMergeSelection () const |
Returns true if a selection has been made which can be merged. | |
bool | canSplitSelection () const |
Returns true if a selection has been made which can be split. | |
QList< int > | columnsAssociatedWithSelection () |
Returns a list of the columns associated with the current table selected cells. | |
bool | hasMixedSelectionNumericFormat () |
Returns true if the current selection has a mix of numeric formats. | |
bool | isHeaderCellSelected () const |
Returns true if any header cells are selected. | |
QList< int > | rowsAssociatedWithSelection () |
Returns a list of the rows associated with the current table selected cells. | |
QColor | selectionBackgroundColor () |
Returns the background color for the currently selected cells. | |
QgsProperty | selectionCellProperty () |
Returns the QgsProperty used for the contents of the currently selected cells. | |
double | selectionColumnWidth () |
Returns the width (in millimeters) of the columns associated with the current selection, or 0 if an automatic column width is desired. | |
Q_DECL_DEPRECATED QColor | selectionForegroundColor () |
Returns the foreground color for the currently selected cells. | |
Qt::Alignment | selectionHorizontalAlignment () |
Returns the horizontal alignment for the currently selected cells. | |
QgsNumericFormat * | selectionNumericFormat () |
Returns the numeric format used for the currently selected cells, or nullptr if the selection has no numeric format set. | |
double | selectionRowHeight () |
Returns the height (in millimeters) of the rows associated with the current selection, or 0 if an automatic row height is desired, or -1 if the selection has mixed row heights. | |
QgsTextFormat | selectionTextFormat () |
Returns the text format for the currently selected cells. | |
Qt::Alignment | selectionVerticalAlignment () |
Returns the horizontal alignment for the currently selected cells. | |
void | setSelectionNumericFormat (QgsNumericFormat *format) |
Sets the numeric format to use for the currently selected cells. | |
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. | |
void | setTableRowHeight (int row, double height) |
Sets the configured row height for the specified row. | |
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 | keyPressEvent (QKeyEvent *event) override |
Friends | |
class | QgsTableEditorDelegate |
A reusable widget 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.
Definition at line 111 of file qgstableeditorwidget.h.
QgsTableEditorWidget::QgsTableEditorWidget | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsTableEditorWidget with the specified parent widget.
Definition at line 26 of file qgstableeditorwidget.cpp.
|
override |
Definition at line 160 of file qgstableeditorwidget.cpp.
|
signal |
Emitted whenever the active (or selected) cell changes in the widget.
bool QgsTableEditorWidget::canMergeSelection | ( | ) | const |
Returns true
if a selection has been made which can be merged.
Definition at line 869 of file qgstableeditorwidget.cpp.
bool QgsTableEditorWidget::canSplitSelection | ( | ) | const |
Returns true
if a selection has been made which can be split.
Definition at line 876 of file qgstableeditorwidget.cpp.
|
slot |
Clears the contents of the currently selected cells.
Definition at line 1023 of file qgstableeditorwidget.cpp.
QList< int > QgsTableEditorWidget::columnsAssociatedWithSelection | ( | ) |
Returns a list of the columns associated with the current table selected cells.
Definition at line 835 of file qgstableeditorwidget.cpp.
|
slot |
Deletes all columns associated with the current selected cells.
Definition at line 988 of file qgstableeditorwidget.cpp.
|
slot |
Deletes all rows associated with the current selected cells.
Definition at line 971 of file qgstableeditorwidget.cpp.
|
slot |
Expands out the selection to include whole columns associated with the current selected cells.
Definition at line 1014 of file qgstableeditorwidget.cpp.
|
slot |
Expands out the selection to include whole rows associated with the current selected cells.
Definition at line 1005 of file qgstableeditorwidget.cpp.
bool QgsTableEditorWidget::hasMixedSelectionNumericFormat | ( | ) |
Returns true
if the current selection has a mix of numeric formats.
Definition at line 559 of file qgstableeditorwidget.cpp.
|
slot |
Inserts new columns after the current selection.
Definition at line 949 of file qgstableeditorwidget.cpp.
|
slot |
Inserts new columns before the current selection.
Definition at line 927 of file qgstableeditorwidget.cpp.
|
slot |
Inserts new rows above the current selection.
Definition at line 905 of file qgstableeditorwidget.cpp.
|
slot |
Inserts new rows below the current selection.
Definition at line 883 of file qgstableeditorwidget.cpp.
bool QgsTableEditorWidget::isHeaderCellSelected | ( | ) | const |
Returns true
if any header cells are selected.
Definition at line 861 of file qgstableeditorwidget.cpp.
|
overrideprotected |
Definition at line 345 of file qgstableeditorwidget.cpp.
|
slot |
Merges selected table cells.
Definition at line 1358 of file qgstableeditorwidget.cpp.
QList< int > QgsTableEditorWidget::rowsAssociatedWithSelection | ( | ) |
Returns a list of the rows associated with the current table selected cells.
Definition at line 830 of file qgstableeditorwidget.cpp.
QColor QgsTableEditorWidget::selectionBackgroundColor | ( | ) |
Returns the background color for the currently selected cells.
If the selected cells have a mix of different background colors then an invalid color will be returned.
Definition at line 595 of file qgstableeditorwidget.cpp.
QgsProperty QgsTableEditorWidget::selectionCellProperty | ( | ) |
Returns the QgsProperty used for the contents of the currently selected cells.
If the returned value is a default constructed QgsProperty, then the selected cells have a mix of different properties.
Definition at line 664 of file qgstableeditorwidget.cpp.
double QgsTableEditorWidget::selectionColumnWidth | ( | ) |
Returns the width (in millimeters) of the columns associated with the current selection, or 0 if an automatic column width is desired.
Definition at line 730 of file qgstableeditorwidget.cpp.
QColor QgsTableEditorWidget::selectionForegroundColor | ( | ) |
Returns the foreground color for the currently selected cells.
If the selected cells have a mix of different foreground colors then an invalid color will be returned.
Definition at line 589 of file qgstableeditorwidget.cpp.
Qt::Alignment QgsTableEditorWidget::selectionHorizontalAlignment | ( | ) |
Returns the horizontal alignment for the currently selected cells.
If the returned value contains both horizontal and vertical alignment flags, then the selected cells have a mix of different horizontal alignments.
Definition at line 618 of file qgstableeditorwidget.cpp.
QgsNumericFormat * QgsTableEditorWidget::selectionNumericFormat | ( | ) |
Returns the numeric format used for the currently selected cells, or nullptr
if the selection has no numeric format set.
If the selected cells have a mix of different formats then nullptr
will be returned.
Definition at line 529 of file qgstableeditorwidget.cpp.
double QgsTableEditorWidget::selectionRowHeight | ( | ) |
Returns the height (in millimeters) of the rows associated with the current selection, or 0 if an automatic row height is desired, or -1 if the selection has mixed row heights.
Definition at line 711 of file qgstableeditorwidget.cpp.
QgsTextFormat QgsTableEditorWidget::selectionTextFormat | ( | ) |
Returns the text format for the currently selected cells.
Returns an invalid QgsTextFormat if the selection has mixed text format.
Definition at line 687 of file qgstableeditorwidget.cpp.
Qt::Alignment QgsTableEditorWidget::selectionVerticalAlignment | ( | ) |
Returns the horizontal alignment for the currently selected cells.
If the returned value contains both horizontal and vertical alignment flags, then the selected cells have a mix of different vertical alignments.
Definition at line 641 of file qgstableeditorwidget.cpp.
|
slot |
Sets whether the table includes a header row.
Definition at line 1320 of file qgstableeditorwidget.cpp.
|
slot |
Sets the background color for the currently selected cells.
Definition at line 1079 of file qgstableeditorwidget.cpp.
|
slot |
Sets the cell contents QgsProperty for the currently selected cells.
Definition at line 1174 of file qgstableeditorwidget.cpp.
|
slot |
Sets the column width (in millimeters) for the currently selected columns, or 0 for automatic column width.
Definition at line 1289 of file qgstableeditorwidget.cpp.
|
slot |
Sets the foreground color for the currently selected cells.
Definition at line 1042 of file qgstableeditorwidget.cpp.
|
slot |
Sets the horizontal alignment for the currently selected cells.
Definition at line 1112 of file qgstableeditorwidget.cpp.
void QgsTableEditorWidget::setSelectionNumericFormat | ( | QgsNumericFormat * | format | ) |
Sets the numeric format to use for the currently selected cells.
Ownership of format is transferred to the widget.
Definition at line 487 of file qgstableeditorwidget.cpp.
|
slot |
Sets the row height (in millimeters) for the currently selected rows, or 0 for automatic row height.
Definition at line 1255 of file qgstableeditorwidget.cpp.
|
slot |
Sets the text format for the selected cells.
Definition at line 1225 of file qgstableeditorwidget.cpp.
|
slot |
Sets the vertical alignment for the currently selected cells.
Definition at line 1143 of file qgstableeditorwidget.cpp.
void QgsTableEditorWidget::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().
Definition at line 803 of file qgstableeditorwidget.cpp.
void QgsTableEditorWidget::setTableContents | ( | const QgsTableContents & | contents | ) |
Sets the contents to show in the editor widget.
Definition at line 373 of file qgstableeditorwidget.cpp.
|
slot |
Sets the table headers.
Definition at line 1334 of file qgstableeditorwidget.cpp.
void QgsTableEditorWidget::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().
Definition at line 771 of file qgstableeditorwidget.cpp.
|
slot |
Splits (un-merges) selected table cells.
Definition at line 1386 of file qgstableeditorwidget.cpp.
|
signal |
Emitted whenever the table contents are changed.
double QgsTableEditorWidget::tableColumnWidth | ( | int | column | ) |
Returns the configured column width for the specified column, or 0 if an automatic width should be used for the column.
Definition at line 760 of file qgstableeditorwidget.cpp.
QgsTableContents QgsTableEditorWidget::tableContents | ( | ) | const |
Returns the current contents of the editor widget table.
Definition at line 434 of file qgstableeditorwidget.cpp.
QVariantList QgsTableEditorWidget::tableHeaders | ( | ) | const |
Returns the table header values.
Definition at line 840 of file qgstableeditorwidget.cpp.
double QgsTableEditorWidget::tableRowHeight | ( | int | row | ) |
Returns the configured row height for the specified row, or 0 if an automatic height should be used for the row.
Definition at line 749 of file qgstableeditorwidget.cpp.
|
friend |
Definition at line 522 of file qgstableeditorwidget.h.