qgsattributeeditorelement.h

Go to the documentation of this file.

/***************************************************************************
  qgsattributeeditorelement.h - QgsAttributeEditorElement
 
 ---------------------
 begin                : 18.8.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.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSATTRIBUTEEDITORELEMENT_H
#define QGSATTRIBUTEEDITORELEMENT_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QColor>
#include <QFont>
 
class QDomNode;
class QDomElement;
class QDomDocument;
class QgsFields;
class QgsReadWriteContext;

 
class CORE_EXPORT QgsAttributeEditorElement SIP_ABSTRACT
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    switch ( sipCpp->type() )
    {
      case Qgis::AttributeEditorType::Container:
        sipType = sipType_QgsAttributeEditorContainer;
        break;
      case Qgis::AttributeEditorType::Field:
        sipType = sipType_QgsAttributeEditorField;
        break;
      case Qgis::AttributeEditorType::Relation:
        sipType = sipType_QgsAttributeEditorRelation;
        break;
      case Qgis::AttributeEditorType::Action:
        sipType = sipType_QgsAttributeEditorAction;
        break;
      default:
        sipType = nullptr;
        break;
    }
  SIP_END
#endif
 
  public:
    struct CORE_EXPORT LabelStyle
    {
        QColor color;

        QFont font;

        bool overrideColor = false;

        bool overrideFont = false;

        void readXml( const QDomNode &node ) SIP_SKIP;

        QDomElement writeXml( QDomDocument &document ) const SIP_SKIP;

        bool operator==( LabelStyle const &other ) const SIP_SKIP;
    };

    QgsAttributeEditorElement( Qgis::AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent = nullptr )
      : mType( type )
      , mName( name )
      , mParent( parent )
    {}
 
    virtual ~QgsAttributeEditorElement() = default;
 
    // clang-format off
    static std::unique_ptr<QgsAttributeEditorElement> create( const QDomElement &element, const QString &layerId, const QgsFields &fields, const QgsReadWriteContext &context, QgsAttributeEditorElement *parent = nullptr );
    // clang-format on

    QString name() const { return mName; }

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

    int horizontalStretch() const { return mHorizontalStretch; }

    void setHorizontalStretch( int stretch ) { mHorizontalStretch = stretch; }

    int verticalStretch() const { return mVerticalStretch; }

    void setVerticalStretch( int stretch ) { mVerticalStretch = stretch; }

    LabelStyle labelStyle() const;

    void setLabelStyle( const LabelStyle &labelStyle );
 
 
  protected:
#ifndef SIP_RUN
    Qgis::AttributeEditorType mType = Qgis::AttributeEditorType::Invalid;
    QString mName;
    QgsAttributeEditorElement *mParent = nullptr;
    bool mShowLabel = true;
    int mHorizontalStretch = 0;
    int mVerticalStretch = 0;
    LabelStyle mLabelStyle;
#endif
 
  private:
    virtual void saveConfiguration( QDomElement &elem, QDomDocument &doc ) const = 0;

    virtual void loadConfiguration( const QDomElement &element, const QString &layerId, const QgsReadWriteContext &context, const QgsFields &fields ) = 0;

    virtual QString typeIdentifier() const = 0;
};
 
#endif // QGSATTRIBUTEEDITORELEMENT_H