QGIS API Documentation 4.3.0-Master (16649ce5cc6)
Loading...
Searching...
No Matches
QgsPalettedRendererWidget Class Reference

A widget for configuring QgsPalettedRasterRenderer. More...

#include <qgspalettedrendererwidget.h>

Inheritance diagram for QgsPalettedRendererWidget:

Public Member Functions

 QgsPalettedRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent=QgsRectangle())
 Constructor for QgsSingleBandPseudoColorRendererWidget.
 ~QgsPalettedRendererWidget () override
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)

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

A widget for configuring QgsPalettedRasterRenderer.

Definition at line 172 of file qgspalettedrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsPalettedRendererWidget()

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

Constructor for QgsSingleBandPseudoColorRendererWidget.

Parameters
layerassociated raster layer
extentcurrent canvas extent

Definition at line 47 of file qgspalettedrendererwidget.cpp.

◆ ~QgsPalettedRendererWidget()

QgsPalettedRendererWidget::~QgsPalettedRendererWidget ( )
override

Definition at line 135 of file qgspalettedrendererwidget.cpp.

Member Function Documentation

◆ create()

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

Definition at line 184 of file qgspalettedrendererwidget.h.

◆ renderer()

QgsRasterRenderer * QgsPalettedRendererWidget::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 144 of file qgspalettedrendererwidget.cpp.

◆ setFromRenderer()

void QgsPalettedRendererWidget::setFromRenderer ( const QgsRasterRenderer * r)

Sets the widget state from the specified renderer.

Definition at line 157 of file qgspalettedrendererwidget.cpp.


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