A widget which allows configuration of a list of labeling engine rules. More...

#include <qgslabelingengineruleswidget.h>

Inheritance diagram for QgsLabelingEngineRulesWidget:

[legend]

Signals
void	changed ()
	Emitted when the rules configured in 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
	QgsLabelingEngineRulesWidget (QWidget *parent=nullptr)
	Constructor for QgsLabelingEngineRulesWidget.

QList< QgsAbstractLabelingEngineRule * >	rules () const
	Returns the rules shown in the widget.

void	setRules (const QList< QgsAbstractLabelingEngineRule * > &rules)
	Sets the rules 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.

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.

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

A widget which allows configuration of a list of labeling engine rules.

This widget allows users to add, remove, and edit the properties of a list of QgsAbstractLabelingEngineRule objects.

See also: QgsLabelingEngineRuleWidget for a widget for configuring a single rule

Since: QGIS 3.40

Definition at line 113 of file qgslabelingengineruleswidget.h.

Constructor & Destructor Documentation

◆ QgsLabelingEngineRulesWidget()

QgsLabelingEngineRulesWidget::QgsLabelingEngineRulesWidget ( QWidget * parent = nullptr )

Constructor for QgsLabelingEngineRulesWidget.

Definition at line 236 of file qgslabelingengineruleswidget.cpp.

Member Function Documentation

◆ changed

void QgsLabelingEngineRulesWidget::changed ( )

signal

Emitted when the rules configured in the widget are changed.

◆ rules()

QList< QgsAbstractLabelingEngineRule * > QgsLabelingEngineRulesWidget::rules ( ) const

Returns the rules shown in the widget.

The caller takes ownership of all returned rules.

Definition at line 264 of file qgslabelingengineruleswidget.cpp.

◆ setRules()

void QgsLabelingEngineRulesWidget::setRules ( const QList< QgsAbstractLabelingEngineRule * > & rules )

Sets the rules to show in the widget.

Ownership is not transferred, an internal copy will be made.

Definition at line 259 of file qgslabelingengineruleswidget.cpp.

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

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

Signals

Public Member Functions