Base class for widgets which allow customization of label engine properties, such as label placement settings. More...

#include <qgslabelsettingswidgetbase.h>

Inheritance diagram for QgsLabelSettingsWidgetBase:

[legend]

Signals
void	auxiliaryFieldCreated ()
	Emitted when an auxiliary field is created in the widget.

void	changed ()
	Emitted when any of the settings described by the widget are 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.

Public Member Functions
	QgsLabelSettingsWidgetBase (QWidget parent=nullptr, QgsVectorLayer vl=nullptr)
	Constructor for QgsLabelSettingsWidgetBase.

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

QgsPropertyCollection	dataDefinedProperties () const
	Returns the current data defined properties state as specified in the widget.

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

void	setDataDefinedProperties (const QgsPropertyCollection &dataDefinedProperties)
	Sets the current data defined properties to show in the widget.

virtual void	setGeometryType (Qgis::GeometryType type)
	Sets the geometry type of the features to customize the widget accordingly.

virtual void	updateDataDefinedProperties (QgsPropertyCollection &properties)
	Updates a data defined properties collection, correctly setting the values for any properties related to this 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.

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

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

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

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

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
QgsPropertyCollection	mDataDefinedProperties
	Contains the data defined properties defined by the 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.

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.

Detailed Description

Base class for widgets which allow customization of label engine properties, such as label placement settings.

Since: QGIS 3.12

Definition at line 38 of file qgslabelsettingswidgetbase.h.

Constructor & Destructor Documentation

◆ QgsLabelSettingsWidgetBase()

QgsLabelSettingsWidgetBase::QgsLabelSettingsWidgetBase	(	QWidget *	parent = `nullptr`,
		QgsVectorLayer *	vl = `nullptr`
	)

Constructor for QgsLabelSettingsWidgetBase.

Parameters

parent	parent widget
vl	associated vector layer

Definition at line 27 of file qgslabelsettingswidgetbase.cpp.

Member Function Documentation

◆ auxiliaryFieldCreated

void QgsLabelSettingsWidgetBase::auxiliaryFieldCreated ( )

signal

Emitted when an auxiliary field is created in the widget.

◆ changed

void QgsLabelSettingsWidgetBase::changed ( )

signal

Emitted when any of the settings described by the widget are changed.

◆ context()

QgsSymbolWidgetContext QgsLabelSettingsWidgetBase::context ( ) const

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

See also: setContext()

Definition at line 38 of file qgslabelsettingswidgetbase.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsLabelSettingsWidgetBase::createExpressionContext ( ) const

overrideprotectedvirtual

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

Implements QgsExpressionContextGenerator.

Definition at line 48 of file qgslabelsettingswidgetbase.cpp.

◆ dataDefinedProperties()

QgsPropertyCollection QgsLabelSettingsWidgetBase::dataDefinedProperties ( ) const

Returns the current data defined properties state as specified in the widget.

See also: updateDataDefinedProperties(); setDataDefinedProperties()

Definition at line 124 of file qgslabelsettingswidgetbase.cpp.

◆ registerDataDefinedButton()

void QgsLabelSettingsWidgetBase::registerDataDefinedButton	(	QgsPropertyOverrideButton *	button,
		QgsPalLayerSettings::Property	key
	)

protected

Registers a data defined override button.

Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.

Definition at line 146 of file qgslabelsettingswidgetbase.cpp.

◆ setContext()

void QgsLabelSettingsWidgetBase::setContext ( const QgsSymbolWidgetContext & context )

virtual

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

See also: context()

Definition at line 33 of file qgslabelsettingswidgetbase.cpp.

◆ setDataDefinedProperties()

void QgsLabelSettingsWidgetBase::setDataDefinedProperties ( const QgsPropertyCollection & dataDefinedProperties )

Sets the current data defined properties to show in the widget.

See also: dataDefinedProperties()

Definition at line 129 of file qgslabelsettingswidgetbase.cpp.

◆ setGeometryType()

void QgsLabelSettingsWidgetBase::setGeometryType ( Qgis::GeometryType type )

virtual

Sets the geometry type of the features to customize the widget accordingly.

Reimplemented in QgsLabelObstacleSettingsWidget.

Definition at line 43 of file qgslabelsettingswidgetbase.cpp.

◆ updateDataDefinedProperties()

void QgsLabelSettingsWidgetBase::updateDataDefinedProperties ( QgsPropertyCollection & properties )

virtual

Updates a data defined properties collection, correctly setting the values for any properties related to this widget.

See also: setDataDefinedProperties(); dataDefinedProperties()

Reimplemented in QgsLabelLineAnchorWidget, and QgsLabelObstacleSettingsWidget.

Definition at line 141 of file qgslabelsettingswidgetbase.cpp.

Member Data Documentation

◆ mDataDefinedProperties

QgsPropertyCollection QgsLabelSettingsWidgetBase::mDataDefinedProperties

protected

Contains the data defined properties defined by the widget.

Definition at line 118 of file qgslabelsettingswidgetbase.h.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/labeling/qgslabelsettingswidgetbase.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/labeling/qgslabelsettingswidgetbase.cpp

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsLabelSettingsWidgetBase()

Member Function Documentation

◆ auxiliaryFieldCreated

◆ changed

◆ context()

◆ createExpressionContext()

◆ dataDefinedProperties()

◆ registerDataDefinedButton()

◆ setContext()

◆ setDataDefinedProperties()

◆ setGeometryType()

◆ updateDataDefinedProperties()

Member Data Documentation

◆ mDataDefinedProperties