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 "qgis_core.h"
#include "qgis_sip.h"
 
#include <QDomNode>
#include <QString>
#include <QVariant>
#include <QVector>
 
class QgsFields;

class CORE_EXPORT QgsAttributeTableConfig
{
    Q_GADGET
 
  public:
    enum Type
    {
      Field, 
      Action 
    };

    struct CORE_EXPORT ColumnConfig
    {
        ColumnConfig() = default;
 
        // TODO c++20 - replace with = 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    
    };

    enum class AddFeatureMethod : int
    {
      Unset, 
      Form,  
      Table  
    };
    Q_ENUM( AddFeatureMethod )
 
 
    QgsAttributeTableConfig() = default;

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

    bool isEmpty() const;

    int size() const;
 
#ifdef SIP_RUN
    // clang-format off
    int __len__() const;
    % MethodCode
    sipRes = sipCpp->size();
    % End
// clang-format on
#endif

      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 );

    AddFeatureMethod addFeatureMethod() const;

    void setAddFeatureMethod( const AddFeatureMethod addFeatureMethod );
 
#ifndef SIP_RUN

    int columnWidth( int column ) const;
#else
    // clang-format off

    int columnWidth( int column ) const;
    % MethodCode
    {
      if ( a0 < 0 || a0 >= sipCpp->size() )
      {
        PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
        sipIsErr = 1;
      }
      else
      {
        return PyLong_FromLong( sipCpp->columnWidth( a0 ) );
      }
    }
    % End
// clang-format on
#endif
 
#ifndef SIP_RUN

    void setColumnWidth( int column, int width );
#else
      // clang-format off

    void setColumnWidth( int column, int width );
    % MethodCode
    if ( a0 < 0 || a0 >= sipCpp->size() )
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipCpp->setColumnWidth( a0, a1 );
    }
    % End
// clang-format on
#endif
 
#ifndef SIP_RUN

    bool columnHidden( int column ) const;
#else
      // clang-format off

    bool columnHidden( int column ) const;
    % MethodCode
    {
      if ( a0 < 0 || a0 >= sipCpp->size() )
      {
        PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
        sipIsErr = 1;
      }
      else
      {
        return PyBool_FromLong( sipCpp->columnHidden( a0 ) );
      }
    }
    % End
// clang-format on
#endif
 
#ifndef SIP_RUN

    void setColumnHidden( int column, bool hidden );
#else
      // clang-format off

    void setColumnHidden( int column, bool hidden );
    % MethodCode
    if ( a0 < 0 || a0 >= sipCpp->size() )
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipCpp->setColumnHidden( a0, a1 );
    }
    % End
// clang-format on
#endif

    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;
    AddFeatureMethod mAddFeatureMethod = AddFeatureMethod::Unset;
};
 
Q_DECLARE_METATYPE( QgsAttributeTableConfig::ColumnConfig )
 
#endif // QGSATTRIBUTETABLECONFIG_H