QgsLabelingRulePropsWidget Class Reference

Widget for editing a labeling rule. More...

#include <qgsrulebasedlabelingwidget.h>

Inheritance diagram for QgsLabelingRulePropsWidget:

Public Slots
void	apply ()
	Apply any changes from the widget to the set rule.
void	buildExpression ()
	Open the expression builder widget.
void	testFilter ()
	Test the filter that is set in the widget.
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.

Public Member Functions
	QgsLabelingRulePropsWidget (QgsRuleBasedLabeling::Rule *rule, QgsVectorLayer *layer, QWidget *parent=nullptr, QgsMapCanvas *mapCanvas=nullptr)
	constructor
	~QgsLabelingRulePropsWidget () override
QgsRuleBasedLabeling::Rule *	rule ()
	Returns the rule being edited.
void	setDockMode (bool dockMode) override
	Set the widget in dock mode.
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.

Additional Inherited Members
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 QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

Widget for editing a labeling rule.

Note

This class is not a part of public API

Since

QGIS 3.14

Definition at line 163 of file qgsrulebasedlabelingwidget.h.

Constructor & Destructor Documentation

QgsLabelingRulePropsWidget()

QgsLabelingRulePropsWidget::QgsLabelingRulePropsWidget	(	QgsRuleBasedLabeling::Rule *	rule,
		QgsVectorLayer *	layer,
		QWidget *	parent = nullptr,
		QgsMapCanvas *	mapCanvas = nullptr
	)

constructor

Definition at line 654 of file qgsrulebasedlabelingwidget.cpp.

~QgsLabelingRulePropsWidget()

QgsLabelingRulePropsWidget::~QgsLabelingRulePropsWidget ( )

override

Definition at line 714 of file qgsrulebasedlabelingwidget.cpp.

Member Function Documentation

apply

void QgsLabelingRulePropsWidget::apply ( )

slot

Apply any changes from the widget to the set rule.

Definition at line 778 of file qgsrulebasedlabelingwidget.cpp.

buildExpression

void QgsLabelingRulePropsWidget::buildExpression ( )

slot

Open the expression builder widget.

Definition at line 768 of file qgsrulebasedlabelingwidget.cpp.

rule()

QgsRuleBasedLabeling::Rule * QgsLabelingRulePropsWidget::rule ( )

inline

Returns the rule being edited.

Definition at line 173 of file qgsrulebasedlabelingwidget.h.

setDockMode()

void QgsLabelingRulePropsWidget::setDockMode ( bool  dockMode )

overridevirtual

Set the widget in dock mode.

Parameters

dockMode

true for dock mode.

Reimplemented from QgsPanelWidget.

Definition at line 719 of file qgsrulebasedlabelingwidget.cpp.

testFilter

void QgsLabelingRulePropsWidget::testFilter ( )

slot

Test the filter that is set in the widget.

Definition at line 725 of file qgsrulebasedlabelingwidget.cpp.

---

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

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