qgsattributeeditorelement.h

Go to the documentation of this file.

/***************************************************************************
  qgsattributeeditorelement.h - QgsAttributeEditorElement
 
 ---------------------
 begin                : 18.8.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 QGSATTRIBUTEEDITORELEMENT_H
#define QGSATTRIBUTEEDITORELEMENT_H
 
#include "qgis_core.h"
#include "qgsrelation.h"
#include "qgsoptionalexpression.h"
#include "qgspropertycollection.h"
#include <QColor>
 
 
class QgsRelationManager;
 
class CORE_EXPORT QgsAttributeEditorElement SIP_ABSTRACT
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    switch ( sipCpp->type() )
    {
      case QgsAttributeEditorElement::AeTypeContainer:
        sipType = sipType_QgsAttributeEditorContainer;
        break;
      case QgsAttributeEditorElement::AeTypeField:
        sipType = sipType_QgsAttributeEditorField;
        break;
      case QgsAttributeEditorElement::AeTypeRelation:
        sipType = sipType_QgsAttributeEditorRelation;
        break;
      default:
        sipType = nullptr;
        break;
    }
    SIP_END
#endif
  public:
    enum AttributeEditorType
    {
      AeTypeContainer, 
      AeTypeField,     
      AeTypeRelation,  
      AeTypeInvalid,   
      AeTypeQmlElement, 
      AeTypeHtmlElement 
    };
 
    QgsAttributeEditorElement( AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent = nullptr )
      : mType( type )
      , mName( name )
      , mParent( parent )
      , mShowLabel( true )
    {}
 
    virtual ~QgsAttributeEditorElement() = default;
 
    QString name() const { return mName; }
 
    AttributeEditorType type() const { return mType; }
 
    QgsAttributeEditorElement *parent() const { return mParent; }
 
    QDomElement toDomElement( QDomDocument &doc ) const;
 
    virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const = 0 SIP_FACTORY;
 
    bool showLabel() const;
 
    void setShowLabel( bool showLabel );
 
  protected:
#ifndef SIP_RUN
    AttributeEditorType mType;
    QString mName;
    QgsAttributeEditorElement *mParent = nullptr;
    bool mShowLabel;
#endif
 
  private:
 
    virtual void saveConfiguration( QDomElement &elem ) const = 0;
 
    virtual QString typeIdentifier() const = 0;
 
};
 
 
class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement
{
  public:
 
    QgsAttributeEditorContainer( const QString &name, QgsAttributeEditorElement *parent, const QColor &backgroundColor = QColor() )
      : QgsAttributeEditorElement( AeTypeContainer, name, parent )
      , mIsGroupBox( true )
      , mColumnCount( 1 )
      , mBackgroundColor( backgroundColor )
    {}
 
 
    ~QgsAttributeEditorContainer() override;
 
    virtual void addChildElement( QgsAttributeEditorElement *element SIP_TRANSFER );
 
    virtual void setIsGroupBox( bool isGroupBox ) { mIsGroupBox = isGroupBox; }
 
    virtual bool isGroupBox() const { return mIsGroupBox; }
 
    QList<QgsAttributeEditorElement *> children() const { return mChildren; }
 
    virtual QList<QgsAttributeEditorElement *> findElements( 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 );
 
    QColor backgroundColor() const;
 
    void setBackgroundColor( const QColor &backgroundColor );
 
  private:
    void saveConfiguration( QDomElement &elem ) const override;
    QString typeIdentifier() const override;
 
    bool mIsGroupBox;
    QList<QgsAttributeEditorElement *> mChildren;
    int mColumnCount;
    QgsOptionalExpression mVisibilityExpression;
    QColor mBackgroundColor;
};
 
class CORE_EXPORT QgsAttributeEditorField : public QgsAttributeEditorElement
{
  public:
 
    QgsAttributeEditorField( const QString &name, int idx, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( AeTypeField, name, parent )
      , mIdx( idx )
    {}
 
    int idx() const { return mIdx; }
 
    QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const override SIP_FACTORY;
 
  private:
    void saveConfiguration( QDomElement &elem ) const override;
    QString typeIdentifier() const override;
    int mIdx;
};
 
class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement
{
    Q_GADGET
  public:
 
    enum Button
    {
      Link = 1 << 1, 
      Unlink = 1 << 2, 
      SaveChildEdits = 1 << 3, 
      AddChildFeature = 1 << 4, 
      DuplicateChildFeature = 1 << 5, 
      DeleteChildFeature = 1 << 6, 
      ZoomToChildFeature = 1 << 7, 
      AllButtons = Link | Unlink | SaveChildEdits | AddChildFeature | DuplicateChildFeature | DeleteChildFeature | ZoomToChildFeature 
    };
    Q_ENUM( Button )
    Q_DECLARE_FLAGS( Buttons, Button )
    Q_FLAG( Buttons )
 
    
    Q_DECL_DEPRECATED QgsAttributeEditorRelation( const QString &name, const QString &relationId, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( AeTypeRelation, name, parent )
      , mRelationId( relationId )
    {}
 
    Q_DECL_DEPRECATED QgsAttributeEditorRelation( const QString &name, const QgsRelation &relation, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( AeTypeRelation, name, parent )
      , mRelationId( relation.id() )
      , mRelation( relation )
    {}
 
    QgsAttributeEditorRelation( const QString &relationId, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( AeTypeRelation, relationId, parent )
      , mRelationId( relationId )
    {}
 
    QgsAttributeEditorRelation( const QgsRelation &relation, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( AeTypeRelation, relation.id(), parent )
      , mRelationId( relation.id() )
      , mRelation( relation )
    {}
 
 
    const QgsRelation &relation() const { return mRelation; }
 
    bool init( QgsRelationManager *relManager );
 
    QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const override SIP_FACTORY;
 
    Q_DECL_DEPRECATED bool showLinkButton() const SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED void setShowLinkButton( bool showLinkButton ) SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED bool showUnlinkButton() const SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED void setShowUnlinkButton( bool showUnlinkButton ) SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED void setShowSaveChildEditsButton( bool showChildEdits ) SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED bool showSaveChildEditsButton() const SIP_DEPRECATED;
 
    void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons );
 
    QgsAttributeEditorRelation::Buttons visibleButtons() const {return mButtons;}
 
    bool forceSuppressFormPopup() const;
 
    void setForceSuppressFormPopup( bool forceSuppressFormPopup );
 
    QVariant nmRelationId() const;
 
    void setNmRelationId( const QVariant &nmRelationId = QVariant() );
 
    QString label() const;
 
    void setLabel( const QString &label = QString() );
 
  private:
    void saveConfiguration( QDomElement &elem ) const override;
    QString typeIdentifier() const override;
    QString mRelationId;
    QgsRelation mRelation;
    Buttons mButtons = Buttons( Button::AllButtons );
    bool mForceSuppressFormPopup = false;
    QVariant mNmRelationId;
    QString mLabel;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAttributeEditorRelation::Buttons )
 
 
 
class CORE_EXPORT QgsAttributeEditorQmlElement : public QgsAttributeEditorElement
{
  public:
 
    QgsAttributeEditorQmlElement( const QString &name, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( AeTypeQmlElement, name, parent )
    {}
 
    QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const override SIP_FACTORY;
 
    QString qmlCode() const;
 
    void setQmlCode( const QString &qmlCode );
 
  private:
    void saveConfiguration( QDomElement &elem ) const override;
    QString typeIdentifier() const override;
    QString mQmlCode;
};
 
 
class CORE_EXPORT QgsAttributeEditorHtmlElement : public QgsAttributeEditorElement
{
  public:
 
    QgsAttributeEditorHtmlElement( const QString &name, QgsAttributeEditorElement *parent )
      : QgsAttributeEditorElement( AeTypeHtmlElement, name, parent )
    {}
 
    QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const override SIP_FACTORY;
 
    QString htmlCode() const;
 
    void setHtmlCode( const QString &htmlCode );
 
  private:
    void saveConfiguration( QDomElement &elem ) const override;
    QString typeIdentifier() const override;
    QString mHtmlCode;
};
 
 
#endif // QGSATTRIBUTEEDITORELEMENT_H