QGIS/python/gui/auto_generated/raster/qgsrasterrendererwidget.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

119 lines
3.4 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/raster/qgsrasterrendererwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsRasterRendererWidget : QWidget
{
%Docstring(signature="appended")
Abstract base class for widgets which configure a
:py:class:`QgsRasterRenderer`.
%End
%TypeHeaderCode
#include "qgsrasterrendererwidget.h"
%End
public:
QgsRasterRendererWidget( QgsRasterLayer *layer, const QgsRectangle &extent );
virtual QgsRasterRenderer *renderer() = 0 /Factory/;
%Docstring
Creates a new renderer, using the properties defined in the widget.
The caller takes ownership of the returned renderer.
%End
void setRasterLayer( QgsRasterLayer *layer );
%Docstring
Sets the raster ``layer`` associated with the widget.
.. seealso:: :py:func:`rasterLayer`
%End
const QgsRasterLayer *rasterLayer() const;
%Docstring
Returns the raster layer associated with the widget.
.. seealso:: :py:func:`setRasterLayer`
%End
virtual void setMapCanvas( QgsMapCanvas *canvas );
%Docstring
Sets the map canvas associated with the widget. This allows the widget
to retrieve the current map extent and other properties from the canvas.
:param canvas: map canvas
.. seealso:: :py:func:`mapCanvas`
%End
QgsMapCanvas *mapCanvas();
%Docstring
Returns the map canvas associated with the widget.
.. seealso:: :py:func:`setMapCanvas`
%End
virtual QString min( int index = 0 );
virtual QString max( int index = 0 );
virtual void setMin( const QString &value, int index = 0 );
virtual void setMax( const QString &value, int index = 0 );
virtual QString stdDev();
virtual void setStdDev( const QString &value );
virtual int selectedBand( int index = 0 );
virtual void doComputations();
%Docstring
Load programmatically with current values
%End
virtual QgsRasterMinMaxWidget *minMaxWidget();
%Docstring
Returns min/max widget when it exists.
%End
virtual QgsContrastEnhancement::ContrastEnhancementAlgorithm contrastEnhancementAlgorithm() const;
%Docstring
Returns the contrast enhancement ``algorithm`` to be used by the raster
renderer.
.. versionadded:: 3.26
%End
virtual void setContrastEnhancementAlgorithm( QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm );
%Docstring
Sets the contrast enhancement ``algorithm`` to be used by the raster
renderer.
.. versionadded:: 3.26
%End
signals:
void widgetChanged();
%Docstring
Emitted when something on the widget has changed. All widgets will fire
this event to notify of an internal change.
%End
protected:
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/raster/qgsrasterrendererwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/