QGIS API Documentation  2.99.0-Master (23ddace)
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 bandNo, double min, double max)
 signal emitted when new min/max values are computed from statistics. More...
 
void widgetChanged ()
 Emitted when something on the widget has changed. More...
 

Public Member Functions

 QgsRasterMinMaxWidget (QgsRasterLayer *layer, QWidget *parent=0)
 
void doComputations ()
 Load programmatically with current values. More...
 
QgsRectangle extent ()
 Return the extent selected by the user. More...
 
void hideUpdatedExtent ()
 Hide updated extent choice. More...
 
bool isCollapsed () const
 Return if the widget is collaped. More...
 
QgsMapCanvasmapCanvas ()
 Returns the map canvas associated with the widget. More...
 
QgsRasterMinMaxOrigin minMaxOrigin ()
 Return a QgsRasterMinMaxOrigin object with the widget values. More...
 
int sampleSize ()
 Return the selected sample size. More...
 
void setBands (const QList< int > &bands)
 
void setCollapsed (bool b)
 Set collapsed state of widget. More...
 
void setExtent (const QgsRectangle &extent)
 Sets the extent to use for minimum and maximum value calculation. More...
 
void setFromMinMaxOrigin (const QgsRasterMinMaxOrigin &)
 Set the "source" of min/max values. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets the map canvas associated with the widget. More...
 
void userHasSetManualMinMaxValues ()
 Uncheck cumulative cut, min/max, std-dev radio buttons. More...
 

Detailed Description

Definition at line 36 of file qgsrasterminmaxwidget.h.

Constructor & Destructor Documentation

◆ QgsRasterMinMaxWidget()

QgsRasterMinMaxWidget::QgsRasterMinMaxWidget ( QgsRasterLayer layer,
QWidget *  parent = 0 
)

Definition at line 32 of file qgsrasterminmaxwidget.cpp.

Member Function Documentation

◆ doComputations()

void QgsRasterMinMaxWidget::doComputations ( )

Load programmatically with current values.

Definition at line 175 of file qgsrasterminmaxwidget.cpp.

◆ 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 62 of file qgsrasterminmaxwidget.cpp.

◆ hideUpdatedExtent()

void QgsRasterMinMaxWidget::hideUpdatedExtent ( )

Hide updated extent choice.

Definition at line 236 of file qgsrasterminmaxwidget.cpp.

◆ isCollapsed()

bool QgsRasterMinMaxWidget::isCollapsed ( ) const
inline

Return if the widget is collaped.

Definition at line 91 of file qgsrasterminmaxwidget.h.

◆ load

void QgsRasterMinMaxWidget::load ( int  bandNo,
double  min,
double  max 
)
signal

signal emitted when new min/max values are computed from statistics.

◆ mapCanvas()

QgsMapCanvas * QgsRasterMinMaxWidget::mapCanvas ( )

Returns the map canvas associated with the widget.

See also
setMapCanvas()
canvasExtent()
Since
QGIS 2.16

Definition at line 51 of file qgsrasterminmaxwidget.cpp.

◆ minMaxOrigin()

QgsRasterMinMaxOrigin QgsRasterMinMaxWidget::minMaxOrigin ( )

Return a QgsRasterMinMaxOrigin object with the widget values.

Definition at line 134 of file qgsrasterminmaxwidget.cpp.

◆ sampleSize()

int QgsRasterMinMaxWidget::sampleSize ( )
inline

Return the selected sample size.

Definition at line 73 of file qgsrasterminmaxwidget.h.

◆ setBands()

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

Definition at line 56 of file qgsrasterminmaxwidget.cpp.

◆ setCollapsed()

void QgsRasterMinMaxWidget::setCollapsed ( bool  b)
inline

Set collapsed state of widget.

Definition at line 94 of file qgsrasterminmaxwidget.h.

◆ setExtent()

void QgsRasterMinMaxWidget::setExtent ( const QgsRectangle extent)
inline

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

Parameters
extentextent 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 47 of file qgsrasterminmaxwidget.h.

◆ setFromMinMaxOrigin()

void QgsRasterMinMaxWidget::setFromMinMaxOrigin ( const QgsRasterMinMaxOrigin minMaxOrigin)

Set the "source" of min/max values.

Definition at line 89 of file qgsrasterminmaxwidget.cpp.

◆ 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()
Since
QGIS 2.16

Definition at line 46 of file qgsrasterminmaxwidget.cpp.

◆ userHasSetManualMinMaxValues()

void QgsRasterMinMaxWidget::userHasSetManualMinMaxValues ( )

Uncheck cumulative cut, min/max, std-dev radio buttons.

Definition at line 76 of file qgsrasterminmaxwidget.cpp.

◆ widgetChanged

void QgsRasterMinMaxWidget::widgetChanged ( )
signal

Emitted when something on the widget has changed.

All widgets will fire this event to notify of an internal change.


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