QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QgsRendererWidget Class Referenceabstract

Base class for renderer settings widgets. More...

#include <qgsrendererwidget.h>

Inheritance diagram for QgsRendererWidget:
Inheritance graph
[legend]

Signals

void layerVariablesChanged ()
 Emitted when expression context variables on the associated vector layers have been changed. More...
 
Q_DECL_DEPRECATED 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...
 

Public Member Functions

 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 disableSymbolLevels ()
 Disables symbol level modification on the widget. More...
 
virtual QgsFeatureRendererrenderer ()=0
 Returns pointer to the renderer (no transfer of ownership) 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 setDockMode (bool dockMode) override
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. 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...
 
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...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Protected Slots

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

QgsDataDefinedSizeLegendWidgetcreateDataDefinedSizeLegendWidget (const QgsMarkerSymbol *symbol, const QgsDataDefinedSizeLegend *ddsLegend)
 Creates widget to setup data-defined size legend. More...
 
virtual void refreshSymbolView ()
 
virtual QList< QgsSymbol * > selectedSymbols ()
 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...
 
virtual void setSymbolLevels (const QList< QgsLegendSymbolItem > &levels, bool enabled)
 Sets the symbol levels for the renderer defined in the 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...
 

Protected Attributes

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

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

Detailed Description

Base class for renderer settings widgets.

WORKFLOW:

Definition at line 45 of file qgsrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsRendererWidget()

QgsRendererWidget::QgsRendererWidget ( QgsVectorLayer layer,
QgsStyle style 
)

Definition at line 37 of file qgsrendererwidget.cpp.

Member Function Documentation

◆ applyChanges()

void QgsRendererWidget::applyChanges ( )

This method should be called whenever the renderer is actually set on the layer.

Definition at line 350 of file qgsrendererwidget.cpp.

◆ changeSymbolAngle

void QgsRendererWidget::changeSymbolAngle ( )
protectedslot

Change marker angles of selected symbols.

Definition at line 272 of file qgsrendererwidget.cpp.

◆ changeSymbolColor

void QgsRendererWidget::changeSymbolColor ( )
protectedslot

Change color of selected symbols.

Definition at line 84 of file qgsrendererwidget.cpp.

◆ changeSymbolOpacity

void QgsRendererWidget::changeSymbolOpacity ( )
protectedslot

Change opacity of selected symbols.

Definition at line 139 of file qgsrendererwidget.cpp.

◆ changeSymbolSize

void QgsRendererWidget::changeSymbolSize ( )
protectedslot

Change marker sizes of selected symbols.

Definition at line 243 of file qgsrendererwidget.cpp.

◆ changeSymbolUnit

void QgsRendererWidget::changeSymbolUnit ( )
protectedslot

Change units mm/map units of selected symbols.

Definition at line 175 of file qgsrendererwidget.cpp.

◆ changeSymbolWidth

void QgsRendererWidget::changeSymbolWidth ( )
protectedslot

Change line widths of selected symbols.

Definition at line 213 of file qgsrendererwidget.cpp.

◆ context()

QgsSymbolWidgetContext QgsRendererWidget::context ( ) const

Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

See also
setContext()

Definition at line 345 of file qgsrendererwidget.cpp.

◆ contextMenuViewCategories

void QgsRendererWidget::contextMenuViewCategories ( QPoint  p)
protectedslot

Definition at line 79 of file qgsrendererwidget.cpp.

◆ copy

virtual void QgsRendererWidget::copy ( )
inlineprotectedvirtualslot

Definition at line 170 of file qgsrendererwidget.h.

◆ createDataDefinedSizeLegendWidget()

QgsDataDefinedSizeLegendWidget * QgsRendererWidget::createDataDefinedSizeLegendWidget ( const QgsMarkerSymbol symbol,
const QgsDataDefinedSizeLegend ddsLegend 
)
protected

Creates widget to setup data-defined size legend.

Returns newly created panel - may be nullptr if it could not be opened. Ownership is transferred to the caller.

Definition at line 372 of file qgsrendererwidget.cpp.

◆ disableSymbolLevels()

void QgsRendererWidget::disableSymbolLevels ( )
virtual

Disables symbol level modification on the widget.

Note
Not available in Python bindings
Since
QGIS 3.20

Reimplemented in QgsSingleSymbolRendererWidget, QgsGraduatedSymbolRendererWidget, and QgsCategorizedSymbolRendererWidget.

Definition at line 368 of file qgsrendererwidget.cpp.

◆ layerVariablesChanged

void QgsRendererWidget::layerVariablesChanged ( )
signal

Emitted when expression context variables on the associated vector layers have been changed.

Will request the parent dialog to re-synchronize with the variables.

◆ paste

virtual void QgsRendererWidget::paste ( )
inlineprotectedvirtualslot

Definition at line 171 of file qgsrendererwidget.h.

◆ pasteSymbolToSelection

void QgsRendererWidget::pasteSymbolToSelection ( )
protectedvirtualslot

Pastes the clipboard symbol over selected items.

Since
QGIS 3.10

Definition at line 301 of file qgsrendererwidget.cpp.

◆ refreshSymbolView()

virtual void QgsRendererWidget::refreshSymbolView ( )
inlineprotectedvirtual

◆ renderer()

virtual QgsFeatureRenderer* QgsRendererWidget::renderer ( )
pure virtual

◆ selectedSymbols()

virtual QList<QgsSymbol *> QgsRendererWidget::selectedSymbols ( )
inlineprotectedvirtual

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 in QgsRuleBasedRendererWidget, QgsGraduatedSymbolRendererWidget, and QgsCategorizedSymbolRendererWidget.

Definition at line 134 of file qgsrendererwidget.h.

◆ setContext()

void QgsRendererWidget::setContext ( const QgsSymbolWidgetContext context)
virtual

Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

Parameters
contextsymbol widget context
See also
context()

Reimplemented in QgsSingleSymbolRendererWidget, QgsPointDisplacementRendererWidget, QgsPointClusterRendererWidget, QgsMergedFeatureRendererWidget, QgsInvertedPolygonRendererWidget, QgsHeatmapRendererWidget, QgsGraduatedSymbolRendererWidget, QgsEmbeddedSymbolRendererWidget, and QgsCategorizedSymbolRendererWidget.

Definition at line 340 of file qgsrendererwidget.cpp.

◆ setDockMode()

void QgsRendererWidget::setDockMode ( bool  dockMode)
overridevirtual

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

Parameters
dockModetrue to enable dock mode.

Reimplemented from QgsPanelWidget.

Reimplemented in QgsSingleSymbolRendererWidget, and QgsRuleBasedRendererWidget.

Definition at line 355 of file qgsrendererwidget.cpp.

◆ setSymbolLevels()

void QgsRendererWidget::setSymbolLevels ( const QList< QgsLegendSymbolItem > &  levels,
bool  enabled 
)
protectedvirtual

Sets the symbol levels for the renderer defined in the widget.

The levels argument defines the updated list of symbols with rendering passes set.

The enabled arguments specifies if symbol levels should be enabled for the renderer.

Since
QGIS 3.20

Reimplemented in QgsSingleSymbolRendererWidget, QgsRuleBasedRendererWidget, QgsGraduatedSymbolRendererWidget, and QgsCategorizedSymbolRendererWidget.

Definition at line 386 of file qgsrendererwidget.cpp.

◆ showSymbolLevelsDialog()

void QgsRendererWidget::showSymbolLevelsDialog ( QgsFeatureRenderer r)

Show a dialog with renderer's symbol level settings.

Definition at line 317 of file qgsrendererwidget.cpp.

◆ symbolLevelsChanged

Q_DECL_DEPRECATED void QgsRendererWidget::symbolLevelsChanged ( )
signal

Emitted when the symbol levels settings have been changed.

Deprecated:
since QGIS 3.20 – no longer emitted.

◆ vectorLayer()

const QgsVectorLayer* QgsRendererWidget::vectorLayer ( ) const
inline

Returns the vector layer associated with the widget.

Definition at line 75 of file qgsrendererwidget.h.

Member Data Documentation

◆ contextMenu

QMenu* QgsRendererWidget::contextMenu = nullptr
protected

Definition at line 111 of file qgsrendererwidget.h.

◆ mContext

QgsSymbolWidgetContext QgsRendererWidget::mContext
protected

Context in which widget is shown.

Definition at line 128 of file qgsrendererwidget.h.

◆ mCopyAction

QAction* QgsRendererWidget::mCopyAction = nullptr
protected

Definition at line 112 of file qgsrendererwidget.h.

◆ mCopySymbolAction

QAction* QgsRendererWidget::mCopySymbolAction = nullptr
protected

Copy symbol action.

Since
QGIS 3.10

Definition at line 119 of file qgsrendererwidget.h.

◆ mLayer

QgsVectorLayer* QgsRendererWidget::mLayer = nullptr
protected

Definition at line 109 of file qgsrendererwidget.h.

◆ mPasteAction

QAction* QgsRendererWidget::mPasteAction = nullptr
protected

Definition at line 113 of file qgsrendererwidget.h.

◆ mPasteSymbolAction

QAction* QgsRendererWidget::mPasteSymbolAction = nullptr
protected

Paste symbol action.

Since
QGIS 3.10

Definition at line 125 of file qgsrendererwidget.h.

◆ mStyle

QgsStyle* QgsRendererWidget::mStyle = nullptr
protected

Definition at line 110 of file qgsrendererwidget.h.


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