QgsLabelingWidget Class Reference

Master widget for configuration of labeling of a vector layer. More...

#include <qgslabelingwidget.h>

Inheritance diagram for QgsLabelingWidget:

Public Slots
void	adaptToLayer ()
	reload the settings shown in the dialog from the current layer
void	apply () override
	Saves the labeling configuration and immediately updates the map canvas to reflect the changes.
void	resetSettings ()
	Reset the settings.
void	setLayer (QgsMapLayer *layer)
	Sets the layer to configure.
void	writeSettingsToLayer ()
	save config to layer
Public Slots inherited from QgsMapLayerConfigWidget
virtual void	apply ()=0
	Called when changes to the layer need to be made.
virtual void	focusDefaultWidget ()
	Focuses the default widget for the page.
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
void	auxiliaryFieldCreated ()
	Emitted when an auxiliary field is created.
Signals inherited from QgsMapLayerConfigWidget
void	dynamicTemporalControlToggled (bool enabled)
	Emitted whenever the dynamic temporal control option is toggled in the associated layer properties dialog.
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
	QgsLabelingWidget (QgsVectorLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr, QgsMessageBar *messageBar=nullptr)
	constructor
QgsLabelingGui *	labelingGui ()
	Returns the labeling gui widget or nullptr if none.
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.
virtual void	setMapLayerConfigWidgetContext (const QgsMapLayerConfigWidgetContext &context)
	Sets the context under which the widget is being shown.
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.
virtual void	syncToLayer (QgsMapLayer *layer)
	Reset to original (vector layer) values.
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.

Additional Inherited Members
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 QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.
Protected Attributes inherited from QgsMapLayerConfigWidget
QgsMapLayer *	mLayer = nullptr
QgsMapCanvas *	mMapCanvas = nullptr
QgsMapLayerConfigWidgetContext	mMapLayerConfigWidgetContext

Detailed Description

Master widget for configuration of labeling of a vector layer.

Note

This class is not a part of public API

Since

QGIS 3.14

Definition at line 44 of file qgslabelingwidget.h.

Constructor & Destructor Documentation

QgsLabelingWidget()

QgsLabelingWidget::QgsLabelingWidget	(	QgsVectorLayer *	layer,
		QgsMapCanvas *	canvas,
		QWidget *	parent = nullptr,
		QgsMessageBar *	messageBar = nullptr
	)

constructor

Definition at line 33 of file qgslabelingwidget.cpp.

Member Function Documentation

adaptToLayer

void QgsLabelingWidget::adaptToLayer ( )

slot

reload the settings shown in the dialog from the current layer

Definition at line 98 of file qgslabelingwidget.cpp.

apply

void QgsLabelingWidget::apply ( )

overrideslot

Saves the labeling configuration and immediately updates the map canvas to reflect the changes.

Definition at line 163 of file qgslabelingwidget.cpp.

auxiliaryFieldCreated

void QgsLabelingWidget::auxiliaryFieldCreated ( )

signal

Emitted when an auxiliary field is created.

labelingGui()

QgsLabelingGui * QgsLabelingWidget::labelingGui

(

)

Returns the labeling gui widget or nullptr if none.

Definition at line 57 of file qgslabelingwidget.cpp.

resetSettings

void QgsLabelingWidget::resetSettings ( )

slot

Reset the settings.

Definition at line 62 of file qgslabelingwidget.cpp.

setLayer

void QgsLabelingWidget::setLayer ( QgsMapLayer *  layer )

slot

Sets the layer to configure.

Definition at line 73 of file qgslabelingwidget.cpp.

writeSettingsToLayer

void QgsLabelingWidget::writeSettingsToLayer ( )

slot

save config to layer

Definition at line 127 of file qgslabelingwidget.cpp.

---

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

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