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 "qgis_core.h"
#include "qgis_sip.h"
#include "qgspropertycollection.h"
#include "qgsreadwritecontext.h"
 
#include <QDomDocument>
#include <QDomElement>
#include <QMap>
 
class QgsRelationManager;
class QgsEditFormConfigPrivate;
class QgsAttributeEditorContainer;
class QgsAttributeEditorElement;

class CORE_EXPORT QgsEditFormConfig
{
    Q_GADGET
 
  public:
    struct GroupData
    {
        GroupData() = default;
        GroupData( const QString &name, const QList<QString> &fields )
          : mName( name )
          , mFields( fields )
        {}
        QString mName;
        QList<QString> mFields;
    };
 
    struct TabData
    {
        TabData() = default;
        TabData( const QString &name, const QList<QString> &fields, const QList<QgsEditFormConfig::GroupData> &groups )
          : mName( name )
          , mFields( fields )
          , mGroups( groups )
        {}
        QString mName;
        QList<QString> mFields;
        QList<QgsEditFormConfig::GroupData> mGroups;
    };
 
    // *INDENT-OFF*

    enum class DataDefinedProperty SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsEditFormConfig, DataDefinedProperty ) : int
    {
      NoProperty = 0,    
      AllProperties = 1, 
      Alias = 2,         
      Editable = 3,      
      CustomComment = 4, 
    };
    // *INDENT-ON*
 
    QgsEditFormConfig( const QgsEditFormConfig &o );
    ~QgsEditFormConfig();
 
    QgsEditFormConfig &operator=( const QgsEditFormConfig &o );
    // TODO c++20 - replace with = default
    bool operator==( const QgsEditFormConfig &o ) const;

    void addTab( QgsAttributeEditorElement *data SIP_TRANSFER );

    QList< QgsAttributeEditorElement * > tabs() const;

    void clearTabs();

    QgsAttributeEditorContainer *invisibleRootContainer();

    Qgis::AttributeFormLayout layout() const;

    void setLayout( Qgis::AttributeFormLayout editorLayout );

    QString uiForm() const;

    void setUiForm( const QString &ui );

    bool setWidgetConfig( const QString &widgetName, const QVariantMap &config );

    QVariantMap widgetConfig( const QString &widgetName ) const;

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

    Q_DECL_DEPRECATED bool reuseLastValue( int index ) const;

    Q_DECL_DEPRECATED void setReuseLastValue( int index, bool reuse );

    Qgis::AttributeFormReuseLastValuePolicy reuseLastValuePolicy( int index ) const;

    void setReuseLastValuePolicy( int index, Qgis::AttributeFormReuseLastValuePolicy policy );
 
    // Python form init function stuff

    QString initFunction() const;

    void setInitFunction( const QString &function );

    QString initCode() const;

    void setInitCode( const QString &code );

    QString initFilePath() const;

    void setInitFilePath( const QString &filePath );

    Qgis::AttributeFormPythonInitCodeSource initCodeSource() const;

    void setInitCodeSource( Qgis::AttributeFormPythonInitCodeSource initCodeSource );

    Qgis::AttributeFormSuppression suppress() const;
    void setSuppress( Qgis::AttributeFormSuppression s );
 
    // Serialization

    void readXml( const QDomNode &node, QgsReadWriteContext &context );

    void writeXml( QDomNode &node, const QgsReadWriteContext &context ) const;

    Q_DECL_DEPRECATED QgsAttributeEditorElement *attributeEditorElementFromDomElement(
      QDomElement &elem, QgsAttributeEditorElement *parent, const QString &layerId = QString(), const QgsReadWriteContext &context = QgsReadWriteContext()
    ) SIP_DEPRECATED;

    explicit QgsEditFormConfig();

    void setDataDefinedFieldProperties( const QString &fieldName, const QgsPropertyCollection &properties );

    QgsPropertyCollection dataDefinedFieldProperties( const QString &fieldName ) const;

    static const QgsPropertiesDefinition &propertyDefinitions();
 
  private:
    void setFields( const QgsFields &fields );

    void onRelationsLoaded(); // cppcheck-suppress functionConst

    bool legacyUpdateRelationWidgetInTabs( QgsAttributeEditorContainer *container, const QString &widgetName, const QVariantMap &config );
 
  private:
    void fixLegacyConfig( QDomElement &el ) const;
 
    QExplicitlySharedDataPointer<QgsEditFormConfigPrivate> d;
 
    friend class QgsVectorLayer;
};
 
#endif // QGSEDITFORMCONFIG_H