QgsRendererRasterPropertiesWidget Class Reference

#include <qgsrendererrasterpropertieswidget.h>

Inheritance diagram for QgsRendererRasterPropertiesWidget:

Public Slots
void	apply () override
	Apply the changes from the dialog to the layer. More...
void	rendererChanged ()
	called when user changes renderer type More...
void	syncToLayer (QgsRasterLayer *layer)
	Sync the widget to the given layer. More...
Public Slots inherited from QgsMapLayerConfigWidget
virtual void	apply ()=0
	Called when changes to the layer need to be made. More...
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel. More...
void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event. More...

Public Member Functions
	QgsRendererRasterPropertiesWidget (QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr)
	A widget to hold the renderer properties for a raster layer. More...
QgsRasterRendererWidget *	currentRenderWidget ()
	Returns the active render widget. More...
void	setMapCanvas (QgsMapCanvas *canvas)
	Sets the map canvas associated with the dialog. More...
Public Member Functions inherited from QgsMapLayerConfigWidget
	QgsMapLayerConfigWidget (QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr)
	A panel widget that can be shown in the map style dock. More...
virtual bool	shouldTriggerLayerRepaint () const
	Whether this config widget changes map layer properties in a way that triggerRepaint() should be called for the layer after applying changes. More...
virtual void	syncToLayer (QgsMapLayer *layer)
	Reset to original (vector layer) values. More...
Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel. More...
bool	autoDelete ()
	The the auto delete property on the widget. More...
void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
bool	dockMode ()
	Returns the dock mode state. More...
virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel. More...
QString	panelTitle ()
	The title of the panel. More...
void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget. More...
virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface. More...

Additional Inherited Members
Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user. More...
void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface. More...
void	widgetChanged ()
	Emitted when the widget state changes. More...
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget. More...
Protected Attributes inherited from QgsMapLayerConfigWidget
QgsMapLayer *	mLayer = nullptr
QgsMapCanvas *	mMapCanvas = nullptr

Detailed Description

Definition at line 36 of file qgsrendererrasterpropertieswidget.h.

Constructor & Destructor Documentation

QgsRendererRasterPropertiesWidget()

QgsRendererRasterPropertiesWidget::QgsRendererRasterPropertiesWidget	(	QgsMapLayer *	layer,
		QgsMapCanvas *	canvas,
		QWidget *	parent = nullptr
	)

A widget to hold the renderer properties for a raster layer.

Parameters

layer	The raster layer to style
canvas	The canvas object used to calculate the max and min values from the extent.
parent	Parent object

Definition at line 55 of file qgsrendererrasterpropertieswidget.cpp.

Member Function Documentation

apply

void QgsRendererRasterPropertiesWidget::apply ( )

overrideslot

Apply the changes from the dialog to the layer.

Definition at line 132 of file qgsrendererrasterpropertieswidget.cpp.

currentRenderWidget()

QgsRasterRendererWidget* QgsRendererRasterPropertiesWidget::currentRenderWidget ( )

inline

Returns the active render widget.

Can be nullptr.

Definition at line 61 of file qgsrendererrasterpropertieswidget.h.

rendererChanged

void QgsRendererRasterPropertiesWidget::rendererChanged ( )

slot

called when user changes renderer type

Definition at line 125 of file qgsrendererrasterpropertieswidget.cpp.

setMapCanvas()

void QgsRendererRasterPropertiesWidget::setMapCanvas

(

QgsMapCanvas *

canvas

)

Sets the map canvas associated with the dialog.

This allows the widget to retrieve the current map scale and other properties from the canvas.

Parameters

canvas

map canvas

Since

QGIS 2.12

Definition at line 120 of file qgsrendererrasterpropertieswidget.cpp.

syncToLayer

void QgsRendererRasterPropertiesWidget::syncToLayer ( QgsRasterLayer *  layer )

slot

Sync the widget to the given layer.

Parameters

layer

The layer to use for the widget

Definition at line 170 of file qgsrendererrasterpropertieswidget.cpp.

---

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

• /build/qgis-3.16.0+99unstable/src/gui/raster/qgsrendererrasterpropertieswidget.h
• /build/qgis-3.16.0+99unstable/src/gui/raster/qgsrendererrasterpropertieswidget.cpp