QGIS API Documentation  3.17.0-Master (a84647cf30)
Public Slots | Public Member Functions | Protected Attributes | List of all members
QgsRendererRulePropsWidget Class Reference

#include <qgsrulebasedrendererwidget.h>

Inheritance diagram for QgsRendererRulePropsWidget:
Inheritance graph
[legend]

Public Slots

void apply ()
 Apply any changes from the widget to the set rule. More...
 
void buildExpression ()
 Open the expression builder widget to check if the. More...
 
void setDockMode (bool dockMode) override
 Set the widget in dock mode. More...
 
void testFilter ()
 Test the filter that is set in the widget. More...
 
- 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...
 

Public Member Functions

 QgsRendererRulePropsWidget (QgsRuleBasedRenderer::Rule *rule, QgsVectorLayer *layer, QgsStyle *style, QWidget *parent=nullptr, const QgsSymbolWidgetContext &context=QgsSymbolWidgetContext())
 Widget to edit the details of a rule based renderer rule. More...
 
QgsRuleBasedRenderer::Rulerule ()
 Returns the current set rule. 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...
 

Protected Attributes

QgsSymbolWidgetContext mContext
 
QgsVectorLayermLayer = nullptr
 
QgsRuleBasedRenderer::RulemRule
 
QgsSymbolmSymbol = nullptr
 
QgsSymbolSelectorWidgetmSymbolSelector = nullptr
 

Additional Inherited Members

- 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...
 
- 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

Definition at line 200 of file qgsrulebasedrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsRendererRulePropsWidget()

QgsRendererRulePropsWidget::QgsRendererRulePropsWidget ( QgsRuleBasedRenderer::Rule rule,
QgsVectorLayer layer,
QgsStyle style,
QWidget *  parent = nullptr,
const QgsSymbolWidgetContext context = QgsSymbolWidgetContext() 
)

Widget to edit the details of a rule based renderer rule.

Parameters
ruleThe rule to edit.
layerThe layer used to pull layer related information.
styleThe active QGIS style.
parentThe parent widget.
contextthe symbol widget context

Definition at line 695 of file qgsrulebasedrendererwidget.cpp.

Member Function Documentation

◆ apply

void QgsRendererRulePropsWidget::apply ( )
slot

Apply any changes from the widget to the set rule.

Definition at line 867 of file qgsrulebasedrendererwidget.cpp.

◆ buildExpression

void QgsRendererRulePropsWidget::buildExpression ( )
slot

Open the expression builder widget to check if the.

Definition at line 802 of file qgsrulebasedrendererwidget.cpp.

◆ rule()

QgsRuleBasedRenderer::Rule* QgsRendererRulePropsWidget::rule ( )
inline

Returns the current set rule.

Returns
The current rule.

Definition at line 224 of file qgsrulebasedrendererwidget.h.

◆ setDockMode

void QgsRendererRulePropsWidget::setDockMode ( bool  dockMode)
overrideslot

Set the widget in dock mode.

Parameters
dockModetrue for dock mode.

Definition at line 879 of file qgsrulebasedrendererwidget.cpp.

◆ testFilter

void QgsRendererRulePropsWidget::testFilter ( )
slot

Test the filter that is set in the widget.

Definition at line 819 of file qgsrulebasedrendererwidget.cpp.

Member Data Documentation

◆ mContext

QgsSymbolWidgetContext QgsRendererRulePropsWidget::mContext
protected

Definition at line 256 of file qgsrulebasedrendererwidget.h.

◆ mLayer

QgsVectorLayer* QgsRendererRulePropsWidget::mLayer = nullptr
protected

Definition at line 251 of file qgsrulebasedrendererwidget.h.

◆ mRule

QgsRuleBasedRenderer::Rule* QgsRendererRulePropsWidget::mRule
protected

Definition at line 250 of file qgsrulebasedrendererwidget.h.

◆ mSymbol

QgsSymbol* QgsRendererRulePropsWidget::mSymbol = nullptr
protected

Definition at line 254 of file qgsrulebasedrendererwidget.h.

◆ mSymbolSelector

QgsSymbolSelectorWidget* QgsRendererRulePropsWidget::mSymbolSelector = nullptr
protected

Definition at line 253 of file qgsrulebasedrendererwidget.h.


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