QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
Signals | Public Member Functions | List of all members
QgsEditConditionalFormatRuleWidget Class Reference

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

#include <qgsfieldconditionalformatwidget.h>

Inheritance diagram for QgsEditConditionalFormatRuleWidget:
Inheritance graph
[legend]

Signals

void canceled ()
 Emitted when a user has opted to cancel the rule modification. More...
 
void ruleDeleted ()
 Emitted when a user has opted to deleted the current rule. More...
 
void ruleSaved ()
 Emitted when a user has opted to save the current rule. 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

 QgsEditConditionalFormatRuleWidget (QWidget *parent SIP_TRANSFERTHIS=nullptr)
 Constructor for QgsFieldConditionalFormatWidget, with the specified parent widget. More...
 
QgsConditionalStyle currentStyle () const
 Returns the current style defined by the widget. More...
 
void loadStyle (const QgsConditionalStyle &style)
 Sets the widget to match the settings from the specified style. 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...
 
void setRule (const QString &rule)
 Sets the current expression rule to show in the widget. 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...
 
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...
 

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...
 
- 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...
 
- 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 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  SIP_TRANSFERTHIS = nullptr)
explicit

Constructor for QgsFieldConditionalFormatWidget, with the specified parent widget.

Definition at line 248 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 308 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 301 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 296 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 384 of file qgsfieldconditionalformatwidget.cpp.

◆ setRule()

void QgsEditConditionalFormatRuleWidget::setRule ( const QString &  rule)

Sets the current expression rule to show in the widget.

Definition at line 412 of file qgsfieldconditionalformatwidget.cpp.


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