qgseditformconfig.h

Go to the documentation of this file.

/***************************************************************************
                          qgseditformconfig.h
                             -------------------
    begin                : Nov 18, 2015
    copyright            : (C) 2015 by Matthias Kuhn
    email                : matthias at opengis dot 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 QGSEDITFORMCONFIG_H
#define QGSEDITFORMCONFIG_H

#include <QMap>

#include "qgseditorwidgetconfig.h"
#include "qgsrelationmanager.h"

class CORE_EXPORT QgsAttributeEditorElement : public QObject
{
    Q_OBJECT
  public:

    enum AttributeEditorType
    {
      AeTypeContainer, 
      AeTypeField,     
      AeTypeRelation,  
      AeTypeInvalid    
    };

    QgsAttributeEditorElement( AttributeEditorType type, const QString& name, QObject *parent = nullptr )
        : QObject( parent ), mType( type ), mName( name ) {}

    virtual ~QgsAttributeEditorElement() {}

    QString name() const { return mName; }

    AttributeEditorType type() const { return mType; }

    virtual QDomElement toDomElement( QDomDocument& doc ) const = 0;

  protected:
    AttributeEditorType mType;
    QString mName;
};


class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement
{
    Q_OBJECT

  public:
    QgsAttributeEditorContainer( const QString& name, QObject *parent )
        : QgsAttributeEditorElement( AeTypeContainer, name, parent )
        , mIsGroupBox( true )
    {}

    virtual ~QgsAttributeEditorContainer() {}

    virtual QDomElement toDomElement( QDomDocument& doc ) const override;

    virtual void addChildElement( QgsAttributeEditorElement* element );

    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 setName( const QString& name );

  private:
    bool mIsGroupBox;
    QList<QgsAttributeEditorElement*> mChildren;
};

class CORE_EXPORT QgsAttributeEditorField : public QgsAttributeEditorElement
{
    Q_OBJECT

  public:
    QgsAttributeEditorField( const QString& name, int idx, QObject *parent )
        : QgsAttributeEditorElement( AeTypeField, name, parent ), mIdx( idx ) {}

    virtual ~QgsAttributeEditorField() {}

    virtual QDomElement toDomElement( QDomDocument& doc ) const override;

    int idx() const { return mIdx; }

  private:
    int mIdx;
};

class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement
{
    Q_OBJECT

  public:
    QgsAttributeEditorRelation( const QString& name, const QString &relationId, QObject *parent )
        : QgsAttributeEditorElement( AeTypeRelation, name, parent )
        , mRelationId( relationId ) {}

    QgsAttributeEditorRelation( const QString& name, const QgsRelation& relation, QObject *parent )
        : QgsAttributeEditorElement( AeTypeRelation, name, parent )
        , mRelationId( relation.id() )
        , mRelation( relation ) {}

    virtual ~QgsAttributeEditorRelation() {}

    virtual QDomElement toDomElement( QDomDocument& doc ) const override;

    const QgsRelation& relation() const { return mRelation; }

    bool init( QgsRelationManager *relManager );

  private:
    QString mRelationId;
    QgsRelation mRelation;
};


class CORE_EXPORT QgsEditFormConfig : public QObject
{
    Q_OBJECT

  public:

    enum EditorLayout
    {
      GeneratedLayout = 0, 
      TabLayout = 1,       
      UiFileLayout = 2     
    };

    struct GroupData
    {
      GroupData() {}
      GroupData( const QString& name, const QList<QString>& fields )
          : mName( name ), mFields( fields ) {}
      QString mName;
      QList<QString> mFields;
    };

    struct TabData
    {
      TabData() {}
      TabData( const QString& name, const QList<QString>& fields, const QList<GroupData>& groups )
          : mName( name ), mFields( fields ), mGroups( groups ) {}
      QString mName;
      QList<QString> mFields;
      QList<GroupData> mGroups;
    };

    enum FeatureFormSuppress
    {
      SuppressDefault = 0, 
      SuppressOn = 1,      
      SuppressOff = 2      
    };

    enum PythonInitCodeSource
    {
      CodeSourceNone = 0,             
      CodeSourceFile = 1,             
      CodeSourceDialog = 2,           
      CodeSourceEnvironment = 3       
    };

    void addTab( QgsAttributeEditorElement* data ) { mAttributeEditorElements.append( data ); }

    QList< QgsAttributeEditorElement* > tabs() const { return mAttributeEditorElements; }

    void clearTabs() { mAttributeEditorElements.clear(); }

    EditorLayout layout() const { return mEditorLayout; }

    void setLayout( EditorLayout editorLayout ) { mEditorLayout = editorLayout; }

    QString uiForm() const { return mUiFormPath; }

    void setUiForm( const QString& ui );


    // Widget stuff

    void setWidgetType( int fieldIdx, const QString& widgetType );

    QString widgetType( int fieldIdx ) const;

    QString widgetType( const QString& fieldName ) const;

    void setWidgetConfig( int attrIdx, const QgsEditorWidgetConfig& config );

    void setWidgetConfig( const QString& widgetName, const QgsEditorWidgetConfig& config );

    QgsEditorWidgetConfig widgetConfig( int fieldIdx ) const;

    QgsEditorWidgetConfig widgetConfig( const QString& widgetName ) const;

    bool removeWidgetConfig( int fieldIdx );

    bool removeWidgetConfig( const QString& widgetName );

    bool readOnly( int idx ) const;

    void setReadOnly( int idx, bool readOnly = true );

    bool labelOnTop( int idx ) const;

    void setLabelOnTop( int idx, bool onTop );


    // Python form init function stuff

    QString initFunction() const { return mInitFunction; }

    void setInitFunction( const QString& function ) { mInitFunction = function; }

    QString initCode() const { return mInitCode; }

    void setInitCode( const QString& code ) { mInitCode = code; }

    QString initFilePath() const { return mInitFilePath; }

    void setInitFilePath( const QString& filePath ) { mInitFilePath = filePath; }

    PythonInitCodeSource initCodeSource() const { return mInitCodeSource; }

    void setInitCodeSource( const PythonInitCodeSource initCodeSource ) { mInitCodeSource = initCodeSource; }

    FeatureFormSuppress suppress() const { return mSuppressForm; }
    void setSuppress( FeatureFormSuppress s ) { mSuppressForm = s; }

    // Serialization

    void readXml( const QDomNode& node );

    void writeXml( QDomNode& node ) const;

    QgsAttributeEditorElement* attributeEditorElementFromDomElement( QDomElement &elem, QObject* parent );

  private slots:
    void onRelationsLoaded();

  protected:
    // Internal stuff

    explicit QgsEditFormConfig( QObject* parent = nullptr );

  private:

    void setFields( const QgsFields& fields );

  private:
    QList< QgsAttributeEditorElement* > mAttributeEditorElements;

    QList< TabData > mTabs;

    QMap< QString, bool> mFieldEditables;
    QMap< QString, bool> mLabelOnTop;

    QMap<QString, QString> mEditorWidgetV2Types;
    QMap<QString, QgsEditorWidgetConfig > mWidgetConfigs;

    EditorLayout mEditorLayout;

    QString mUiFormPath;
    QString mInitFunction;
    QString mInitFilePath;
    PythonInitCodeSource mInitCodeSource;
    QString mInitCode;

    FeatureFormSuppress mSuppressForm;

    QgsFields mFields;

    friend class QgsVectorLayer;
};

#endif // QGSEDITFORMCONFIG_H