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.h"
#include <QMap>
#include <QDomElement>
#include <QDomDocument>

#include "qgsattributeeditorelement.h"

class QgsReadWriteContext;
class QgsRelationManager;
class QgsEditFormConfigPrivate;

class CORE_EXPORT QgsEditFormConfig
{
  public:

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

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

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

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

    QgsEditFormConfig( const QgsEditFormConfig &o );
    ~QgsEditFormConfig();

    QgsEditFormConfig &operator=( const QgsEditFormConfig &o );

    bool operator==( const QgsEditFormConfig &o );

    void addTab( QgsAttributeEditorElement *data SIP_TRANSFER );

    QList< QgsAttributeEditorElement * > tabs() const;

    void clearTabs();

    QgsAttributeEditorContainer *invisibleRootContainer();

    EditorLayout layout() const;

    void setLayout( EditorLayout 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 );


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

    PythonInitCodeSource initCodeSource() const;

    void setInitCodeSource( PythonInitCodeSource initCodeSource );

    FeatureFormSuppress suppress() const;
    void setSuppress( FeatureFormSuppress s );

    // Serialization

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

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

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

    explicit QgsEditFormConfig();

  private:

    void setFields( const QgsFields &fields );

    void onRelationsLoaded();

  private:
    QExplicitlySharedDataPointer<QgsEditFormConfigPrivate> d;

    friend class QgsVectorLayer;
};

#endif // QGSEDITFORMCONFIG_H