QgsEditConditionalFormatRuleWidget Class Reference

A widget for customizing an individual conditional formatting rule. More...

#include <qgsfieldconditionalformatwidget.h>

Inheritance diagram for QgsEditConditionalFormatRuleWidget:

Signals
void	canceled ()
	Emitted when a user has opted to cancel the rule modification.
void	ruleDeleted ()
	Emitted when a user has opted to deleted the current rule.
void	ruleSaved ()
	Emitted when a user has opted to save the current rule.
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
	QgsEditConditionalFormatRuleWidget (QWidget *parent=nullptr)
	Constructor for QgsFieldConditionalFormatWidget, with the specified parent widget.
QgsConditionalStyle	currentStyle () const
	Returns the current style defined by the widget.
void	loadStyle (const QgsConditionalStyle &style)
	Sets the widget to match the settings from the specified style.
void	setLayer (QgsVectorLayer *layer)
	Sets the vector layer associated with the widget.
void	setPresets (const QList< QgsConditionalStyle > &styles)
	Sets the preset styles that can be used for quick pick.
void	setRule (const QString &rule)
	Sets the current expression 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

A widget for customizing an individual conditional formatting rule.

Since

QGIS 3.10

Definition at line 127 of file qgsfieldconditionalformatwidget.h.

Constructor & Destructor Documentation

QgsEditConditionalFormatRuleWidget()

QgsEditConditionalFormatRuleWidget::QgsEditConditionalFormatRuleWidget ( QWidget *  parent = nullptr )

explicit

Constructor for QgsFieldConditionalFormatWidget, with the specified parent widget.

Definition at line 253 of file qgsfieldconditionalformatwidget.cpp.

Member Function Documentation

canceled

void QgsEditConditionalFormatRuleWidget::canceled ( )

signal

Emitted when a user has opted to cancel the rule modification.

currentStyle()

QgsConditionalStyle QgsEditConditionalFormatRuleWidget::currentStyle

(

)

const

Returns the current style defined by the widget.

See also

loadStyle()

Definition at line 313 of file qgsfieldconditionalformatwidget.cpp.

loadStyle()

void QgsEditConditionalFormatRuleWidget::loadStyle

(

const QgsConditionalStyle &

style

)

Sets the widget to match the settings from the specified style.

See also

currentStyle()

Definition at line 306 of file qgsfieldconditionalformatwidget.cpp.

ruleDeleted

void QgsEditConditionalFormatRuleWidget::ruleDeleted ( )

signal

Emitted when a user has opted to deleted the current rule.

ruleSaved

void QgsEditConditionalFormatRuleWidget::ruleSaved ( )

signal

Emitted when a user has opted to save the current rule.

setLayer()

void QgsEditConditionalFormatRuleWidget::setLayer

(

QgsVectorLayer *

layer

)

Sets the vector layer associated with the widget.

Definition at line 301 of file qgsfieldconditionalformatwidget.cpp.

setPresets()

void QgsEditConditionalFormatRuleWidget::setPresets

(

const QList< QgsConditionalStyle > &

styles

)

Sets the preset styles that can be used for quick pick.

Definition at line 389 of file qgsfieldconditionalformatwidget.cpp.

setRule()

void QgsEditConditionalFormatRuleWidget::setRule

(

const QString &

rule

)

Sets the current expression rule to show in the widget.

Definition at line 417 of file qgsfieldconditionalformatwidget.cpp.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/attributetable/qgsfieldconditionalformatwidget.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/attributetable/qgsfieldconditionalformatwidget.cpp