QGIS API Documentation  3.9.0-Master (3ff8ca5736)
Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QgsRuleBasedRendererWidget Class Reference

#include <qgsrulebasedrendererwidget.h>

Inheritance diagram for QgsRuleBasedRendererWidget:
Inheritance graph
[legend]

Public Slots

void addRule ()
 
void clearFeatureCounts ()
 
void countFeatures ()
 
void currentRuleChanged (const QModelIndex &current=QModelIndex(), const QModelIndex &previous=QModelIndex())
 
void editRule ()
 
void editRule (const QModelIndex &index)
 
void refineRuleCategories ()
 
void refineRuleRanges ()
 
void refineRuleScales ()
 
void removeRule ()
 
void restoreSectionWidths ()
 
void saveSectionWidth (int section, int oldSize, int newSize)
 
void selectedRulesChanged ()
 
void setRenderingOrder ()
 
- 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

 QgsRuleBasedRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 
 ~QgsRuleBasedRendererWidget () override
 
QgsFeatureRendererrenderer () override
 Returns pointer to the renderer (no transfer of ownership) More...
 
- Public Member Functions inherited from QgsRendererWidget
 QgsRendererWidget (QgsVectorLayer *layer, QgsStyle *style)
 
void applyChanges ()
 This method should be called whenever the renderer is actually set on the layer. More...
 
QgsSymbolWidgetContext context () const
 Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. More...
 
virtual void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. More...
 
void showSymbolLevelsDialog (QgsFeatureRenderer *r)
 show a dialog with renderer's symbol level settings More...
 
const QgsVectorLayervectorLayer () const
 Returns the vector layer associated with 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...
 
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 QgsRendererWidgetcreate (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 
- 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 Slots

void copy () override
 
void paste () override
 
void pasteSymbolToSelection () override
 
- Protected Slots inherited from QgsRendererWidget
void changeSymbolAngle ()
 Change marker angles of selected symbols. More...
 
void changeSymbolColor ()
 Change color of selected symbols. More...
 
void changeSymbolOpacity ()
 Change opacity of selected symbols. More...
 
void changeSymbolSize ()
 Change marker sizes of selected symbols. More...
 
void changeSymbolUnit ()
 Change units mm/map units of selected symbols. More...
 
void changeSymbolWidth ()
 Change line widths of selected symbols. More...
 
void contextMenuViewCategories (QPoint p)
 
virtual void copy ()
 
virtual void paste ()
 
virtual void pasteSymbolToSelection ()
 Pastes the clipboard symbol over selected items. More...
 

Protected Member Functions

QgsRuleBasedRenderer::RulecurrentRule ()
 
void keyPressEvent (QKeyEvent *event) override
 
void refineRule (int type)
 
void refineRuleCategoriesGui ()
 Opens the dialog for refining a rule using categories. More...
 
void refineRuleRangesGui ()
 Opens the dialog for refining a rule using ranges. More...
 
void refineRuleScalesGui (const QModelIndexList &index)
 
void refreshSymbolView () override
 
QgsRuleBasedRenderer::RuleList selectedRules ()
 
QList< QgsSymbol * > selectedSymbols () override
 Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&) More...
 
- Protected Member Functions inherited from QgsRendererWidget
QgsDataDefinedSizeLegendWidgetcreateDataDefinedSizeLegendWidget (const QgsMarkerSymbol *symbol, const QgsDataDefinedSizeLegend *ddsLegend)
 Creates widget to setup data-defined size legend. 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...
 

Protected Attributes

QMenu * mContextMenu = nullptr
 
QgsRuleBasedRenderer::RuleList mCopyBuffer
 
QAction * mDeleteAction = nullptr
 
QgsRuleBasedRendererModelmModel = nullptr
 
QMenu * mRefineMenu = nullptr
 
QgsRuleBasedRenderermRenderer = nullptr
 
- Protected Attributes inherited from QgsRendererWidget
QMenu * contextMenu = nullptr
 
QgsSymbolWidgetContext mContext
 Context in which widget is shown. More...
 
QAction * mCopyAction = nullptr
 
QAction * mCopySymbolAction = nullptr
 Copy symbol action. More...
 
QgsVectorLayermLayer = nullptr
 
QAction * mPasteAction = nullptr
 
QAction * mPasteSymbolAction = nullptr
 Paste symbol action. More...
 
QgsStylemStyle = nullptr
 

Additional Inherited Members

- Signals inherited from QgsRendererWidget
void layerVariablesChanged ()
 Emitted when expression context variables on the associated vector layers have been changed. More...
 
void symbolLevelsChanged ()
 Emitted when the symbol levels settings have been changed. 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...
 

Detailed Description

Definition at line 117 of file qgsrulebasedrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsRuleBasedRendererWidget()

QgsRuleBasedRendererWidget::QgsRuleBasedRendererWidget ( QgsVectorLayer layer,
QgsStyle style,
QgsFeatureRenderer renderer 
)

Definition at line 53 of file qgsrulebasedrendererwidget.cpp.

◆ ~QgsRuleBasedRendererWidget()

QgsRuleBasedRendererWidget::~QgsRuleBasedRendererWidget ( )
override

Definition at line 135 of file qgsrulebasedrendererwidget.cpp.

Member Function Documentation

◆ addRule

void QgsRuleBasedRendererWidget::addRule ( )
slot

Definition at line 146 of file qgsrulebasedrendererwidget.cpp.

◆ clearFeatureCounts

void QgsRuleBasedRendererWidget::clearFeatureCounts ( )
inlineslot

Definition at line 137 of file qgsrulebasedrendererwidget.h.

◆ copy

void QgsRuleBasedRendererWidget::copy ( )
overrideprotectedslot

Definition at line 468 of file qgsrulebasedrendererwidget.cpp.

◆ countFeatures

void QgsRuleBasedRendererWidget::countFeatures ( )
slot

Definition at line 582 of file qgsrulebasedrendererwidget.cpp.

◆ create()

QgsRendererWidget * QgsRuleBasedRendererWidget::create ( QgsVectorLayer layer,
QgsStyle style,
QgsFeatureRenderer renderer 
)
static

Definition at line 48 of file qgsrulebasedrendererwidget.cpp.

◆ currentRule()

QgsRuleBasedRenderer::Rule * QgsRuleBasedRendererWidget::currentRule ( )
protected

Definition at line 171 of file qgsrulebasedrendererwidget.cpp.

◆ currentRuleChanged

void QgsRuleBasedRendererWidget::currentRuleChanged ( const QModelIndex &  current = QModelIndex(),
const QModelIndex &  previous = QModelIndex() 
)
slot

Definition at line 228 of file qgsrulebasedrendererwidget.cpp.

◆ editRule [1/2]

void QgsRuleBasedRendererWidget::editRule ( )
slot

Definition at line 180 of file qgsrulebasedrendererwidget.cpp.

◆ editRule [2/2]

void QgsRuleBasedRendererWidget::editRule ( const QModelIndex &  index)
slot

Definition at line 185 of file qgsrulebasedrendererwidget.cpp.

◆ keyPressEvent()

void QgsRuleBasedRendererWidget::keyPressEvent ( QKeyEvent *  event)
overrideprotected

Definition at line 396 of file qgsrulebasedrendererwidget.cpp.

◆ paste

void QgsRuleBasedRendererWidget::paste ( )
overrideprotectedslot

Definition at line 480 of file qgsrulebasedrendererwidget.cpp.

◆ pasteSymbolToSelection

void QgsRuleBasedRendererWidget::pasteSymbolToSelection ( )
overrideprotectedslot

Definition at line 492 of file qgsrulebasedrendererwidget.cpp.

◆ refineRule()

void QgsRuleBasedRendererWidget::refineRule ( int  type)
protected

Definition at line 244 of file qgsrulebasedrendererwidget.cpp.

◆ refineRuleCategories

void QgsRuleBasedRendererWidget::refineRuleCategories ( )
slot

Definition at line 267 of file qgsrulebasedrendererwidget.cpp.

◆ refineRuleCategoriesGui()

void QgsRuleBasedRendererWidget::refineRuleCategoriesGui ( )
protected

Opens the dialog for refining a rule using categories.

Definition at line 282 of file qgsrulebasedrendererwidget.cpp.

◆ refineRuleRanges

void QgsRuleBasedRendererWidget::refineRuleRanges ( )
slot

Definition at line 272 of file qgsrulebasedrendererwidget.cpp.

◆ refineRuleRangesGui()

void QgsRuleBasedRendererWidget::refineRuleRangesGui ( )
protected

Opens the dialog for refining a rule using ranges.

Definition at line 291 of file qgsrulebasedrendererwidget.cpp.

◆ refineRuleScales

void QgsRuleBasedRendererWidget::refineRuleScales ( )
slot

Definition at line 277 of file qgsrulebasedrendererwidget.cpp.

◆ refineRuleScalesGui()

void QgsRuleBasedRendererWidget::refineRuleScalesGui ( const QModelIndexList &  index)
protected

Definition at line 300 of file qgsrulebasedrendererwidget.cpp.

◆ refreshSymbolView()

void QgsRuleBasedRendererWidget::refreshSymbolView ( )
overrideprotectedvirtual

Reimplemented from QgsRendererWidget.

Definition at line 384 of file qgsrulebasedrendererwidget.cpp.

◆ removeRule

void QgsRuleBasedRendererWidget::removeRule ( )
slot

Definition at line 212 of file qgsrulebasedrendererwidget.cpp.

◆ renderer()

QgsFeatureRenderer * QgsRuleBasedRendererWidget::renderer ( )
overridevirtual

Returns pointer to the renderer (no transfer of ownership)

Implements QgsRendererWidget.

Definition at line 141 of file qgsrulebasedrendererwidget.cpp.

◆ restoreSectionWidths

void QgsRuleBasedRendererWidget::restoreSectionWidths ( )
slot

Definition at line 455 of file qgsrulebasedrendererwidget.cpp.

◆ saveSectionWidth

void QgsRuleBasedRendererWidget::saveSectionWidth ( int  section,
int  oldSize,
int  newSize 
)
slot

Definition at line 444 of file qgsrulebasedrendererwidget.cpp.

◆ selectedRules()

QgsRuleBasedRenderer::RuleList QgsRuleBasedRendererWidget::selectedRules ( )
protected

Definition at line 366 of file qgsrulebasedrendererwidget.cpp.

◆ selectedRulesChanged

void QgsRuleBasedRendererWidget::selectedRulesChanged ( )
slot

Definition at line 675 of file qgsrulebasedrendererwidget.cpp.

◆ selectedSymbols()

QList< QgsSymbol * > QgsRuleBasedRendererWidget::selectedSymbols ( )
overrideprotectedvirtual

Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&)

Reimplemented from QgsRendererWidget.

Definition at line 341 of file qgsrulebasedrendererwidget.cpp.

◆ setRenderingOrder

void QgsRuleBasedRendererWidget::setRenderingOrder ( )
slot

Definition at line 422 of file qgsrulebasedrendererwidget.cpp.

Member Data Documentation

◆ mContextMenu

QMenu* QgsRuleBasedRendererWidget::mContextMenu = nullptr
protected

Definition at line 173 of file qgsrulebasedrendererwidget.h.

◆ mCopyBuffer

QgsRuleBasedRenderer::RuleList QgsRuleBasedRendererWidget::mCopyBuffer
protected

Definition at line 172 of file qgsrulebasedrendererwidget.h.

◆ mDeleteAction

QAction* QgsRuleBasedRendererWidget::mDeleteAction = nullptr
protected

Definition at line 170 of file qgsrulebasedrendererwidget.h.

◆ mModel

QgsRuleBasedRendererModel* QgsRuleBasedRendererWidget::mModel = nullptr
protected

Definition at line 167 of file qgsrulebasedrendererwidget.h.

◆ mRefineMenu

QMenu* QgsRuleBasedRendererWidget::mRefineMenu = nullptr
protected

Definition at line 169 of file qgsrulebasedrendererwidget.h.

◆ mRenderer

QgsRuleBasedRenderer* QgsRuleBasedRendererWidget::mRenderer = nullptr
protected

Definition at line 166 of file qgsrulebasedrendererwidget.h.


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