QGIS API Documentation  2.99.0-Master (08c2e66)
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]

Signals

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

Public Member Functions

 QgsRasterRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent)
 
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 ()
 Return min/max widget when it exists. More...
 
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 = nullptr
 Associated map canvas. More...
 
QgsRectangle mExtent
 Current extent. More...
 
QgsRasterLayermRasterLayer = nullptr
 

Detailed Description

Definition at line 34 of file qgsrasterrendererwidget.h.

Constructor & Destructor Documentation

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

Definition at line 41 of file qgsrasterrendererwidget.h.

Member Function Documentation

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.

virtual void QgsRasterRendererWidget::doComputations ( )
inlinevirtual

Load programmatically with current values.

Reimplemented in QgsMultiBandColorRendererWidget, QgsSingleBandGrayRendererWidget, and QgsSingleBandPseudoColorRendererWidget.

Definition at line 76 of file qgsrasterrendererwidget.h.

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.

virtual QString QgsRasterRendererWidget::max ( int  index = 0)
inlinevirtual
virtual QString QgsRasterRendererWidget::min ( int  index = 0)
inlinevirtual
virtual QgsRasterMinMaxWidget* QgsRasterRendererWidget::minMaxWidget ( )
inlinevirtual

Return min/max widget when it exists.

Reimplemented in QgsMultiBandColorRendererWidget, QgsSingleBandGrayRendererWidget, and QgsSingleBandPseudoColorRendererWidget.

Definition at line 79 of file qgsrasterrendererwidget.h.

const QgsRasterLayer* QgsRasterRendererWidget::rasterLayer ( ) const
inline

Definition at line 50 of file qgsrasterrendererwidget.h.

virtual QgsRasterRenderer* QgsRasterRendererWidget::renderer ( )
pure virtual
virtual int QgsRasterRendererWidget::selectedBand ( int  index = 0)
inlinevirtual
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 QgsMultiBandColorRendererWidget, QgsSingleBandPseudoColorRendererWidget, and QgsSingleBandGrayRendererWidget.

Definition at line 23 of file qgsrasterrendererwidget.cpp.

virtual void QgsRasterRendererWidget::setMax ( const QString &  value,
int  index = 0 
)
inlinevirtual
virtual void QgsRasterRendererWidget::setMin ( const QString &  value,
int  index = 0 
)
inlinevirtual
void QgsRasterRendererWidget::setRasterLayer ( QgsRasterLayer layer)
inline

Definition at line 49 of file qgsrasterrendererwidget.h.

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

Definition at line 72 of file qgsrasterrendererwidget.h.

virtual QString QgsRasterRendererWidget::stdDev ( )
inlinevirtual

Definition at line 71 of file qgsrasterrendererwidget.h.

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

QgsMapCanvas* QgsRasterRendererWidget::mCanvas = nullptr
protected

Associated map canvas.

Definition at line 98 of file qgsrasterrendererwidget.h.

QgsRectangle QgsRasterRendererWidget::mExtent
protected

Current extent.

Definition at line 95 of file qgsrasterrendererwidget.h.

QgsRasterLayer* QgsRasterRendererWidget::mRasterLayer = nullptr
protected

Definition at line 90 of file qgsrasterrendererwidget.h.


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