QGIS API Documentation  3.20.0-Odense (decaadbb31)
Classes | Public Types | Public Member Functions | List of all members
QgsAttributeTableConfig Class Reference

This is a container for configuration of the attribute table. More...

#include <qgsattributetableconfig.h>

Classes

struct  ColumnConfig
 Defines the configuration of a column in the attribute table. More...
 

Public Types

enum  ActionWidgetStyle { ButtonList , DropDown }
 The style of the action widget in the attribute table. More...
 
enum  Type { Field , Action }
 The type of an attribute table column. More...
 

Public Member Functions

 QgsAttributeTableConfig ()=default
 Constructor for QgsAttributeTableConfig. More...
 
ActionWidgetStyle actionWidgetStyle () const
 Gets the style of the action widget. More...
 
bool actionWidgetVisible () const
 Returns true if the action widget is visible. More...
 
bool columnHidden (int column) const
 Returns true if the specified column is hidden. More...
 
QVector< QgsAttributeTableConfig::ColumnConfigcolumns () const
 Gets the list with all columns and their configuration. More...
 
int columnWidth (int column) const
 Returns the width of a column, or -1 if column should use default width. More...
 
bool hasSameColumns (const QgsAttributeTableConfig &other) const
 Compare this configuration's columns name, type, and order to other. More...
 
bool isEmpty () const
 Returns true if the configuration is empty, ie it contains no columns. More...
 
int mapVisibleColumnToIndex (int visibleColumn) const
 Maps a visible column index to its original column index. More...
 
bool operator!= (const QgsAttributeTableConfig &other) const
 Compare this configuration to other. More...
 
void readXml (const QDomNode &node)
 Deserialize to XML on layer load. More...
 
void setActionWidgetStyle (ActionWidgetStyle actionWidgetStyle)
 Set the style of the action widget. More...
 
void setActionWidgetVisible (bool visible)
 Set if the action widget is visible. More...
 
void setColumnHidden (int column, bool hidden)
 Sets whether the specified column should be hidden. More...
 
void setColumns (const QVector< QgsAttributeTableConfig::ColumnConfig > &columns)
 Set the list of columns visible in the attribute table. More...
 
void setColumnWidth (int column, int width)
 Sets the width of a column. More...
 
void setSortExpression (const QString &sortExpression)
 Set the sort expression used for sorting. More...
 
void setSortOrder (Qt::SortOrder sortOrder)
 Set the sort order. More...
 
QString sortExpression () const
 Gets the expression used for sorting. More...
 
Qt::SortOrder sortOrder () const
 Gets the sort order. More...
 
void update (const QgsFields &fields)
 Update the configuration with the given fields. More...
 
void writeXml (QDomNode &node) const
 Serialize to XML on layer save. More...
 

Detailed Description

This is a container for configuration of the attribute table.

The configuration is specific for one vector layer.

Since
QGIS 2.16

Definition at line 36 of file qgsattributetableconfig.h.

Member Enumeration Documentation

◆ ActionWidgetStyle

The style of the action widget in the attribute table.

Enumerator
ButtonList 

A list of buttons.

DropDown 

A tool button with a drop-down to select the current action.

Definition at line 68 of file qgsattributetableconfig.h.

◆ Type

The type of an attribute table column.

Enumerator
Field 

This column represents a field.

Action 

This column represents an action widget.

Definition at line 43 of file qgsattributetableconfig.h.

Constructor & Destructor Documentation

◆ QgsAttributeTableConfig()

QgsAttributeTableConfig::QgsAttributeTableConfig ( )
default

Constructor for QgsAttributeTableConfig.

Member Function Documentation

◆ actionWidgetStyle()

QgsAttributeTableConfig::ActionWidgetStyle QgsAttributeTableConfig::actionWidgetStyle ( ) const

Gets the style of the action widget.

Definition at line 122 of file qgsattributetableconfig.cpp.

◆ actionWidgetVisible()

bool QgsAttributeTableConfig::actionWidgetVisible ( ) const

Returns true if the action widget is visible.

Definition at line 100 of file qgsattributetableconfig.cpp.

◆ columnHidden()

bool QgsAttributeTableConfig::columnHidden ( int  column) const

Returns true if the specified column is hidden.

Parameters
columncolumn index
See also
setColumnHidden()

Definition at line 218 of file qgsattributetableconfig.cpp.

◆ columns()

QVector< QgsAttributeTableConfig::ColumnConfig > QgsAttributeTableConfig::columns ( ) const

Gets the list with all columns and their configuration.

The list order defines the order of appearance.

Definition at line 20 of file qgsattributetableconfig.cpp.

◆ columnWidth()

int QgsAttributeTableConfig::columnWidth ( int  column) const

Returns the width of a column, or -1 if column should use default width.

Parameters
columncolumn index
See also
setColumnWidth()

Definition at line 208 of file qgsattributetableconfig.cpp.

◆ hasSameColumns()

bool QgsAttributeTableConfig::hasSameColumns ( const QgsAttributeTableConfig other) const

Compare this configuration's columns name, type, and order to other.

The column's width is not considered.

Definition at line 288 of file qgsattributetableconfig.cpp.

◆ isEmpty()

bool QgsAttributeTableConfig::isEmpty ( ) const

Returns true if the configuration is empty, ie it contains no columns.

Definition at line 25 of file qgsattributetableconfig.cpp.

◆ mapVisibleColumnToIndex()

int QgsAttributeTableConfig::mapVisibleColumnToIndex ( int  visibleColumn) const

Maps a visible column index to its original column index.

Parameters
visibleColumnindex of visible column
Returns
corresponding index when hidden columns are considered

Definition at line 30 of file qgsattributetableconfig.cpp.

◆ operator!=()

bool QgsAttributeTableConfig::operator!= ( const QgsAttributeTableConfig other) const

Compare this configuration to other.

Definition at line 228 of file qgsattributetableconfig.cpp.

◆ readXml()

void QgsAttributeTableConfig::readXml ( const QDomNode &  node)

Deserialize to XML on layer load.

Definition at line 133 of file qgsattributetableconfig.cpp.

◆ setActionWidgetStyle()

void QgsAttributeTableConfig::setActionWidgetStyle ( ActionWidgetStyle  actionWidgetStyle)

Set the style of the action widget.

Definition at line 127 of file qgsattributetableconfig.cpp.

◆ setActionWidgetVisible()

void QgsAttributeTableConfig::setActionWidgetVisible ( bool  visible)

Set if the action widget is visible.

Definition at line 111 of file qgsattributetableconfig.cpp.

◆ setColumnHidden()

void QgsAttributeTableConfig::setColumnHidden ( int  column,
bool  hidden 
)

Sets whether the specified column should be hidden.

Parameters
columncolumn index
hiddenset to true to hide column
See also
columnHidden()

Definition at line 223 of file qgsattributetableconfig.cpp.

◆ setColumns()

void QgsAttributeTableConfig::setColumns ( const QVector< QgsAttributeTableConfig::ColumnConfig > &  columns)

Set the list of columns visible in the attribute table.

The list order defines the order of appearance.

Definition at line 45 of file qgsattributetableconfig.cpp.

◆ setColumnWidth()

void QgsAttributeTableConfig::setColumnWidth ( int  column,
int  width 
)

Sets the width of a column.

Parameters
columncolumn index
widthcolumn width in pixels, or -1 if column should use default width
See also
columnWidth()

Definition at line 213 of file qgsattributetableconfig.cpp.

◆ setSortExpression()

void QgsAttributeTableConfig::setSortExpression ( const QString &  sortExpression)

Set the sort expression used for sorting.

Definition at line 203 of file qgsattributetableconfig.cpp.

◆ setSortOrder()

void QgsAttributeTableConfig::setSortOrder ( Qt::SortOrder  sortOrder)

Set the sort order.

Since
QGIS 2.16

Definition at line 238 of file qgsattributetableconfig.cpp.

◆ sortExpression()

QString QgsAttributeTableConfig::sortExpression ( ) const

Gets the expression used for sorting.

Definition at line 198 of file qgsattributetableconfig.cpp.

◆ sortOrder()

Qt::SortOrder QgsAttributeTableConfig::sortOrder ( ) const

Gets the sort order.

Since
QGIS 2.16

Definition at line 233 of file qgsattributetableconfig.cpp.

◆ update()

void QgsAttributeTableConfig::update ( const QgsFields fields)

Update the configuration with the given fields.

Any field which is present in the configuration but not present in the parameter fields will be removed. Any field which is in the parameter fields but not in the configuration will be appended.

Definition at line 50 of file qgsattributetableconfig.cpp.

◆ writeXml()

void QgsAttributeTableConfig::writeXml ( QDomNode &  node) const

Serialize to XML on layer save.

Definition at line 249 of file qgsattributetableconfig.cpp.


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