QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
Public Slots | Public Member Functions | Static Public Member Functions | List of all members
QgsMultiBandColorRendererWidget Class Reference

#include <qgsmultibandcolorrendererwidget.h>

Inheritance diagram for QgsMultiBandColorRendererWidget:
Inheritance graph
[legend]

Public Slots

void loadMinMax (int bandNo, double min, double max)
 called when new min/max values are loaded More...
 

Public Member Functions

 QgsMultiBandColorRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent=QgsRectangle())
 
QgsContrastEnhancement::ContrastEnhancementAlgorithm contrastEnhancementAlgorithm () const override
 Returns the constrast enhancement algorithm to be used by the raster renderer. More...
 
void doComputations () override
 Load programmatically with current values. More...
 
QString max (int index=0) override
 
QString min (int index=0) override
 
QgsRasterMinMaxWidgetminMaxWidget () override
 Returns min/max widget when it exists. More...
 
QgsRasterRendererrenderer () override
 Creates a new renderer, using the properties defined in the widget. More...
 
int selectedBand (int index=0) override
 
void setContrastEnhancementAlgorithm (QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm) override
 Sets the constrast enhancement algorithm to be used by the raster renderer. More...
 
void setFromRenderer (const QgsRasterRenderer *r)
 Sets the widget state from the specified renderer. More...
 
void setMapCanvas (QgsMapCanvas *canvas) override
 Sets the map canvas associated with the widget. More...
 
void setMax (const QString &value, int index=0) override
 
void setMin (const QString &value, int index=0) override
 
- Public Member Functions inherited from QgsRasterRendererWidget
 QgsRasterRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent)
 
virtual QgsContrastEnhancement::ContrastEnhancementAlgorithm contrastEnhancementAlgorithm () const
 Returns the constrast enhancement algorithm to be used by the raster renderer. More...
 
virtual void doComputations ()
 Load programmatically with current values. More...
 
QgsMapCanvasmapCanvas ()
 Returns the map canvas associated with the widget. More...
 
virtual QString max (int index=0)
 
virtual QString min (int index=0)
 
virtual QgsRasterMinMaxWidgetminMaxWidget ()
 Returns min/max widget when it exists. More...
 
const QgsRasterLayerrasterLayer () const
 Returns the raster layer associated with the widget. More...
 
virtual QgsRasterRendererrenderer ()=0
 Creates a new renderer, using the properties defined in the widget. More...
 
virtual int selectedBand (int index=0)
 
virtual void setContrastEnhancementAlgorithm (QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm)
 Sets the constrast enhancement algorithm to be used by the raster renderer. More...
 
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)
 Sets the raster layer associated with the widget. More...
 
virtual void setStdDev (const QString &value)
 
virtual QString stdDev ()
 

Static Public Member Functions

static QgsRasterRendererWidgetcreate (QgsRasterLayer *layer, const QgsRectangle &extent)
 

Additional Inherited Members

- Signals inherited from QgsRasterRendererWidget
void widgetChanged ()
 Emitted when something on the widget has changed. More...
 
- Protected Attributes inherited from QgsRasterRendererWidget
QgsMapCanvasmCanvas = nullptr
 Associated map canvas. More...
 
QgsRectangle mExtent
 Current extent. More...
 
QgsRasterLayermRasterLayer = nullptr
 

Detailed Description

Definition at line 36 of file qgsmultibandcolorrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsMultiBandColorRendererWidget()

QgsMultiBandColorRendererWidget::QgsMultiBandColorRendererWidget ( QgsRasterLayer layer,
const QgsRectangle extent = QgsRectangle() 
)

Definition at line 25 of file qgsmultibandcolorrendererwidget.cpp.

Member Function Documentation

◆ contrastEnhancementAlgorithm()

QgsContrastEnhancement::ContrastEnhancementAlgorithm QgsMultiBandColorRendererWidget::contrastEnhancementAlgorithm ( ) const
overridevirtual

Returns the constrast enhancement algorithm to be used by the raster renderer.

Since
QGIS 3.26

Reimplemented from QgsRasterRendererWidget.

Definition at line 447 of file qgsmultibandcolorrendererwidget.cpp.

◆ create()

static QgsRasterRendererWidget * QgsMultiBandColorRendererWidget::create ( QgsRasterLayer layer,
const QgsRectangle extent 
)
inlinestatic

Definition at line 42 of file qgsmultibandcolorrendererwidget.h.

◆ doComputations()

void QgsMultiBandColorRendererWidget::doComputations ( )
overridevirtual

Load programmatically with current values.

Reimplemented from QgsRasterRendererWidget.

Definition at line 110 of file qgsmultibandcolorrendererwidget.cpp.

◆ loadMinMax

void QgsMultiBandColorRendererWidget::loadMinMax ( int  bandNo,
double  min,
double  max 
)
slot

called when new min/max values are loaded

Definition at line 253 of file qgsmultibandcolorrendererwidget.cpp.

◆ max()

QString QgsMultiBandColorRendererWidget::max ( int  index = 0)
overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 375 of file qgsmultibandcolorrendererwidget.cpp.

◆ min()

QString QgsMultiBandColorRendererWidget::min ( int  index = 0)
overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 359 of file qgsmultibandcolorrendererwidget.cpp.

◆ minMaxWidget()

QgsRasterMinMaxWidget * QgsMultiBandColorRendererWidget::minMaxWidget ( )
inlineoverridevirtual

Returns min/max widget when it exists.

Reimplemented from QgsRasterRendererWidget.

Definition at line 62 of file qgsmultibandcolorrendererwidget.h.

◆ renderer()

QgsRasterRenderer * QgsMultiBandColorRendererWidget::renderer ( )
overridevirtual

Creates a new renderer, using the properties defined in the widget.

The caller takes ownership of the returned renderer.

Implements QgsRasterRendererWidget.

Definition at line 86 of file qgsmultibandcolorrendererwidget.cpp.

◆ selectedBand()

int QgsMultiBandColorRendererWidget::selectedBand ( int  index = 0)
overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 431 of file qgsmultibandcolorrendererwidget.cpp.

◆ setContrastEnhancementAlgorithm()

void QgsMultiBandColorRendererWidget::setContrastEnhancementAlgorithm ( QgsContrastEnhancement::ContrastEnhancementAlgorithm  algorithm)
overridevirtual

Sets the constrast enhancement algorithm to be used by the raster renderer.

Since
QGIS 3.26

Reimplemented from QgsRasterRendererWidget.

Definition at line 452 of file qgsmultibandcolorrendererwidget.cpp.

◆ setFromRenderer()

void QgsMultiBandColorRendererWidget::setFromRenderer ( const QgsRasterRenderer r)

Sets the widget state from the specified renderer.

Definition at line 324 of file qgsmultibandcolorrendererwidget.cpp.

◆ setMapCanvas()

void QgsMultiBandColorRendererWidget::setMapCanvas ( QgsMapCanvas canvas)
overridevirtual

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
canvasmap canvas
See also
mapCanvas()
Since
QGIS 2.16

Reimplemented from QgsRasterRendererWidget.

Definition at line 115 of file qgsmultibandcolorrendererwidget.cpp.

◆ setMax()

void QgsMultiBandColorRendererWidget::setMax ( const QString &  value,
int  index = 0 
)
overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 411 of file qgsmultibandcolorrendererwidget.cpp.

◆ setMin()

void QgsMultiBandColorRendererWidget::setMin ( const QString &  value,
int  index = 0 
)
overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 391 of file qgsmultibandcolorrendererwidget.cpp.


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