qgsextentwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsextentwidget.h
    ---------------------
    begin                : March 2020
    copyright            : (C) 2020 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSEXTENTWIDGET_H
#define QGSEXTENTWIDGET_H
 
#include "ui_qgsextentgroupboxwidget.h"
 
#include <memory>
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsmaptool.h"
#include "qgsmaptoolextent.h"
#include "qgsrectangle.h"
 
#include <QRegularExpression>
 
class QgsBookmarkManagerProxyModel;
class QgsCoordinateReferenceSystem;
class QgsMapLayerProxyModel;
class QgsMapLayer;

class GUI_EXPORT QgsExtentWidget : public QWidget, private Ui::QgsExtentGroupBoxWidget
{
    Q_OBJECT
 
  public:
    enum ExtentState
    {
      OriginalExtent,     
      CurrentExtent,      
      UserExtent,         
      ProjectLayerExtent, 
      DrawOnCanvas,       
    };

    enum WidgetStyle
    {
      CondensedStyle, 
      ExpandedStyle,  
    };

    explicit QgsExtentWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr, WidgetStyle style = CondensedStyle );
 
    ~QgsExtentWidget() override;

    void setOriginalExtent( const QgsRectangle &originalExtent, const QgsCoordinateReferenceSystem &originalCrs );

    QgsRectangle originalExtent() const { return mOriginalExtent; }

    QgsCoordinateReferenceSystem originalCrs() const { return mOriginalCrs; }

    void setCurrentExtent( const QgsRectangle &currentExtent, const QgsCoordinateReferenceSystem &currentCrs );

    QgsRectangle currentExtent() const { return mCurrentExtent; }

    QgsCoordinateReferenceSystem currentCrs() const { return mCurrentCrs; }

    void setOutputCrs( const QgsCoordinateReferenceSystem &outputCrs );

    QgsRectangle outputExtent() const;

    QgsCoordinateReferenceSystem outputCrs() const { return mOutputCrs; }

    QgsExtentWidget::ExtentState extentState() const { return mExtentState; }

    void setMapCanvas( QgsMapCanvas *canvas, bool drawOnCanvasOption = true );

    QSize ratio() const { return mRatio; }

    QString extentLayerName() const;

    bool isValid() const;

    void setNullValueAllowed( bool allowed, const QString &notSetText = QString() );
 
  public slots:

    void setOutputExtentFromOriginal();

    void setOutputExtentFromCurrent();

    void setOutputExtentFromUser( const QgsRectangle &extent, const QgsCoordinateReferenceSystem &crs );

    void setOutputExtentFromLayer( const QgsMapLayer *layer );

    void setOutputExtentFromDrawOnCanvas();

    void setRatio( QSize ratio ) { mRatio = ratio; }

    void clear();
 
  signals:

    void extentChanged( const QgsRectangle &r );

    void validationChanged( bool valid );

    void toggleDialogVisibility( bool visible );

    void extentLayerChanged( QgsMapLayer *layer );
 
  protected:
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dragLeaveEvent( QDragLeaveEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
    void showEvent( QShowEvent *event ) override;
 
  private slots:
 
    void layerMenuAboutToShow();
    void layoutMenuAboutToShow();
    void bookmarkMenuAboutToShow();
 
    void extentDrawn( const QgsRectangle &extent );
    void mapToolDeactivated();
 
  private:
    void setOutputExtent( const QgsRectangle &r, const QgsCoordinateReferenceSystem &srcCrs, QgsExtentWidget::ExtentState state );
    void setOutputExtentFromLineEdit();
    void setOutputExtentFromCondensedLineEdit();
 
    ExtentState mExtentState = OriginalExtent;
 
    QgsCoordinateReferenceSystem mOutputCrs;
 
    QgsRectangle mCurrentExtent;
    QgsCoordinateReferenceSystem mCurrentCrs;
 
    QgsRectangle mOriginalExtent;
    QgsCoordinateReferenceSystem mOriginalCrs;
 
    QgsRectangle mOutputExtent;
 
    QMenu *mMenu = nullptr;
 
    QMenu *mLayerMenu = nullptr;
    QMenu *mLayoutMenu = nullptr;
    QMenu *mBookmarkMenu = nullptr;
 
    QgsMapLayerProxyModel *mMapLayerModel = nullptr;
    QgsBookmarkManagerProxyModel *mBookmarkModel = nullptr;
 
    QList<QAction *> mLayerMenuActions;
    QAction *mUseCanvasExtentAction = nullptr;
    QAction *mUseCurrentExtentAction = nullptr;
    QAction *mDrawOnCanvasAction = nullptr;
 
    QPointer<const QgsMapLayer> mExtentLayer;
    QString mExtentLayerName;
 
    std::unique_ptr<QgsMapToolExtent> mMapToolExtent;
    QPointer<QgsMapTool> mMapToolPrevious = nullptr;
    QgsMapCanvas *mCanvas = nullptr;
    QSize mRatio;
 
    bool mIsValid = false;
    bool mHasFixedOutputCrs = false;
 
    QRegularExpression mCondensedRe;
 
    bool mFirstShow = true;
    bool mBlockDrawOnCanvas = false;
 
    void setValid( bool valid );
 
    void setExtentToLayerExtent( const QString &layerId );
 
    QgsMapLayer *mapLayerFromMimeData( const QMimeData *data ) const;
 
    friend class TestProcessingGui;
};
 
#endif // QGSEXTENTWIDGET_H