QGIS API Documentation  3.1.0-Master (cd495fb)
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...
 
- 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 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 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...
 

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 ()
 

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...
 
- 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
 
QgsVectorLayermLayer = nullptr
 
QAction * mPasteAction = nullptr
 
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 44 of file qgsrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsRendererWidget()

QgsRendererWidget::QgsRendererWidget ( QgsVectorLayer layer,
QgsStyle style 
)

Definition at line 32 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 281 of file qgsrendererwidget.cpp.

◆ changeSymbolAngle

void QgsRendererWidget::changeSymbolAngle ( )
protectedslot

Change marker angles of selected symbols.

Definition at line 223 of file qgsrendererwidget.cpp.

◆ changeSymbolColor

void QgsRendererWidget::changeSymbolColor ( )
protectedslot

Change color of selected symbols.

Definition at line 64 of file qgsrendererwidget.cpp.

◆ changeSymbolOpacity

void QgsRendererWidget::changeSymbolOpacity ( )
protectedslot

Change opacity of selected symbols.

Definition at line 96 of file qgsrendererwidget.cpp.

◆ changeSymbolSize

void QgsRendererWidget::changeSymbolSize ( )
protectedslot

Change marker sizes of selected symbols.

Definition at line 195 of file qgsrendererwidget.cpp.

◆ changeSymbolUnit

void QgsRendererWidget::changeSymbolUnit ( )
protectedslot

Change units mm/map units of selected symbols.

Definition at line 130 of file qgsrendererwidget.cpp.

◆ changeSymbolWidth

void QgsRendererWidget::changeSymbolWidth ( )
protectedslot

Change line widths of selected symbols.

Definition at line 166 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()
Since
QGIS 3.0

Definition at line 276 of file qgsrendererwidget.cpp.

◆ contextMenuViewCategories

void QgsRendererWidget::contextMenuViewCategories ( QPoint  p)
protectedslot

Definition at line 59 of file qgsrendererwidget.cpp.

◆ copy

virtual void QgsRendererWidget::copy ( )
inlineprotectedvirtualslot

Definition at line 129 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 null if it could not be opened. Ownership is transferred to the caller.

Since
QGIS 3.0

Definition at line 286 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 130 of file qgsrendererwidget.h.

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

Definition at line 104 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()
Since
QGIS 3.0

Reimplemented in QgsPointClusterRendererWidget, QgsInvertedPolygonRendererWidget, QgsHeatmapRendererWidget, QgsSingleSymbolRendererWidget, and QgsPointDisplacementRendererWidget.

Definition at line 271 of file qgsrendererwidget.cpp.

◆ showSymbolLevelsDialog()

void QgsRendererWidget::showSymbolLevelsDialog ( QgsFeatureRenderer r)

show a dialog with renderer's symbol level settings

Definition at line 251 of file qgsrendererwidget.cpp.

◆ vectorLayer()

const QgsVectorLayer* QgsRendererWidget::vectorLayer ( ) const
inline

Returns the vector layer associated with the widget.

Since
QGIS 2.12

Definition at line 75 of file qgsrendererwidget.h.

Member Data Documentation

◆ contextMenu

QMenu* QgsRendererWidget::contextMenu = nullptr
protected

Definition at line 94 of file qgsrendererwidget.h.

◆ mContext

QgsSymbolWidgetContext QgsRendererWidget::mContext
protected

Context in which widget is shown.

Definition at line 99 of file qgsrendererwidget.h.

◆ mCopyAction

QAction* QgsRendererWidget::mCopyAction = nullptr
protected

Definition at line 95 of file qgsrendererwidget.h.

◆ mLayer

QgsVectorLayer* QgsRendererWidget::mLayer = nullptr
protected

Definition at line 92 of file qgsrendererwidget.h.

◆ mPasteAction

QAction* QgsRendererWidget::mPasteAction = nullptr
protected

Definition at line 96 of file qgsrendererwidget.h.

◆ mStyle

QgsStyle* QgsRendererWidget::mStyle = nullptr
protected

Definition at line 93 of file qgsrendererwidget.h.


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