A widget for customising label obstacle settings. More...

#include <qgslabelobstaclesettingswidget.h>

Inheritance diagram for QgsLabelObstacleSettingsWidget:

[legend]

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

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

void	setSettings (const QgsLabelObstacleSettings &settings)
	Sets the obstacle settings to show in the widget.

QgsLabelObstacleSettings	settings () const
	Returns the obstacle settings defined by the widget.

void	updateDataDefinedProperties (QgsPropertyCollection &properties) override
	Updates a data defined properties collection, correctly setting the values for any properties related to this widget.

Public Member Functions inherited from QgsLabelSettingsWidgetBase
	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.

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

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 QgsLabelSettingsWidgetBase
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.

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.

Protected Member Functions inherited from QgsLabelSettingsWidgetBase
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 inherited from QgsLabelSettingsWidgetBase
QgsPropertyCollection	mDataDefinedProperties
	Contains the data defined properties defined by the widget.

Detailed Description

A widget for customising label obstacle settings.

Since: QGIS 3.12

Definition at line 31 of file qgslabelobstaclesettingswidget.h.

Constructor & Destructor Documentation

◆ QgsLabelObstacleSettingsWidget()

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

Constructor for QgsLabelObstacleSettingsWidget.

Parameters

parent	parent widget
vl	associated vector layer

Definition at line 21 of file qgslabelobstaclesettingswidget.cpp.

Member Function Documentation

◆ setGeometryType()

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

overridevirtual

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

Reimplemented from QgsLabelSettingsWidgetBase.

Definition at line 59 of file qgslabelobstaclesettingswidget.cpp.

◆ setSettings()

void QgsLabelObstacleSettingsWidget::setSettings ( const QgsLabelObstacleSettings & settings )

Sets the obstacle settings to show in the widget.

See also: settings()

Definition at line 43 of file qgslabelobstaclesettingswidget.cpp.

◆ settings()

QgsLabelObstacleSettings QgsLabelObstacleSettingsWidget::settings ( ) const

Returns the obstacle settings defined by the widget.

See also: setSettings()

Definition at line 51 of file qgslabelobstaclesettingswidget.cpp.

◆ updateDataDefinedProperties()

void QgsLabelObstacleSettingsWidget::updateDataDefinedProperties ( QgsPropertyCollection & properties )

overridevirtual

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

See also: setDataDefinedProperties(); dataDefinedProperties()

Reimplemented from QgsLabelSettingsWidgetBase.

Definition at line 65 of file qgslabelobstaclesettingswidget.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/labeling/qgslabelobstaclesettingswidget.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/labeling/qgslabelobstaclesettingswidget.cpp

Public Member Functions

Additional Inherited Members