QGIS API Documentation 3.44.0-Solothurn (5d9ba037df1)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
QgsRasterSingleColorRendererWidget Class Reference

Renderer widget for the single color renderer. More...

#include <qgsrastersinglecolorrendererwidget.h>

Inheritance diagram for QgsRasterSingleColorRendererWidget:
Inheritance graph
[legend]

Public Member Functions

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

Static Public Member Functions

static QgsRasterRendererWidget * create (QgsRasterLayer *layer, const QgsRectangle &extent)
 Widget creation function (use by the renderer registry)
 

Additional Inherited Members

- Signals inherited from QgsRasterRendererWidget
void widgetChanged ()
 Emitted when something on the widget has changed.
 
- Protected Attributes inherited from QgsRasterRendererWidget
QgsMapCanvas * mCanvas = nullptr
 Associated map canvas.
 
QgsRectangle mExtent
 Current extent.
 
QgsRasterLayer * mRasterLayer = nullptr
 

Detailed Description

Renderer widget for the single color renderer.

Since
QGIS 3.38

Definition at line 33 of file qgsrastersinglecolorrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsRasterSingleColorRendererWidget()

QgsRasterSingleColorRendererWidget::QgsRasterSingleColorRendererWidget ( QgsRasterLayer *  layer,
const QgsRectangle &  extent = QgsRectangle() 
)

Constructor for QgsRasterSingleColorRendererWidget.

Parameters
layerassociated raster layer
extentcurrent canvas extent

Definition at line 24 of file qgsrastersinglecolorrendererwidget.cpp.

Member Function Documentation

◆ create()

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

Widget creation function (use by the renderer registry)

Definition at line 45 of file qgsrastersinglecolorrendererwidget.h.

◆ renderer()

QgsRasterRenderer * QgsRasterSingleColorRendererWidget::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 46 of file qgsrastersinglecolorrendererwidget.cpp.

◆ setFromRenderer()

void QgsRasterSingleColorRendererWidget::setFromRenderer ( const QgsRasterRenderer *  r)

Sets the widget state from the specified renderer.

Definition at line 63 of file qgsrastersinglecolorrendererwidget.cpp.


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