qgsattributesformproperties.h

Go to the documentation of this file.

/***************************************************************************
    qgsattributesformproperties.h
    ---------------------
    begin                : August 2017
    copyright            : (C) 2017 by David Signer
    email                : david 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 QGSATTRIBUTESFORMPROPERTIES_H
#define QGSATTRIBUTESFORMPROPERTIES_H
 
// We don't want to expose this in the public API
#define SIP_NO_FILE
 
#include "ui_qgsattributesformproperties.h"
 
#include "qgis_gui.h"
#include "qgsaction.h"
#include "qgsattributesformmodel.h"
#include "qgsexpressioncontextgenerator.h"
#include "qgsmessagebar.h"
#include "qgspropertycollection.h"
#include "qgssettingstree.h"
#include "qgssettingstreenode.h"
 
#include <QAction>
#include <QClipboard>
#include <QDropEvent>
#include <QFileDialog>
#include <QFormLayout>
#include <QHBoxLayout>
#include <QMenu>
#include <QMessageBox>
#include <QMimeData>
#include <QPlainTextEdit>
#include <QPushButton>
#include <QSpinBox>
#include <QString>
#include <QTreeView>
#include <QWidget>
 
using namespace Qt::StringLiterals;
 
class QgsAttributeFormContainerEdit;
class QgsAttributeTypeDialog;
class QgsAttributeWidgetEdit;
class QgsAttributesFormBaseView;
class QgsFieldConstraintIndicatorProvider;
class QgsFieldDefaultValueIndicatorProvider;
class QgsSourceFieldsProperties;

class GUI_EXPORT QgsAttributesFormProperties : public QWidget, public QgsExpressionContextGenerator, private Ui_QgsAttributesFormProperties
{
    Q_OBJECT
 
  public:
    static inline QgsSettingsTreeNode *sTreeAttributesForm = QgsSettingsTree::sTreeApp->createChildNode( u"attributes-form"_s );
    static const QgsSettingsEntryBool *settingShowAliases;

    explicit QgsAttributesFormProperties( QgsVectorLayer *layer, QWidget *parent = nullptr, QgsSourceFieldsProperties *sourceFieldsProperties = nullptr );
 
    void init();

    void apply();

    void store();
 
    void loadRelations();

    void initAvailableWidgetsView();

    void initFormLayoutView();
 
    void initLayoutConfig();
    void initInitPython();
    void initSuppressCombo();

    void initAvailableWidgetsActions( const QList< QgsAction > actions );
 
    QgsExpressionContext createExpressionContext() const override;
 
  protected:
    void updateButtons();
 
    QgsVectorLayer *mLayer = nullptr;
 
    QgsAttributesFormBaseView *mAvailableWidgetsView = nullptr;
    QgsAttributesFormBaseView *mFormLayoutView = nullptr;
 
    QgsAttributeWidgetEdit *mAttributeWidgetEdit = nullptr;
    QgsAttributeTypeDialog *mAttributeTypeDialog = nullptr;
    QgsAttributeFormContainerEdit *mAttributeContainerEdit = nullptr;
    QLabel *mInfoTextWidget = nullptr;
 
  private slots:
    void addContainer();
    void removeTabOrGroupButton();
    void mEditorLayoutComboBox_currentIndexChanged( int index );
    void pbnSelectEditForm_clicked();
    void mTbInitCode_clicked();
    void toggleShowAliases( bool checked );

    void onInvertSelectionButtonClicked( bool checked );
 
    void loadAttributeSpecificEditor( QgsAttributesFormBaseView *emitter, QgsAttributesFormBaseView *receiver, QModelIndex &deselectedFormLayoutIndex );
    void onAttributeSelectionChanged( const QItemSelection &selected, const QItemSelection &deselected );
    void onFormLayoutSelectionChanged( const QItemSelection &selected, const QItemSelection &deselected );

    void onContextMenuRequested( QPoint );
 
    void updatedFields();
 
    void updateFilteredItems( const QString &filterText );
 
    void previewForm();
 
  private:
    void clearAttributeTypeFrame();
 
    void loadAttributeWidgetEdit();

    void storeAttributeWidgetEdit();

    void storeAttributeContainerEdit();

    void storeAttributeWidgetEdit( const QModelIndex &index );
    void storeAttributeContainerEdit( const QModelIndex &index );
 
    void loadAttributeTypeDialog();
    void loadAttributeTypeDialogFromConfiguration( const QgsAttributesFormData::FieldConfig &cfg );
    void storeAttributeTypeDialog();
 
    void loadAttributeContainerEdit();
 
    void loadInfoWidget( const QString &infoText );
 
    void copyWidgetConfiguration();
    void pasteWidgetConfiguration();
 
    void setAvailableWidgetsIndicatorProvidersEnabled( bool enabled );
    void setFormLayoutIndicatorProvidersEnabled( bool enabled );
 
    void applyToLayer( QgsVectorLayer *layer );
 
    QgsAttributesAvailableWidgetsModel *mAvailableWidgetsModel = nullptr;
    QgsAttributesFormLayoutModel *mFormLayoutModel = nullptr;
    QgsAttributesFormProxyModel *mAvailableWidgetsProxyModel = nullptr;
    QgsAttributesFormProxyModel *mFormLayoutProxyModel = nullptr;
 
    QgsMessageBar *mMessageBar = nullptr;
 
    Qgis::AttributeFormPythonInitCodeSource mInitCodeSource = Qgis::AttributeFormPythonInitCodeSource::NoSource;
    QString mInitFunction;
    QString mInitFilePath;
    QString mInitCode;
    int mBlockUpdates = 0;

    QMenu *mAvailableWidgetsContextMenu = nullptr;
    QAction *mActionCopyWidgetConfiguration = nullptr;
    QAction *mActionPasteWidgetConfiguration = nullptr;

    QgsFieldConstraintIndicatorProvider *mConstraintIndicatorProviderAvailableWidgets = nullptr;
    QgsFieldDefaultValueIndicatorProvider *mDefaultValueIndicatorProviderAvailableWidgets = nullptr;
    QgsFieldConstraintIndicatorProvider *mConstraintIndicatorProviderFormLayout = nullptr;
    QgsFieldDefaultValueIndicatorProvider *mDefaultValueIndicatorProviderFormLayout = nullptr;
 
    QgsSourceFieldsProperties *mSourceFieldsProperties = nullptr;
 
    friend class TestQgsAttributesFormProperties;
};
 
#endif // QGSATTRIBUTESFORMPROPERTIES_H