Widget for configuring rule based labeling. More...

#include <qgsrulebasedlabelingwidget.h>

Inheritance diagram for QgsRuleBasedLabelingWidget:

[legend]

Public Member Functions
	QgsRuleBasedLabelingWidget (QgsVectorLayer layer, QgsMapCanvas canvas, QWidget *parent=nullptr)
	constructor

	~QgsRuleBasedLabelingWidget () override

const QgsRuleBasedLabeling::Rule *	rootRule () const
	Gives access to the internal root of the rule tree.

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

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
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 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 configuring rule based labeling.

Note: This class is not a part of public API

Since: QGIS 3.14

Definition at line 109 of file qgsrulebasedlabelingwidget.h.

Constructor & Destructor Documentation

◆ QgsRuleBasedLabelingWidget()

QgsRuleBasedLabelingWidget::QgsRuleBasedLabelingWidget	(	QgsVectorLayer *	layer,
		QgsMapCanvas *	canvas,
		QWidget *	parent = `nullptr`
	)

constructor

Definition at line 55 of file qgsrulebasedlabelingwidget.cpp.

◆ ~QgsRuleBasedLabelingWidget()

QgsRuleBasedLabelingWidget::~QgsRuleBasedLabelingWidget ( )

override

Definition at line 113 of file qgsrulebasedlabelingwidget.cpp.

Member Function Documentation

◆ rootRule()

const QgsRuleBasedLabeling::Rule * QgsRuleBasedLabelingWidget::rootRule ( ) const

inline

Gives access to the internal root of the rule tree.

Definition at line 118 of file qgsrulebasedlabelingwidget.h.

◆ setDockMode()

void QgsRuleBasedLabelingWidget::setDockMode ( bool dockMode )

overridevirtual

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

Parameters

dockMode true to enable dock mode.

Reimplemented from QgsPanelWidget.

Definition at line 118 of file qgsrulebasedlabelingwidget.cpp.

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

/build/qgis-3.40.0+99sid/src/gui/labeling/qgsrulebasedlabelingwidget.h
/build/qgis-3.40.0+99sid/src/gui/labeling/qgsrulebasedlabelingwidget.cpp

Public Member Functions