qgsrelationeditorwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsrelationeditorwidget.h
     --------------------------------------
    Date                 : 17.5.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 QGSRELATIONEDITOR_H
#define QGSRELATIONEDITOR_H
 
#include <QWidget>
#include <QToolButton>
#include <QButtonGroup>
#include <QGridLayout>
#include "qobjectuniqueptr.h"
 
#include "qobjectuniqueptr.h"
#include "qgsattributeeditorcontext.h"
#include "qgscollapsiblegroupbox.h"
#include "qgsdualview.h"
#include "qgsrelation.h"
#include "qgsvectorlayerselectionmanager.h"
#include "qgis_gui.h"
 
class QgsFeature;
class QgsVectorLayer;
class QgsVectorLayerTools;
class QgsMapTool;
class QgsMapToolDigitizeFeature;
 
#ifdef SIP_RUN
% ModuleHeaderCode
// fix to allow compilation with sip that for some reason
// doesn't add this include to the file where the code from
// ConvertToSubClassCode goes.
#include <qgsrelationeditorwidget.h>
% End
#endif
 
 
#ifndef SIP_RUN
 
class QgsFilteredSelectionManager : public QgsVectorLayerSelectionManager
{
    Q_OBJECT
 
  public:
    QgsFilteredSelectionManager( QgsVectorLayer *layer, const QgsFeatureRequest &request, QObject *parent = nullptr );
 
    const QgsFeatureIds &selectedFeatureIds() const override;
    int selectedFeatureCount() override;
 
  private slots:
 
    void onSelectionChanged( const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect ) override;
 
  private:
 
    QgsFeatureRequest mRequest;
    QgsFeatureIds mSelectedFeatureIds;
};
#endif
 
 
class GUI_EXPORT QgsRelationEditorWidget : public QgsCollapsibleGroupBox
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsRelationEditorWidget *>( sipCpp ) )
      sipType = sipType_QgsRelationEditorWidget;
    else
      sipType = NULL;
    SIP_END
#endif
 
 
 
    Q_OBJECT
    Q_PROPERTY( QgsDualView::ViewMode viewMode READ viewMode WRITE setViewMode )
    Q_PROPERTY( bool showLabel READ showLabel WRITE setShowLabel )
    Q_PROPERTY( QgsAttributeEditorRelation::Buttons visibleButtons READ visibleButtons WRITE setVisibleButtons )
 
  public:
 
 
    QgsRelationEditorWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
    void setViewMode( QgsDualView::ViewMode mode );
 
    QgsDualView::ViewMode viewMode() {return mViewMode;}
 
    void setRelationFeature( const QgsRelation &relation, const QgsFeature &feature );
 
    void setRelations( const QgsRelation &relation, const QgsRelation &nmrelation );
 
    void setFeature( const QgsFeature &feature, bool update = true );
 
    void setEditorContext( const QgsAttributeEditorContext &context );
 
    QgsAttributeEditorContext editorContext( ) const;
 
    QgsIFeatureSelectionManager *featureSelectionManager();
 
    bool showLabel() const;
 
    void setShowLabel( bool showLabel );
 
    Q_DECL_DEPRECATED bool showLinkButton() const SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED void setShowLinkButton( bool showLinkButton ) SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED bool showUnlinkButton() const SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED void setShowUnlinkButton( bool showUnlinkButton ) SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED void setShowSaveChildEditsButton( bool showChildEdits ) SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED bool showSaveChildEditsButton() const SIP_DEPRECATED;
 
    void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons );
 
    QgsAttributeEditorRelation::Buttons visibleButtons() const;
 
    bool forceSuppressFormPopup() const;
 
    void setForceSuppressFormPopup( bool forceSuppressFormPopup );
 
    QVariant nmRelationId() const;
 
    void setNmRelationId( const QVariant &nmRelationId = QVariant() );
 
    QString label() const;
 
    void setLabel( const QString &label = QString() );
 
    QgsFeature feature() const;
 
  public slots:
 
    void parentFormValueChanged( const QString &attribute, const QVariant &newValue );
 
  private slots:
    void setViewMode( int mode ) {setViewMode( static_cast<QgsDualView::ViewMode>( mode ) );}
    void updateButtons();
 
    void addFeature( const QgsGeometry &geometry = QgsGeometry() );
    void addFeatureGeometry();
    void duplicateFeature();
    void linkFeature();
    void deleteFeature( QgsFeatureId featureid = QgsFeatureId() );
    void deleteSelectedFeatures();
    void unlinkFeature( QgsFeatureId featureid = QgsFeatureId() );
    void unlinkSelectedFeatures();
    void zoomToSelectedFeatures();
    void saveEdits();
    void toggleEditing( bool state );
    void onCollapsedStateChanged( bool collapsed );
    void showContextMenu( QgsActionMenu *menu, QgsFeatureId fid );
    void mapToolDeactivated();
    void onKeyPressed( QKeyEvent *e );
    void onDigitizingCompleted( const QgsFeature &feature );
    void onLinkFeatureDlgAccepted();
 
  private:
    void updateUi();
    void initDualView( QgsVectorLayer *layer, const QgsFeatureRequest &request );
    void setMapTool( QgsMapTool *mapTool );
    void unsetMapTool();
    void updateTitle();
 
    QgsDualView *mDualView = nullptr;
    QPointer<QgsMessageBarItem> mMessageBarItem;
    QgsDualView::ViewMode mViewMode = QgsDualView::AttributeEditor;
    QgsVectorLayerSelectionManager *mFeatureSelectionMgr = nullptr;
    QgsAttributeEditorContext mEditorContext;
    QgsRelation mRelation;
    QgsRelation mNmRelation;
    QgsFeature mFeature;
 
    QToolButton *mToggleEditingButton = nullptr;
    QToolButton *mSaveEditsButton = nullptr;
    QToolButton *mAddFeatureButton = nullptr;
    QToolButton *mDuplicateFeatureButton = nullptr;
    QToolButton *mDeleteFeatureButton = nullptr;
    QToolButton *mLinkFeatureButton = nullptr;
    QToolButton *mUnlinkFeatureButton = nullptr;
    QToolButton *mZoomToFeatureButton = nullptr;
    QToolButton *mFormViewButton = nullptr;
    QToolButton *mTableViewButton = nullptr;
    QToolButton *mAddFeatureGeometryButton = nullptr;
    QGridLayout *mRelationLayout = nullptr;
    QObjectUniquePtr<QgsMapToolDigitizeFeature> mMapToolDigitize;
    QButtonGroup *mViewModeButtonGroup = nullptr;
 
    QgsAttributeEditorRelation::Buttons mButtonsVisibility = QgsAttributeEditorRelation::Button::AllButtons;
    bool mShowLabel = true;
    bool mVisible = false;
    bool mLayerInSameTransactionGroup = false;
 
    bool mForceSuppressFormPopup = false;
    QVariant mNmRelationId;
    QString mLabel;
 
    void deleteFeatures( const QgsFeatureIds &featureids );
 
    void unlinkFeatures( const QgsFeatureIds &featureids );
};
 
 
#endif // QGSRELATIONEDITOR_H