QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Signals | Public Member Functions | Static Public Member Functions | List of all members
QgsFieldConditionalFormatWidget Class Reference

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

#include <qgsfieldconditionalformatwidget.h>

Inheritance diagram for QgsFieldConditionalFormatWidget:
Inheritance graph
[legend]

Signals

void rulesUpdated (const QString &fieldName)
 Emitted when the conditional styling rules are updated. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 

Public Member Functions

 QgsFieldConditionalFormatWidget (QWidget *parent=nullptr)
 Constructor for QgsFieldConditionalFormatWidget. More...
 
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. More...
 
Q_DECL_DEPRECATED void loadStyle (const QgsConditionalStyle &style)
 
Q_DECL_DEPRECATED 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)
 Sets the preset styles that can be used for quick pick. More...
 
Q_DECL_DEPRECATED void viewRules ()
 Switches the widget to the rules page. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel. More...
 
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. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
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. More...
 
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. More...
 
bool dockMode ()
 Returns the dock mode state. More...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Static Public Member Functions

static QList< QgsConditionalStyledefaultPresets ()
 Returns a list of the default presets. More...
 
- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 

Additional Inherited Members

- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel. More...
 
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. More...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

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 31 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 168 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 64 of file qgsfieldconditionalformatwidget.cpp.

◆ loadStyle()

void QgsFieldConditionalFormatWidget::loadStyle ( const QgsConditionalStyle style)

◆ reset()

void QgsFieldConditionalFormatWidget::reset ( )

Resets the formatting options to their default state.

Deprecated:
no longer used, will be removed in QGIS 4.0

Definition at line 159 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 49 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 163 of file qgsfieldconditionalformatwidget.cpp.

◆ viewRules()

void QgsFieldConditionalFormatWidget::viewRules ( )

Switches the widget to the rules page.

Deprecated:
no longer used, will be removed in QGIS 4.0

Definition at line 243 of file qgsfieldconditionalformatwidget.cpp.


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