A widget which allows configuration of the properties for a QgsPointClusterRenderer. More...

#include <qgspointclusterrendererwidget.h>

Inheritance diagram for QgsPointClusterRendererWidget:

[legend]

Public Member Functions
	QgsPointClusterRendererWidget (QgsVectorLayer layer, QgsStyle style, QgsFeatureRenderer *renderer)
	Constructor for QgsPointClusterRendererWidget.

	~QgsPointClusterRendererWidget () override

QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.

QgsFeatureRenderer *	renderer () override
	Returns pointer to the renderer (no transfer of ownership)

void	setContext (const QgsSymbolWidgetContext &context) override
	Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

Public Member Functions inherited from QgsRendererWidget
	QgsRendererWidget (QgsVectorLayer layer, QgsStyle style)

void	applyChanges ()
	This method should be called whenever the renderer is actually set on the layer.

QgsSymbolWidgetContext	context () const
	Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.

virtual void	disableSymbolLevels ()
	Disables symbol level modification on the widget.

void	setDockMode (bool dockMode) override
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

void	showSymbolLevelsDialog (QgsFeatureRenderer *r)
	Show a dialog with renderer's symbol level settings.

const QgsVectorLayer *	vectorLayer () const
	Returns the vector layer associated with the widget.

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel.

virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.

bool	autoDelete ()
	The the auto delete property on the widget.

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.

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.

bool	dockMode ()
	Returns the dock mode state.

virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required.

virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.

QString	panelTitle ()
	The title of the panel.

void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.

void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.

Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Static Public Member Functions
static QgsRendererWidget *	create (QgsVectorLayer layer, QgsStyle style, QgsFeatureRenderer *renderer)
	Returns a new QgsPointClusterRendererWidget.

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.

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.

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.

Signals inherited from QgsRendererWidget
void	layerVariablesChanged ()
	Emitted when expression context variables on the associated vector layers have been changed.

Q_DECL_DEPRECATED void	symbolLevelsChanged ()
	Emitted when the symbol levels settings have been changed.

Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.

void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.

void	widgetChanged ()
	Emitted when the widget state changes.

Protected Slots inherited from QgsRendererWidget
void	changeSymbolAngle ()
	Change marker angles of selected symbols.

void	changeSymbolColor ()
	Change color of selected symbols.

void	changeSymbolOpacity ()
	Change opacity of selected symbols.

void	changeSymbolSize ()
	Change marker sizes of selected symbols.

void	changeSymbolUnit ()
	Change units mm/map units of selected symbols.

void	changeSymbolWidth ()
	Change line widths of selected symbols.

void	contextMenuViewCategories (QPoint p)

virtual void	copy ()

virtual void	paste ()

virtual void	pasteSymbolToSelection ()
	Pastes the clipboard symbol over selected items.

Protected Member Functions inherited from QgsRendererWidget
QgsDataDefinedSizeLegendWidget *	createDataDefinedSizeLegendWidget (const QgsMarkerSymbol symbol, const QgsDataDefinedSizeLegend ddsLegend)
	Creates widget to setup data-defined size legend.

virtual void	refreshSymbolView ()

void	registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsFeatureRenderer::Property key)
	Registers a data defined override button.

virtual QList< QgsSymbol * >	selectedSymbols ()
	Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&).

virtual void	setSymbolLevels (const QList< QgsLegendSymbolItem > &levels, bool enabled)
	Sets the symbol levels for the renderer defined in the widget.

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Protected Attributes inherited from QgsRendererWidget
QMenu *	contextMenu = nullptr

QgsSymbolWidgetContext	mContext
	Context in which widget is shown.

QAction *	mCopyAction = nullptr

QAction *	mCopySymbolAction = nullptr
	Copy symbol action.

QgsVectorLayer *	mLayer = nullptr

QAction *	mPasteAction = nullptr

QAction *	mPasteSymbolAction = nullptr
	Paste symbol action.

QgsStyle *	mStyle = nullptr

Detailed Description

A widget which allows configuration of the properties for a QgsPointClusterRenderer.

Definition at line 35 of file qgspointclusterrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsPointClusterRendererWidget()

QgsPointClusterRendererWidget::QgsPointClusterRendererWidget	(	QgsVectorLayer *	layer,
		QgsStyle *	style,
		QgsFeatureRenderer *	renderer
	)

Constructor for QgsPointClusterRendererWidget.

Parameters

layer	associated vector layer
style	style collection
renderer	source QgsPointClusterRenderer renderer

Definition at line 33 of file qgspointclusterrendererwidget.cpp.

◆ ~QgsPointClusterRendererWidget()

QgsPointClusterRendererWidget::~QgsPointClusterRendererWidget ( )

overridedefault

Member Function Documentation

◆ create()

QgsRendererWidget * QgsPointClusterRendererWidget::create	(	QgsVectorLayer *	layer,
		QgsStyle *	style,
		QgsFeatureRenderer *	renderer
	)

static

Returns a new QgsPointClusterRendererWidget.

Parameters

layer	associated vector layer
style	style collection
renderer	source QgsPointClusterRenderer renderer

Returns: new QgsRendererWidget

Definition at line 28 of file qgspointclusterrendererwidget.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsPointClusterRendererWidget::createExpressionContext ( ) const

overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 199 of file qgspointclusterrendererwidget.cpp.

◆ renderer()

QgsFeatureRenderer * QgsPointClusterRendererWidget::renderer ( )

overridevirtual

Returns pointer to the renderer (no transfer of ownership)

Implements QgsRendererWidget.

Definition at line 114 of file qgspointclusterrendererwidget.cpp.

◆ setContext()

void QgsPointClusterRendererWidget::setContext ( const QgsSymbolWidgetContext & context )

overridevirtual

Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

Parameters

context symbol widget context

See also: context()

Reimplemented from QgsRendererWidget.

Definition at line 119 of file qgspointclusterrendererwidget.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/symbology/qgspointclusterrendererwidget.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/symbology/qgspointclusterrendererwidget.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsPointClusterRendererWidget()

◆ ~QgsPointClusterRendererWidget()

Member Function Documentation

◆ create()

◆ createExpressionContext()

◆ renderer()

◆ setContext()