qgsextentgroupbox.h

Go to the documentation of this file.

/***************************************************************************
    qgsextentgroupbox.h
    ---------------------
    begin                : March 2014
    copyright            : (C) 2014 by Martin Dobias
    email                : wonder dot sk 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 QGSEXTENTGROUPBOX_H
#define QGSEXTENTGROUPBOX_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgscollapsiblegroupbox.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsrectangle.h"
 
class QgsCoordinateReferenceSystem;
class QgsMapLayer;
class QgsExtentWidget;
class QgsMapCanvas;

class GUI_EXPORT QgsExtentGroupBox : public QgsCollapsibleGroupBox
{
    Q_OBJECT
    Q_PROPERTY( QString titleBase READ titleBase WRITE setTitleBase )
 
  public:
    // TODO QGIS 4.0 -- use QgsExtentWidget enum instead

    enum ExtentState
    {
      OriginalExtent,     
      CurrentExtent,      
      UserExtent,         
      ProjectLayerExtent, 
      DrawOnCanvas,       
    };

    explicit QgsExtentGroupBox( QWidget *parent SIP_TRANSFERTHIS = nullptr );

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

    QgsRectangle originalExtent() const;

    QgsCoordinateReferenceSystem originalCrs() const;

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

    QgsRectangle currentExtent() const;

    QgsCoordinateReferenceSystem currentCrs() const;

    void setOutputCrs( const QgsCoordinateReferenceSystem &outputCrs );

    QgsRectangle outputExtent() const;

    QgsCoordinateReferenceSystem outputCrs() const;

    QgsExtentGroupBox::ExtentState extentState() const;

    void setTitleBase( const QString &title );

    QString titleBase() const;

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

    QSize ratio() const;
 
  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 );
 
  signals:

    void extentChanged( const QgsRectangle &r );

    void extentLayerChanged( QgsMapLayer *layer );
 
  private slots:
 
    void groupBoxClicked();
 
    void widgetExtentChanged();
 
    void validationChanged( bool valid );
 
  private:
    void updateTitle();
 
    QgsExtentWidget *mWidget = nullptr;

    QString mTitleBase;
};
 
#endif // QGSEXTENTGROUPBOX_H