QgsRendererRulePropsWidget Class Reference

#include <qgsrulebasedrendererwidget.h>

Inheritance diagram for QgsRendererRulePropsWidget:

Public Slots
void	apply ()
	Apply any changes from the widget to the set rule.
void	buildExpression ()
	Open the expression builder widget to check if the.
void	setDockMode (bool dockMode) override
	Set the widget in dock mode.
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
	QgsRendererRulePropsWidget (QgsRuleBasedRenderer::Rule *rule, QgsVectorLayer *layer, QgsStyle *style, QWidget *parent=nullptr, const QgsSymbolWidgetContext &context=QgsSymbolWidgetContext())
	Widget to edit the details of a rule based renderer rule.
QgsRuleBasedRenderer::Rule *	rule ()
	Returns the current set rule.
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.

Protected Attributes
QgsSymbolWidgetContext	mContext
QgsVectorLayer *	mLayer = nullptr
QgsRuleBasedRenderer::Rule *	mRule
QgsSymbol *	mSymbol = nullptr
QgsSymbolSelectorWidget *	mSymbolSelector = nullptr

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

Definition at line 200 of file qgsrulebasedrendererwidget.h.

Constructor & Destructor Documentation

QgsRendererRulePropsWidget()

QgsRendererRulePropsWidget::QgsRendererRulePropsWidget	(	QgsRuleBasedRenderer::Rule *	rule,
		QgsVectorLayer *	layer,
		QgsStyle *	style,
		QWidget *	parent = nullptr,
		const QgsSymbolWidgetContext &	context = QgsSymbolWidgetContext()
	)

Widget to edit the details of a rule based renderer rule.

Parameters

rule	The rule to edit.
layer	The layer used to pull layer related information.
style	The active QGIS style.
parent	The parent widget.
context	the symbol widget context

Definition at line 714 of file qgsrulebasedrendererwidget.cpp.

Member Function Documentation

apply

void QgsRendererRulePropsWidget::apply ( )

slot

Apply any changes from the widget to the set rule.

Definition at line 881 of file qgsrulebasedrendererwidget.cpp.

buildExpression

void QgsRendererRulePropsWidget::buildExpression ( )

slot

Open the expression builder widget to check if the.

Definition at line 819 of file qgsrulebasedrendererwidget.cpp.

rule()

QgsRuleBasedRenderer::Rule * QgsRendererRulePropsWidget::rule ( )

inline

Returns the current set rule.

Returns

The current rule.

Definition at line 219 of file qgsrulebasedrendererwidget.h.

setDockMode

void QgsRendererRulePropsWidget::setDockMode ( bool  dockMode )

overrideslot

Set the widget in dock mode.

Parameters

dockMode

true for dock mode.

Definition at line 893 of file qgsrulebasedrendererwidget.cpp.

testFilter

void QgsRendererRulePropsWidget::testFilter ( )

slot

Test the filter that is set in the widget.

Definition at line 836 of file qgsrulebasedrendererwidget.cpp.

Member Data Documentation

mContext

QgsSymbolWidgetContext QgsRendererRulePropsWidget::mContext

protected

Definition at line 251 of file qgsrulebasedrendererwidget.h.

mLayer

QgsVectorLayer* QgsRendererRulePropsWidget::mLayer = nullptr

protected

Definition at line 246 of file qgsrulebasedrendererwidget.h.

mRule

QgsRuleBasedRenderer::Rule* QgsRendererRulePropsWidget::mRule

protected

Definition at line 245 of file qgsrulebasedrendererwidget.h.

mSymbol

QgsSymbol* QgsRendererRulePropsWidget::mSymbol = nullptr

protected

Definition at line 249 of file qgsrulebasedrendererwidget.h.

mSymbolSelector

QgsSymbolSelectorWidget* QgsRendererRulePropsWidget::mSymbolSelector = nullptr

protected

Definition at line 248 of file qgsrulebasedrendererwidget.h.

---

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

• /build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/symbology/qgsrulebasedrendererwidget.h
• /build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/symbology/qgsrulebasedrendererwidget.cpp