QgsRasterRendererWidget Class Reference

#include <qgsrasterrendererwidget.h>

Inheritance diagram for QgsRasterRendererWidget:

Signals
void	widgetChanged ()
	Emitted when something on the widget has changed. More...

Public Member Functions
	QgsRasterRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent)
virtual void	doComputations ()
	Load programmatically with current values. More...
QgsMapCanvas *	mapCanvas ()
	Returns the map canvas associated with the widget. More...
virtual QString	max (int index=0)
virtual QString	min (int index=0)
virtual QgsRasterMinMaxWidget *	minMaxWidget ()
	Returns min/max widget when it exists. More...
const QgsRasterLayer *	rasterLayer () const
virtual QgsRasterRenderer *	renderer ()=0
virtual int	selectedBand (int index=0)
virtual void	setMapCanvas (QgsMapCanvas *canvas)
	Sets the map canvas associated with the widget. More...
virtual void	setMax (const QString &value, int index=0)
virtual void	setMin (const QString &value, int index=0)
void	setRasterLayer (QgsRasterLayer *layer)
virtual void	setStdDev (const QString &value)
virtual QString	stdDev ()

Protected Attributes
QgsMapCanvas *	mCanvas = nullptr
	Associated map canvas. More...
QgsRectangle	mExtent
	Current extent. More...
QgsRasterLayer *	mRasterLayer = nullptr

Detailed Description

Definition at line 36 of file qgsrasterrendererwidget.h.

Constructor & Destructor Documentation

QgsRasterRendererWidget()

QgsRasterRendererWidget::QgsRasterRendererWidget ( QgsRasterLayer *  layer, const QgsRectangle &  extent  )

inline

Definition at line 43 of file qgsrasterrendererwidget.h.

Member Function Documentation

doComputations()

virtual void QgsRasterRendererWidget::doComputations ( )

inlinevirtual

Load programmatically with current values.

Reimplemented in QgsSingleBandPseudoColorRendererWidget, QgsSingleBandGrayRendererWidget, and QgsMultiBandColorRendererWidget.

Definition at line 78 of file qgsrasterrendererwidget.h.

mapCanvas()

QgsMapCanvas * QgsRasterRendererWidget::mapCanvas

(

)

Returns the map canvas associated with the widget.

See also

setMapCanvas()

Since

QGIS 2.16

Definition at line 28 of file qgsrasterrendererwidget.cpp.

max()

virtual QString QgsRasterRendererWidget::max ( int  index = 0 )

inlinevirtual

Reimplemented in QgsSingleBandGrayRendererWidget, and QgsMultiBandColorRendererWidget.

Definition at line 70 of file qgsrasterrendererwidget.h.

min()

virtual QString QgsRasterRendererWidget::min ( int  index = 0 )

inlinevirtual

Reimplemented in QgsSingleBandGrayRendererWidget, and QgsMultiBandColorRendererWidget.

Definition at line 69 of file qgsrasterrendererwidget.h.

minMaxWidget()

virtual QgsRasterMinMaxWidget* QgsRasterRendererWidget::minMaxWidget ( )

inlinevirtual

Returns min/max widget when it exists.

Reimplemented in QgsSingleBandPseudoColorRendererWidget, QgsSingleBandGrayRendererWidget, and QgsMultiBandColorRendererWidget.

Definition at line 81 of file qgsrasterrendererwidget.h.

rasterLayer()

const QgsRasterLayer* QgsRasterRendererWidget::rasterLayer ( ) const

inline

Definition at line 51 of file qgsrasterrendererwidget.h.

renderer()

virtual QgsRasterRenderer* QgsRasterRendererWidget::renderer ( )

pure virtual

Implemented in QgsSingleBandPseudoColorRendererWidget, QgsSingleBandGrayRendererWidget, QgsRasterContourRendererWidget, QgsPalettedRendererWidget, QgsMultiBandColorRendererWidget, and QgsHillshadeRendererWidget.

selectedBand()

virtual int QgsRasterRendererWidget::selectedBand ( int  index = 0 )

inlinevirtual

Reimplemented in QgsSingleBandGrayRendererWidget, and QgsMultiBandColorRendererWidget.

Definition at line 75 of file qgsrasterrendererwidget.h.

setMapCanvas()

void QgsRasterRendererWidget::setMapCanvas ( QgsMapCanvas *  canvas )

virtual

Sets the map canvas associated with the widget.

This allows the widget to retrieve the current map extent and other properties from the canvas.

Parameters

canvas

map canvas

See also

mapCanvas()

Since

QGIS 2.16

Reimplemented in QgsSingleBandPseudoColorRendererWidget, QgsSingleBandGrayRendererWidget, and QgsMultiBandColorRendererWidget.

Definition at line 23 of file qgsrasterrendererwidget.cpp.

setMax()

virtual void QgsRasterRendererWidget::setMax ( const QString &  value, int  index = 0  )

inlinevirtual

Reimplemented in QgsSingleBandGrayRendererWidget, and QgsMultiBandColorRendererWidget.

Definition at line 72 of file qgsrasterrendererwidget.h.

setMin()

virtual void QgsRasterRendererWidget::setMin ( const QString &  value, int  index = 0  )

inlinevirtual

Reimplemented in QgsSingleBandGrayRendererWidget, and QgsMultiBandColorRendererWidget.

Definition at line 71 of file qgsrasterrendererwidget.h.

setRasterLayer()

void QgsRasterRendererWidget::setRasterLayer ( QgsRasterLayer *  layer )

inline

Definition at line 50 of file qgsrasterrendererwidget.h.

setStdDev()

virtual void QgsRasterRendererWidget::setStdDev ( const QString &  value )

inlinevirtual

Definition at line 74 of file qgsrasterrendererwidget.h.

stdDev()

virtual QString QgsRasterRendererWidget::stdDev ( )

inlinevirtual

Definition at line 73 of file qgsrasterrendererwidget.h.

widgetChanged

void QgsRasterRendererWidget::widgetChanged ( )

signal

Emitted when something on the widget has changed.

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

Member Data Documentation

mCanvas

QgsMapCanvas* QgsRasterRendererWidget::mCanvas = nullptr

protected

Associated map canvas.

Definition at line 98 of file qgsrasterrendererwidget.h.

mExtent

QgsRectangle QgsRasterRendererWidget::mExtent

protected

Current extent.

Definition at line 95 of file qgsrasterrendererwidget.h.

mRasterLayer

QgsRasterLayer* QgsRasterRendererWidget::mRasterLayer = nullptr

protected

Definition at line 92 of file qgsrasterrendererwidget.h.

---

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

• /build/qgis-3.20.0+99unstable/src/gui/raster/qgsrasterrendererwidget.h
• /build/qgis-3.20.0+99unstable/src/gui/raster/qgsrasterrendererwidget.cpp