qgsattributetableconfig.h

Go to the documentation of this file.

/***************************************************************************
  qgsattributetableconfig.h - QgsAttributeTableConfig

 ---------------------
 begin                : 27.4.2016
 copyright            : (C) 2016 by Matthias Kuhn
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSATTRIBUTETABLECONFIG_H
#define QGSATTRIBUTETABLECONFIG_H

#include <QString>
#include <QVector>
#include <QDomNode>
#include <QVariant>

#include "qgis_sip.h"
#include "qgis_core.h"

class QgsFields;

class CORE_EXPORT QgsAttributeTableConfig
{
  public:

    enum Type
    {
      Field,    
      Action    
    };

    struct ColumnConfig
    {
      ColumnConfig() = default;

      bool operator== ( const QgsAttributeTableConfig::ColumnConfig &other ) const SIP_SKIP;

      QgsAttributeTableConfig::Type type = Field;    
      QString name; 
      bool hidden = false;  
      int width = -1; 
    };

    enum ActionWidgetStyle
    {
      ButtonList,   
      DropDown      
    };

    QgsAttributeTableConfig() = default;

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

    bool isEmpty() const;

    int mapVisibleColumnToIndex( int visibleColumn ) const;

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

    void update( const QgsFields &fields );

    bool actionWidgetVisible() const;

    void setActionWidgetVisible( bool visible );

    ActionWidgetStyle actionWidgetStyle() const;

    void setActionWidgetStyle( ActionWidgetStyle actionWidgetStyle );

    void writeXml( QDomNode &node ) const;

    void readXml( const QDomNode &node );

    QString sortExpression() const;

    void setSortExpression( const QString &sortExpression );

    int columnWidth( int column ) const;

    void setColumnWidth( int column, int width );

    bool columnHidden( int column ) const;

    void setColumnHidden( int column, bool hidden );

    Qt::SortOrder sortOrder() const;

    void setSortOrder( Qt::SortOrder sortOrder );

    bool hasSameColumns( const QgsAttributeTableConfig &other ) const;

    bool operator!= ( const QgsAttributeTableConfig &other ) const;

  private:
    QVector<ColumnConfig> mColumns;
    ActionWidgetStyle mActionWidgetStyle = DropDown;
    QString mSortExpression;
    Qt::SortOrder mSortOrder = Qt::AscendingOrder;
};

Q_DECLARE_METATYPE( QgsAttributeTableConfig::ColumnConfig )

#endif // QGSATTRIBUTETABLECONFIG_H