QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Slots | Public Member Functions | Static Public Member Functions | List of all members
QgsSingleBandGrayRendererWidget Class Reference

#include <qgssinglebandgrayrendererwidget.h>

Inheritance diagram for QgsSingleBandGrayRendererWidget:
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

 QgsSingleBandGrayRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent=QgsRectangle())
 
QgsContrastEnhancement::ContrastEnhancementAlgorithm contrastEnhancementAlgorithm () const override
 Returns the contrast 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 contrast 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)
 
QgsMapCanvasmapCanvas ()
 Returns the map canvas associated with the widget. More...
 
const QgsRasterLayerrasterLayer () const
 Returns the raster layer associated with the widget. More...
 
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 33 of file qgssinglebandgrayrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsSingleBandGrayRendererWidget()

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

Definition at line 26 of file qgssinglebandgrayrendererwidget.cpp.

Member Function Documentation

◆ contrastEnhancementAlgorithm()

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

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

Since
QGIS 3.26

Reimplemented from QgsRasterRendererWidget.

Definition at line 255 of file qgssinglebandgrayrendererwidget.cpp.

◆ create()

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

Definition at line 39 of file qgssinglebandgrayrendererwidget.h.

◆ doComputations()

void QgsSingleBandGrayRendererWidget::doComputations ( )
overridevirtual

Load programmatically with current values.

Reimplemented from QgsRasterRendererWidget.

Definition at line 111 of file qgssinglebandgrayrendererwidget.cpp.

◆ loadMinMax

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

called when new min/max values are loaded

Definition at line 147 of file qgssinglebandgrayrendererwidget.cpp.

◆ max()

QString QgsSingleBandGrayRendererWidget::max ( int  index = 0)
inlineoverridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 50 of file qgssinglebandgrayrendererwidget.h.

◆ min()

QString QgsSingleBandGrayRendererWidget::min ( int  index = 0)
inlineoverridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 49 of file qgssinglebandgrayrendererwidget.h.

◆ minMaxWidget()

QgsRasterMinMaxWidget* QgsSingleBandGrayRendererWidget::minMaxWidget ( )
inlineoverridevirtual

Returns min/max widget when it exists.

Reimplemented from QgsRasterRendererWidget.

Definition at line 59 of file qgssinglebandgrayrendererwidget.h.

◆ renderer()

QgsRasterRenderer * QgsSingleBandGrayRendererWidget::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 81 of file qgssinglebandgrayrendererwidget.cpp.

◆ selectedBand()

int QgsSingleBandGrayRendererWidget::selectedBand ( int  index = 0)
inlineoverridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 53 of file qgssinglebandgrayrendererwidget.h.

◆ setContrastEnhancementAlgorithm()

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

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

Since
QGIS 3.26

Reimplemented from QgsRasterRendererWidget.

Definition at line 260 of file qgssinglebandgrayrendererwidget.cpp.

◆ setFromRenderer()

void QgsSingleBandGrayRendererWidget::setFromRenderer ( const QgsRasterRenderer r)

Sets the widget state from the specified renderer.

Definition at line 182 of file qgssinglebandgrayrendererwidget.cpp.

◆ setMapCanvas()

void QgsSingleBandGrayRendererWidget::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()

Reimplemented from QgsRasterRendererWidget.

Definition at line 116 of file qgssinglebandgrayrendererwidget.cpp.

◆ setMax()

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

Reimplemented from QgsRasterRendererWidget.

Definition at line 219 of file qgssinglebandgrayrendererwidget.cpp.

◆ setMin()

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

Reimplemented from QgsRasterRendererWidget.

Definition at line 212 of file qgssinglebandgrayrendererwidget.cpp.


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