A widget for customizing conditional formatting options. More...

#include <qgsfieldconditionalformatwidget.h>

Inheritance diagram for QgsFieldConditionalFormatWidget:

[legend]

Signals
void	rulesUpdated (const QString &fieldName)
	Emitted when the conditional styling rules are updated.

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
	QgsFieldConditionalFormatWidget (QWidget *parent=nullptr)
	Constructor for QgsFieldConditionalFormatWidget.

void	editStyle (int index, const QgsConditionalStyle &style)
	Switches the widget to the edit style mode for the specified style, where index is the index of the conditional style to edit and style is the initial definition of the style.

Q_DECL_DEPRECATED void	loadStyle (const QgsConditionalStyle &style)

Q_DECL_DEPRECATED void	reset ()
	Resets the formatting options to their default state.

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.

Q_DECL_DEPRECATED void	viewRules ()
	Switches the widget to the rules page.

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.

Static Public Member Functions
static QList< QgsConditionalStyle >	defaultPresets ()
	Returns a list of the default presets.

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.

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.

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 conditional formatting options.

Definition at line 34 of file qgsfieldconditionalformatwidget.h.

Constructor & Destructor Documentation

◆ QgsFieldConditionalFormatWidget()

QgsFieldConditionalFormatWidget::QgsFieldConditionalFormatWidget ( QWidget * parent = nullptr )

explicit

Constructor for QgsFieldConditionalFormatWidget.

Definition at line 32 of file qgsfieldconditionalformatwidget.cpp.

Member Function Documentation

◆ defaultPresets()

QList< QgsConditionalStyle > QgsFieldConditionalFormatWidget::defaultPresets ( )

static

Returns a list of the default presets.

Normally used when the widget is created, however calling setPresets() will override the default styles.

Definition at line 165 of file qgsfieldconditionalformatwidget.cpp.

◆ editStyle()

void QgsFieldConditionalFormatWidget::editStyle	(	int	index,
		const QgsConditionalStyle &	style
	)

Switches the widget to the edit style mode for the specified style, where index is the index of the conditional style to edit and style is the initial definition of the style.

Definition at line 65 of file qgsfieldconditionalformatwidget.cpp.

◆ loadStyle()

void QgsFieldConditionalFormatWidget::loadStyle ( const QgsConditionalStyle & style )

Deprecated:: QGIS 3.40. No longer used, use QgsEditConditionalFormatRuleWidget::loadStyle instead.

Definition at line 132 of file qgsfieldconditionalformatwidget.cpp.

◆ reset()

void QgsFieldConditionalFormatWidget::reset ( )

Resets the formatting options to their default state.

Deprecated:: QGIS 3.40. No longer used, will be removed in QGIS 4.0.

Definition at line 156 of file qgsfieldconditionalformatwidget.cpp.

◆ rulesUpdated

void QgsFieldConditionalFormatWidget::rulesUpdated ( const QString & fieldName )

signal

Emitted when the conditional styling rules are updated.

The fieldName argument indicates the name of the field whose rules have been modified, or an empty fieldName indicates that a row-based rule was updated.

◆ setLayer()

void QgsFieldConditionalFormatWidget::setLayer ( QgsVectorLayer * layer )

Sets the vector layer associated with the widget.

Definition at line 50 of file qgsfieldconditionalformatwidget.cpp.

◆ setPresets()

void QgsFieldConditionalFormatWidget::setPresets ( const QList< QgsConditionalStyle > & styles )

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

Definition at line 160 of file qgsfieldconditionalformatwidget.cpp.

◆ viewRules()

void QgsFieldConditionalFormatWidget::viewRules ( )

Switches the widget to the rules page.

Deprecated:: QGIS 3.40. No longer used, will be removed in QGIS 4.0.

Definition at line 240 of file qgsfieldconditionalformatwidget.cpp.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/attributetable/qgsfieldconditionalformatwidget.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/attributetable/qgsfieldconditionalformatwidget.cpp

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members