QgsFieldConditionalFormatWidget Class Reference

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

#include <qgsfieldconditionalformatwidget.h>

Inheritance diagram for QgsFieldConditionalFormatWidget:

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

Public Member Functions
	QgsFieldConditionalFormatWidget (QWidget *parent=nullptr)
	Constructor for QgsFieldConditionalFormatWidget. More...
QList< QgsConditionalStyle >	defaultPresets () const
	The default presets for the widget. More...
void	editStyle (int index, const QgsConditionalStyle &style)
	Switches the widget to the edit style mode for the specified style. More...
void	loadStyle (const QgsConditionalStyle &style)
void	reset ()
	Resets the formatting options to their default state. More...
void	setLayer (QgsVectorLayer *layer)
	Sets the vector layer associated with the widget. More...
void	setPresets (const QList< QgsConditionalStyle > &styles)
	Set the presets that can be used for quick pick. More...
void	viewRules ()
	Switches the widget to the rules page. More...

Detailed Description

A widget for customizing conditional formatting options.

Since

QGIS 2.12

Definition at line 33 of file qgsfieldconditionalformatwidget.h.

Constructor & Destructor Documentation

QgsFieldConditionalFormatWidget::QgsFieldConditionalFormatWidget ( QWidget *  parent = nullptr )

explicit

Constructor for QgsFieldConditionalFormatWidget.

Parameters

parent

parent widget

Definition at line 24 of file qgsfieldconditionalformatwidget.cpp.

Member Function Documentation

QList< QgsConditionalStyle > QgsFieldConditionalFormatWidget::defaultPresets

(

)

const

The default presets for the widget.

Normally set when the widget is created however called setPresets will override the default styles.

Returns

List of default presets.

Definition at line 223 of file qgsfieldconditionalformatwidget.cpp.

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

Switches the widget to the edit style mode for the specified style.

Parameters

index	index of conditional style to edit
style	initial conditional styling options

Definition at line 92 of file qgsfieldconditionalformatwidget.cpp.

void QgsFieldConditionalFormatWidget::loadStyle

(

const QgsConditionalStyle &

style

)

Parameters

style

initial conditional styling options

Definition at line 101 of file qgsfieldconditionalformatwidget.cpp.

void QgsFieldConditionalFormatWidget::reset

(

)

Resets the formatting options to their default state.

Definition at line 175 of file qgsfieldconditionalformatwidget.cpp.

void QgsFieldConditionalFormatWidget::rulesUpdated ( const QString &  fieldName )

signal

Emitted when the conditional styling rules are updated.

Parameters

fieldName

name of field whose rules have been modified.

void QgsFieldConditionalFormatWidget::setLayer

(

QgsVectorLayer *

layer

)

Sets the vector layer associated with the widget.

Parameters

layer

vector layer

Definition at line 78 of file qgsfieldconditionalformatwidget.cpp.

void QgsFieldConditionalFormatWidget::setPresets

(

const QList< QgsConditionalStyle > &

styles

)

Set the presets that can be used for quick pick.

Parameters

styles

A list of styles used as presets

Definition at line 200 of file qgsfieldconditionalformatwidget.cpp.

void QgsFieldConditionalFormatWidget::viewRules

(

)

Switches the widget to the rules page.

Definition at line 318 of file qgsfieldconditionalformatwidget.cpp.

---

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

• /build/qgis-3.4.15+24xenial/src/gui/attributetable/qgsfieldconditionalformatwidget.h
• /build/qgis-3.4.15+24xenial/src/gui/attributetable/qgsfieldconditionalformatwidget.cpp