qgsdualview.h

Go to the documentation of this file.

/***************************************************************************
    qgsdualview.h
     --------------------------------------
    Date                 : 10.2.2013
    Copyright            : (C) 2013 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 QGSDUALVIEW_H
#define QGSDUALVIEW_H
 
#include "ui_qgsdualviewbase.h"
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsattributeeditorcontext.h"
#include "qgsattributeform.h"
 
#include <QPointer>
#include <QStackedWidget>
#include <QUuid>
 
class QgsFeatureRequest;
class QgsMapLayerAction;
class QgsScrollArea;
class QgsFieldConditionalFormatWidget;
class QgsSettingsEntryBool;
class QgsSettingsEntryInteger;
class QgsSettingsEntryVariant;

class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBase
{
    Q_OBJECT
 
  public:
    static const QgsSettingsEntryBool *settingsFeatureListHighlightFeature SIP_SKIP;
 
    static const QgsSettingsEntryInteger *settingsAttributeTableRowCache SIP_SKIP;

    enum ViewMode
    {

      AttributeTable = 0,

      AttributeEditor = 1
    };
    Q_ENUM( ViewMode )
 
 
    
    enum FeatureListBrowsingAction
    {
      NoAction = 0,  
      PanToFeature,  
      ZoomToFeature, 
    };
    Q_ENUM( FeatureListBrowsingAction )
 
    
    explicit QgsDualView( QWidget *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsDualView() override;

    void init(
      QgsVectorLayer *layer,
      QgsMapCanvas *mapCanvas,
      const QgsFeatureRequest &request = QgsFeatureRequest(),
      const QgsAttributeEditorContext &context = QgsAttributeEditorContext(),
      bool loadFeatures = true,
      bool showFirstFeature = true
    );

    void setView( ViewMode view );

    ViewMode view() const;

    void setFilterMode( Qgis::AttributeTableFilterMode filterMode );

    Qgis::AttributeTableFilterMode filterMode() const;

    void setSelectedOnTop( bool selectedOnTop );

    int featureCount();

    int filteredFeatureCount();

    Q_DECL_DEPRECATED void setFilteredFeatures( const QgsFeatureIds &filteredFeatures );

    void filterFeatures( const QgsExpression &filterExpression, const QgsExpressionContext &context );

    QgsFeatureIds filteredFeatures() const;

    QgsAttributeTableModel *masterModel() const { return mMasterModel; }

    void setRequest( const QgsFeatureRequest &request );

    void setFeatureSelectionManager( QgsIFeatureSelectionManager *featureSelectionManager );

    QgsAttributeTableView *tableView() { return mTableView; }

    void setAttributeTableConfig( const QgsAttributeTableConfig &config );

    void setSortExpression( const QString &sortExpression, Qt::SortOrder sortOrder = Qt::AscendingOrder );

    QString sortExpression() const;

    QgsAttributeTableConfig attributeTableConfig() const;

    static QgsAttributeList requiredAttributes( const QgsVectorLayer *layer );
 
  public slots:

    void setCurrentEditSelection( const QgsFeatureIds &fids );

    bool saveEditChanges();
 
    void openConditionalStyles();

    void setMultiEditEnabled( bool enabled );

    void toggleSearchMode( bool enabled );

    void copyCellContent() const;

    void cancelProgress();

    void parentFormValueChanged( const QString &attribute, const QVariant &value );
 
  signals:

    void displayExpressionChanged( const QString &expression );

    void filterChanged();

    void filterExpressionSet( const QString &expression, QgsAttributeForm::FilterType type );

    void formModeChanged( QgsAttributeEditorContext::Mode mode );

    void showContextMenuExternally( QgsActionMenu *menu, QgsFeatureId fid );
 
  protected:
    void hideEvent( QHideEvent *event ) override;
 
  private slots:
 
    void featureListAboutToChangeEditSelection( bool &ok );

    void featureListCurrentEditSelectionChanged( const QgsFeature &feat );
 
    void previewExpressionBuilder();
 
    void previewColumnChanged( QAction *previewAction, const QString &expression );
 
    void viewWillShowContextMenu( QMenu *menu, const QModelIndex &atIndex );
 
    void widgetWillShowContextMenu( QgsActionMenu *menu, const QModelIndex &atIndex );
 
    void showViewHeaderMenu( QPoint point );
 
    void organizeColumns();
 
    void tableColumnResized( int column, int width );
 
    void hideColumn();
 
    void fieldCalculator();
 
    void resizeColumn();
 
    void resizeAllColumns();
 
    void autosizeColumn();
 
    void autosizeAllColumns();
 
    void previewExpressionChanged( const QString &expression );
 
    void onSortColumnChanged();
 
    void updateSelectedFeatures();
    void updateEditedAddedFeatures();
 
    void extentChanged();

    void featureFormAttributeChanged( const QString &attribute, const QVariant &value, bool attributeChanged );

    virtual void progress( int i, bool &cancel );

    virtual void finished();

    void zoomToCurrentFeature();
    void panToCurrentFeature();
 
    void flashCurrentFeature();
 
    void rebuildFullLayerCache();
 
    void panZoomGroupButtonToggled( QAbstractButton *button, bool checked );
 
    void flashButtonClicked( bool clicked );
 
    void filterError( const QString &errorMessage );
 
  private:
    void initAttributeForm( const QgsFeature &feature );

    void columnBoxInit();
    void initLayerCache( bool cacheGeometry );
    void initModels( QgsMapCanvas *mapCanvas, const QgsFeatureRequest &request, bool loadFeatures );
    void restoreRecentDisplayExpressions();
    void saveRecentDisplayExpressions() const;
    void setDisplayExpression( const QString &expression );
    void insertRecentlyUsedDisplayExpression( const QString &expression );
    void updateEditSelectionProgress( int progress, int count );
    void panOrZoomToFeature( const QgsFeatureIds &featureset );
    void setBrowsingAutoPanScaleAllowed( bool allowed );

    bool modifySort();
 
    static const std::unique_ptr<QgsSettingsEntryVariant> conditionalFormattingSplitterState;
    static const std::unique_ptr<QgsSettingsEntryVariant> attributeEditorSplitterState;
 
    QgsFieldConditionalFormatWidget *mConditionalFormatWidget = nullptr;
    QgsAttributeEditorContext mEditorContext;
    QgsAttributeTableModel *mMasterModel = nullptr;
    QgsAttributeTableFilterModel *mFilterModel = nullptr;
    QgsFeatureListModel *mFeatureListModel = nullptr;
    QgsAttributeForm *mAttributeForm = nullptr;
    QMenu *mPreviewColumnsMenu = nullptr;
    QMenu *mPreviewActionMenu = nullptr;
    QAction *mLastDisplayExpressionAction = nullptr;
    QMenu *mHorizontalHeaderMenu = nullptr;
    QgsVectorLayerCache *mLayerCache = nullptr;
    QPointer<QgsVectorLayer> mLayer = nullptr;
    QProgressDialog *mProgressDlg = nullptr;
    QgsIFeatureSelectionManager *mFeatureSelectionManager = nullptr;
    QString mDisplayExpression;
    QgsAttributeTableConfig mConfig;
    QgsScrollArea *mAttributeEditorScrollArea = nullptr;
    QgsFeatureIds mLastFeatureSet;
    bool mBrowsingAutoPanScaleAllowed = true;
    ViewMode mPreviousView = AttributeTable;
 
    bool mSkipDisplayExpressionChangedSignal = false;
 
    friend class TestQgsDualView;
    friend class TestQgsAttributeTable;
};

class GUI_EXPORT QgsAttributeTableAction : public QAction
{
    Q_OBJECT
 
  public:
    QgsAttributeTableAction( const QString &name, QgsDualView *dualView, QUuid action, const QModelIndex &fieldIdx )
      : QAction( name, dualView )
      , mDualView( dualView )
      , mAction( action )
      , mFieldIdx( fieldIdx )
    {}
 
  public slots:
    void execute();
    void featureForm();
 
  private:
    QgsDualView *mDualView = nullptr;
    QUuid mAction;
    QModelIndex mFieldIdx;
};

class GUI_EXPORT QgsAttributeTableMapLayerAction : public QAction
{
    Q_OBJECT
 
  public:
    QgsAttributeTableMapLayerAction( const QString &name, QgsDualView *dualView, QgsMapLayerAction *action, const QModelIndex &fieldIdx )
      : QAction( name, dualView )
      , mDualView( dualView )
      , mAction( action )
      , mFieldIdx( fieldIdx )
    {}
 
  public slots:
    void execute();
 
  private:
    QgsDualView *mDualView = nullptr;
    QgsMapLayerAction *mAction = nullptr;
    QModelIndex mFieldIdx;
};
 
Q_DECLARE_METATYPE( QModelIndex );
 
#endif // QGSDUALVIEW_H