QGIS API Documentation  2.99.0-Master (6a61179)
Signals | Public Member Functions | List of all members
QgsRasterMinMaxWidget Class Reference

#include <qgsrasterminmaxwidget.h>

Inheritance diagram for QgsRasterMinMaxWidget:
Inheritance graph
[legend]

Signals

void load (int theBandNo, double theMin, double theMax, int origin)
 

Public Member Functions

 QgsRasterMinMaxWidget (QgsRasterLayer *theLayer, QWidget *parent=nullptr)
 
 ~QgsRasterMinMaxWidget ()
 
QgsRectangle extent ()
 Return the extent selected by the user. More...
 
void load ()
 
QgsMapCanvasmapCanvas ()
 Returns the map canvas associated with the widget. More...
 
int sampleSize ()
 Return the selected sample size. More...
 
void setBands (const QList< int > &theBands)
 
void setExtent (const QgsRectangle &theExtent)
 Sets the extent to use for minimum and maximum value calculation. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets the map canvas associated with the widget. More...
 

Detailed Description

Definition at line 30 of file qgsrasterminmaxwidget.h.

Constructor & Destructor Documentation

§ QgsRasterMinMaxWidget()

QgsRasterMinMaxWidget::QgsRasterMinMaxWidget ( QgsRasterLayer theLayer,
QWidget *  parent = nullptr 
)

Definition at line 27 of file qgsrasterminmaxwidget.cpp.

§ ~QgsRasterMinMaxWidget()

QgsRasterMinMaxWidget::~QgsRasterMinMaxWidget ( )

Definition at line 53 of file qgsrasterminmaxwidget.cpp.

Member Function Documentation

§ extent()

QgsRectangle QgsRasterMinMaxWidget::extent ( )

Return the extent selected by the user.

Either an empty extent for 'full' or the current visible extent.

Definition at line 67 of file qgsrasterminmaxwidget.cpp.

§ load() [1/2]

void QgsRasterMinMaxWidget::load ( )
inline

Definition at line 71 of file qgsrasterminmaxwidget.h.

§ load [2/2]

void QgsRasterMinMaxWidget::load ( int  theBandNo,
double  theMin,
double  theMax,
int  origin 
)
signal

§ mapCanvas()

QgsMapCanvas * QgsRasterMinMaxWidget::mapCanvas ( )

Returns the map canvas associated with the widget.

See also
setMapCanvas()
canvasExtent()
Note
added in QGIS 2.16

Definition at line 62 of file qgsrasterminmaxwidget.cpp.

§ sampleSize()

int QgsRasterMinMaxWidget::sampleSize ( )
inline

Return the selected sample size.

Definition at line 68 of file qgsrasterminmaxwidget.h.

§ setBands()

void QgsRasterMinMaxWidget::setBands ( const QList< int > &  theBands)
inline

Definition at line 60 of file qgsrasterminmaxwidget.h.

§ setExtent()

void QgsRasterMinMaxWidget::setExtent ( const QgsRectangle theExtent)
inline

Sets the extent to use for minimum and maximum value calculation.

Parameters
theExtentextent in raster layer's CRS
Note
if a map canvas is set using setMapCanvas(), its extent will take precedence over any extent set using this method.

Definition at line 42 of file qgsrasterminmaxwidget.h.

§ setMapCanvas()

void QgsRasterMinMaxWidget::setMapCanvas ( QgsMapCanvas canvas)

Sets the map canvas associated with the widget.

This allows the widget to retrieve the current map extent from the canvas. If a canvas is set it will take precedence over any extent set from calling setExtent().

Parameters
canvasmap canvas
See also
mapCanvas()
Note
added in QGIS 2.16

Definition at line 57 of file qgsrasterminmaxwidget.cpp.


The documentation for this class was generated from the following files: