qgsattributeeditorcontainer.h

Go to the documentation of this file.

/***************************************************************************
  qgsattributeeditorcontainer.h - QgsAttributeEditorElement
 
 ---------------------
 begin                : 12.01.2021
 copyright            : (C) 2021 by Denis Rouzaud
 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 QGSATTRIBUTEEDITORCONTAINER_H
#define QGSATTRIBUTEEDITORCONTAINER_H
 
#include "qgis_core.h"
#include "qgsattributeeditorelement.h"
#include "qgsoptionalexpression.h"

class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement
{
  public:

    QgsAttributeEditorContainer( const QString &name, QgsAttributeEditorElement *parent, const QColor &backgroundColor = QColor() )
      : QgsAttributeEditorElement( Qgis::AttributeEditorType::Container, name, parent )
      , mBackgroundColor( backgroundColor )
    {}
 
    ~QgsAttributeEditorContainer() override;

    virtual void addChildElement( QgsAttributeEditorElement *element SIP_TRANSFER );

    void setType( Qgis::AttributeEditorContainerType type ) { mType = type; }

    Qgis::AttributeEditorContainerType type() const { return mType; }

    Q_DECL_DEPRECATED virtual void setIsGroupBox( bool isGroupBox ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED virtual bool isGroupBox() const SIP_DEPRECATED;

    bool collapsed() const { return mCollapsed; };

    void setCollapsed( bool collapsed ) { mCollapsed = collapsed; };

    QList<QgsAttributeEditorElement *> children() const { return mChildren; }

    virtual QList<QgsAttributeEditorElement *> findElements( Qgis::AttributeEditorType type ) const;

    void clear();

    void setName( const QString &name );

    int columnCount() const;

    void setColumnCount( int columnCount );

    QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const override SIP_FACTORY;

    QgsOptionalExpression visibilityExpression() const;

    void setVisibilityExpression( const QgsOptionalExpression &visibilityExpression );

    QgsOptionalExpression collapsedExpression() const SIP_SKIP;

    void setCollapsedExpression( const QgsOptionalExpression &collapsedExpression ) SIP_SKIP;

    QColor backgroundColor() const;

    void setBackgroundColor( const QColor &backgroundColor );
 
  private:
    void saveConfiguration( QDomElement &elem, QDomDocument &doc ) const override;
    void loadConfiguration( const QDomElement &element,  const QString &layerId, const QgsReadWriteContext &context, const QgsFields &fields ) override;
    QString typeIdentifier() const override;
 
    Qgis::AttributeEditorContainerType mType = Qgis::AttributeEditorContainerType::GroupBox;
    QList<QgsAttributeEditorElement *> mChildren;
    int mColumnCount = 1;
    QgsOptionalExpression mVisibilityExpression;
    QColor mBackgroundColor;
    bool mCollapsed = false;
    QgsOptionalExpression mCollapsedExpression;
};
 
 
#endif // QGSATTRIBUTEEDITORCONTAINER_H