QgsRasterMinMaxWidget Class Reference

#include <qgsrasterminmaxwidget.h>

Inheritance diagram for QgsRasterMinMaxWidget:

Signals
void	load (int bandNo, double min, double max)
	signal emitted when new min/max values are computed from statistics.
void	widgetChanged ()
	Emitted when something on the widget has changed.

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

Detailed Description

Definition at line 37 of file qgsrasterminmaxwidget.h.

Constructor & Destructor Documentation

QgsRasterMinMaxWidget()

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

Constructor for QgsRasterMinMaxWidget.

Definition at line 32 of file qgsrasterminmaxwidget.cpp.

Member Function Documentation

doComputations()

void QgsRasterMinMaxWidget::doComputations

(

)

Load programmatically with current values.

Definition at line 185 of file qgsrasterminmaxwidget.cpp.

extent()

QgsRectangle QgsRasterMinMaxWidget::extent

(

)

Returns the extent selected by the user.

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

Definition at line 74 of file qgsrasterminmaxwidget.cpp.

hideUpdatedExtent()

void QgsRasterMinMaxWidget::hideUpdatedExtent

(

)

Hide updated extent choice.

Definition at line 248 of file qgsrasterminmaxwidget.cpp.

isCollapsed()

bool QgsRasterMinMaxWidget::isCollapsed ( ) const

inline

Returns if the widget is collaped.

Definition at line 95 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()

Definition at line 63 of file qgsrasterminmaxwidget.cpp.

minMaxOrigin()

QgsRasterMinMaxOrigin QgsRasterMinMaxWidget::minMaxOrigin

(

)

Returns a QgsRasterMinMaxOrigin object with the widget values.

Definition at line 144 of file qgsrasterminmaxwidget.cpp.

sampleSize()

int QgsRasterMinMaxWidget::sampleSize ( )

inline

Returns the selected sample size.

Definition at line 77 of file qgsrasterminmaxwidget.h.

setBands()

void QgsRasterMinMaxWidget::setBands

(

const QList< int > &

bands

)

Definition at line 68 of file qgsrasterminmaxwidget.cpp.

setCollapsed()

void QgsRasterMinMaxWidget::setCollapsed ( bool  b )

inline

Sets collapsed state of widget.

Definition at line 98 of file qgsrasterminmaxwidget.h.

setExtent()

void QgsRasterMinMaxWidget::setExtent ( const QgsRectangle &  extent )

inline

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

Parameters

extent

extent 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 51 of file qgsrasterminmaxwidget.h.

setFromMinMaxOrigin()

void QgsRasterMinMaxWidget::setFromMinMaxOrigin

(

const QgsRasterMinMaxOrigin &

minMaxOrigin

)

Sets the "source" of min/max values.

Definition at line 101 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

canvas

map canvas

See also

mapCanvas()

Definition at line 58 of file qgsrasterminmaxwidget.cpp.

userHasSetManualMinMaxValues()

void QgsRasterMinMaxWidget::userHasSetManualMinMaxValues

(

)

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

Definition at line 88 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:

• /build/qgis-3.40.0+99sid/src/gui/raster/qgsrasterminmaxwidget.h
• /build/qgis-3.40.0+99sid/src/gui/raster/qgsrasterminmaxwidget.cpp