QGIS API Documentation 3.37.0-Master (684a802617f)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsRasterRendererRegistry Class Reference

Registry for raster renderers. More...

#include <qgsrasterrendererregistry.h>

Public Member Functions

 QgsRasterRendererRegistry ()
 Constructor for QgsRasterRendererRegistry.
 
QgsRasterRendererdefaultRendererForDrawingStyle (Qgis::RasterDrawingStyle drawingStyle, QgsRasterDataProvider *provider) const
 Creates a default renderer for a raster drawing style (considering user options such as default contrast enhancement).
 
QList< QgsRasterRendererRegistryEntryentries () const
 Returns the list of registered renderers.
 
void insert (const QgsRasterRendererRegistryEntry &entry)
 Inserts a new entry into the registry.
 
void insertWidgetFunction (const QString &rendererName, QgsRasterRendererWidgetCreateFunc func)
 Sets the widget creation function for a renderer.
 
Qgis::RasterRendererCapabilities rendererCapabilities (const QString &rendererName) const
 Returns the capabilities for the renderer with the specified name.
 
bool rendererData (const QString &rendererName, QgsRasterRendererRegistryEntry &data) const
 Retrieves renderer data from the registry.
 
QStringList renderersList () const
 Returns a list of the names of registered renderers.
 

Detailed Description

Registry for raster renderers.

QgsRasterRendererRegistry is not usually directly created, but rather accessed through QgsApplication::rasterRendererRegistry().

Note
Exposed to Python bindings in QGIS 3.38

Definition at line 85 of file qgsrasterrendererregistry.h.

Constructor & Destructor Documentation

◆ QgsRasterRendererRegistry()

QgsRasterRendererRegistry::QgsRasterRendererRegistry ( )

Constructor for QgsRasterRendererRegistry.

QgsRasterRendererRegistry is not usually directly created, but rather accessed through QgsApplication::rasterRendererRegistry().

The registry is pre-populated with standard raster renderers.

Definition at line 53 of file qgsrasterrendererregistry.cpp.

Member Function Documentation

◆ defaultRendererForDrawingStyle()

QgsRasterRenderer * QgsRasterRendererRegistry::defaultRendererForDrawingStyle ( Qgis::RasterDrawingStyle  drawingStyle,
QgsRasterDataProvider provider 
) const

Creates a default renderer for a raster drawing style (considering user options such as default contrast enhancement).

Caller takes ownership.

Definition at line 127 of file qgsrasterrendererregistry.cpp.

◆ entries()

QList< QgsRasterRendererRegistryEntry > QgsRasterRendererRegistry::entries ( ) const

Returns the list of registered renderers.

Note
Not available in Python bindings

Definition at line 105 of file qgsrasterrendererregistry.cpp.

◆ insert()

void QgsRasterRendererRegistry::insert ( const QgsRasterRendererRegistryEntry entry)

Inserts a new entry into the registry.

Note
Not available in Python bindings

Definition at line 74 of file qgsrasterrendererregistry.cpp.

◆ insertWidgetFunction()

void QgsRasterRendererRegistry::insertWidgetFunction ( const QString &  rendererName,
QgsRasterRendererWidgetCreateFunc  func 
)

Sets the widget creation function for a renderer.

Note
Not available in Python bindings

Definition at line 80 of file qgsrasterrendererregistry.cpp.

◆ rendererCapabilities()

Qgis::RasterRendererCapabilities QgsRasterRendererRegistry::rendererCapabilities ( const QString &  rendererName) const

Returns the capabilities for the renderer with the specified name.

Since
QGIS 3.38

Definition at line 117 of file qgsrasterrendererregistry.cpp.

◆ rendererData()

bool QgsRasterRendererRegistry::rendererData ( const QString &  rendererName,
QgsRasterRendererRegistryEntry data 
) const

Retrieves renderer data from the registry.

Note
Not available in Python bindings

Definition at line 89 of file qgsrasterrendererregistry.cpp.

◆ renderersList()

QStringList QgsRasterRendererRegistry::renderersList ( ) const

Returns a list of the names of registered renderers.

Definition at line 100 of file qgsrasterrendererregistry.cpp.


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