QGIS API Documentation 3.39.0-Master (e8f1b343c48)
|
Registry for raster renderers. More...
#include <qgsrasterrendererregistry.h>
Public Member Functions | |
QgsRasterRendererRegistry () | |
Constructor for QgsRasterRendererRegistry. | |
QgsRasterRenderer * | defaultRendererForDrawingStyle (Qgis::RasterDrawingStyle drawingStyle, QgsRasterDataProvider *provider) const |
Creates a default renderer for a raster drawing style (considering user options such as default contrast enhancement). | |
QList< QgsRasterRendererRegistryEntry > | entries () 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. | |
Registry for raster renderers.
QgsRasterRendererRegistry is not usually directly created, but rather accessed through QgsApplication::rasterRendererRegistry().
Definition at line 82 of file qgsrasterrendererregistry.h.
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.
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.
QList< QgsRasterRendererRegistryEntry > QgsRasterRendererRegistry::entries | ( | ) | const |
Returns the list of registered renderers.
Definition at line 105 of file qgsrasterrendererregistry.cpp.
void QgsRasterRendererRegistry::insert | ( | const QgsRasterRendererRegistryEntry & | entry | ) |
Inserts a new entry into the registry.
Definition at line 74 of file qgsrasterrendererregistry.cpp.
void QgsRasterRendererRegistry::insertWidgetFunction | ( | const QString & | rendererName, |
QgsRasterRendererWidgetCreateFunc | func | ||
) |
Sets the widget creation function for a renderer.
Definition at line 80 of file qgsrasterrendererregistry.cpp.
Qgis::RasterRendererCapabilities QgsRasterRendererRegistry::rendererCapabilities | ( | const QString & | rendererName | ) | const |
Returns the capabilities for the renderer with the specified name.
Definition at line 117 of file qgsrasterrendererregistry.cpp.
bool QgsRasterRendererRegistry::rendererData | ( | const QString & | rendererName, |
QgsRasterRendererRegistryEntry & | data | ||
) | const |
Retrieves renderer data from the registry.
Definition at line 89 of file qgsrasterrendererregistry.cpp.
QStringList QgsRasterRendererRegistry::renderersList | ( | ) | const |
Returns a list of the names of registered renderers.
Definition at line 100 of file qgsrasterrendererregistry.cpp.