QGIS API Documentation  2.99.0-Master (6a61179)
Public Types | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsRasterRendererWidget Class Referenceabstract

#include <qgsrasterrendererwidget.h>

Inheritance diagram for QgsRasterRendererWidget:
Inheritance graph
[legend]

Public Types

enum  LoadMinMaxAlgo { Estimate, Actual, CurrentExtent, CumulativeCut }
 

Signals

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

Public Member Functions

 QgsRasterRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent)
 
virtual ~QgsRasterRendererWidget ()
 
QgsMapCanvasmapCanvas ()
 Returns the map canvas associated with the widget. More...
 
virtual QString max (int index=0)
 
virtual QString min (int index=0)
 
const QgsRasterLayerrasterLayer () const
 
virtual QgsRasterRendererrenderer ()=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 Member Functions

QString displayBandName (int band) const
 Returns a band name for display. First choice is color name, otherwise band number. More...
 

Protected Attributes

QgsMapCanvasmCanvas
 Associated map canvas. More...
 
QgsRectangle mExtent
 Current extent. More...
 
QgsRasterLayermRasterLayer
 

Detailed Description

Definition at line 32 of file qgsrasterrendererwidget.h.

Member Enumeration Documentation

§ LoadMinMaxAlgo

Enumerator
Estimate 
Actual 
CurrentExtent 
CumulativeCut 

Definition at line 47 of file qgsrasterrendererwidget.h.

Constructor & Destructor Documentation

§ QgsRasterRendererWidget()

QgsRasterRendererWidget::QgsRasterRendererWidget ( QgsRasterLayer layer,
const QgsRectangle extent 
)
inline

Definition at line 39 of file qgsrasterrendererwidget.h.

§ ~QgsRasterRendererWidget()

virtual QgsRasterRendererWidget::~QgsRasterRendererWidget ( )
inlinevirtual

Definition at line 45 of file qgsrasterrendererwidget.h.

Member Function Documentation

§ displayBandName()

QString QgsRasterRendererWidget::displayBandName ( int  band) const
protected

Returns a band name for display. First choice is color name, otherwise band number.

Definition at line 33 of file qgsrasterrendererwidget.cpp.

§ mapCanvas()

QgsMapCanvas * QgsRasterRendererWidget::mapCanvas ( )

Returns the map canvas associated with the widget.

See also
setMapCanvas()
canvasExtent()
Note
added in QGIS 2.16

Definition at line 28 of file qgsrasterrendererwidget.cpp.

§ max()

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

§ min()

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

§ rasterLayer()

const QgsRasterLayer* QgsRasterRendererWidget::rasterLayer ( ) const
inline

Definition at line 58 of file qgsrasterrendererwidget.h.

§ renderer()

virtual QgsRasterRenderer* QgsRasterRendererWidget::renderer ( )
pure virtual

§ selectedBand()

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

§ 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
canvasmap canvas
See also
mapCanvas()
Note
added in QGIS 2.16

Reimplemented in QgsSingleBandPseudoColorRendererWidget, QgsMultiBandColorRendererWidget, and QgsSingleBandGrayRendererWidget.

Definition at line 23 of file qgsrasterrendererwidget.cpp.

§ setMax()

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

§ setMin()

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

§ setRasterLayer()

void QgsRasterRendererWidget::setRasterLayer ( QgsRasterLayer layer)
inline

Definition at line 57 of file qgsrasterrendererwidget.h.

§ setStdDev()

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

Definition at line 80 of file qgsrasterrendererwidget.h.

§ stdDev()

virtual QString QgsRasterRendererWidget::stdDev ( )
inlinevirtual

Definition at line 79 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
protected

Associated map canvas.

Definition at line 100 of file qgsrasterrendererwidget.h.

§ mExtent

QgsRectangle QgsRasterRendererWidget::mExtent
protected

Current extent.

Definition at line 97 of file qgsrasterrendererwidget.h.

§ mRasterLayer

QgsRasterLayer* QgsRasterRendererWidget::mRasterLayer
protected

Definition at line 92 of file qgsrasterrendererwidget.h.


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