Base class for widgets which allow control over the properties of QgsAbstractLabelingEngineRule subclasses. More...

#include <qgslabelingenginerulewidget.h>

Inheritance diagram for QgsLabelingEngineRuleWidget:

[legend]

Signals
void	changed ()
	Emitted whenever the configuration of the rule is 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
	QgsLabelingEngineRuleWidget (QWidget *parent=nullptr)
	Constructor for QgsLabelingEngineRuleWidget.

virtual QgsAbstractLabelingEngineRule *	rule ()=0
	Returns the rule defined by the current settings in the widget.

virtual void	setRule (const QgsAbstractLabelingEngineRule *rule)=0
	Sets the rule 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

Base class for widgets which allow control over the properties of QgsAbstractLabelingEngineRule subclasses.

See also: QgsLabelingEngineRulesWidget for a widget for configuring multiple rules; QgsLabelingEngineRuleDialog

Since: QGIS 3.40

Definition at line 41 of file qgslabelingenginerulewidget.h.

Constructor & Destructor Documentation

◆ QgsLabelingEngineRuleWidget()

QgsLabelingEngineRuleWidget::QgsLabelingEngineRuleWidget ( QWidget * parent = nullptr )

inline

Constructor for QgsLabelingEngineRuleWidget.

Definition at line 49 of file qgslabelingenginerulewidget.h.

Member Function Documentation

◆ changed

void QgsLabelingEngineRuleWidget::changed ( )

signal

Emitted whenever the configuration of the rule is changed.

◆ rule()

virtual QgsAbstractLabelingEngineRule * QgsLabelingEngineRuleWidget::rule ( )

pure virtual

Returns the rule defined by the current settings in the widget.

Ownership of the returned object is transferred to the caller

See also: setRule()

◆ setRule()

virtual void QgsLabelingEngineRuleWidget::setRule ( const QgsAbstractLabelingEngineRule * rule )

pure virtual

Sets the rule to show in the widget.

Ownership is not transferred.

See also: rule()

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

/build/qgis-3.42.0+99sid/src/gui/labeling/qgslabelingenginerulewidget.h

Signals

Public Member Functions