mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-04 00:30:59 -05:00
79 lines
2.6 KiB
Plaintext
79 lines
2.6 KiB
Plaintext
|
/***************************************************************************
|
||
|
|
qgsattributetableconfig.h - QgsAttributeTableConfig
|
||
|
|
|
||
|
|
---------------------
|
||
|
|
begin : 27.4.2016
|
||
|
|
copyright : (C) 2016 by Matthias Kuhn
|
||
|
|
email : matthias@opengis.ch
|
||
|
|
***************************************************************************
|
||
|
|
* *
|
||
|
|
* This program is free software; you can redistribute it and/or modify *
|
||
|
|
* it under the terms of the GNU General Public License as published by *
|
||
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
||
|
|
* (at your option) any later version. *
|
||
|
|
* *
|
||
|
|
***************************************************************************/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This is a container for configuration of the attribute table.
|
||
|
|
* The configuration is specific for one vector layer.
|
||
|
|
*/
|
||
|
|
|
||
|
|
class QgsAttributeTableConfig
|
||
|
|
{
|
||
|
|
%TypeHeaderCode
|
||
|
|
#include <qgsattributetableconfig.h>
|
||
|
|
%End
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
* The type of an attribute table column.
|
||
|
|
*/
|
||
|
|
enum Type
|
||
|
|
{
|
||
|
|
Field, //!< This column represents a field
|
||
|
|
Action //!< This column represents an action widget
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Defines the configuration of a column in the attribute table.
|
||
|
|
*/
|
||
|
|
struct ColumnConfig
|
||
|
|
{
|
||
|
|
QgsAttributeTableConfig::Type mType; //!< The type of this column.
|
||
|
|
QString mName; //!< The name of the attribute if this column represents a field
|
||
|
|
bool mHidden; //!< Flag that controls if the column is hidden
|
||
|
|
};
|
||
|
|
|
||
|
|
QgsAttributeTableConfig();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the list with all columns and their configuration.
|
||
|
|
* The list order defines the order of appearance.
|
||
|
|
*/
|
||
|
|
QVector<QgsAttributeTableConfig::ColumnConfig> columns() const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the list of columns visible in the attribute table.
|
||
|
|
* The list order defines the order of appearance.
|
||
|
|
*/
|
||
|
|
void setColumns( const QVector<QgsAttributeTableConfig::ColumnConfig>& columns );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
*/
|
||
|
|
void update( const QgsFields& fields );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Serialize to XML on layer save
|
||
|
|
*/
|
||
|
|
void writeXml( QDomNode& node ) const;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Deserialize to XML on layer load
|
||
|
|
*/
|
||
|
|
void readXml( const QDomNode& node );
|
||
|
|
};
|