QGIS API Documentation  3.6.0-Noosa (5873452)
Public Member Functions | Static Public Member Functions | List of all members
QgsPointClusterRendererWidget Class Reference

A widget which allows configuration of the properties for a QgsPointClusterRenderer. More...

#include <qgspointclusterrendererwidget.h>

Inheritance diagram for QgsPointClusterRendererWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsPointClusterRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 Constructor for QgsPointClusterRendererWidget. More...
 
 ~QgsPointClusterRendererWidget () override
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
QgsFeatureRendererrenderer () override
 Returns pointer to the renderer (no transfer of ownership) More...
 
void setContext (const QgsSymbolWidgetContext &context) override
 Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. 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...
 
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...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 

Static Public Member Functions

static QgsRendererWidgetcreate (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer)
 Returns a new QgsPointClusterRendererWidget. 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...
 

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...
 
- Signals inherited from QgsRendererWidget
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...
 
- 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 ()
 
- Protected Member Functions inherited from QgsRendererWidget
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 inherited from QgsRendererWidget
QMenu * contextMenu = nullptr
 
QgsSymbolWidgetContext mContext
 Context in which widget is shown. More...
 
QAction * mCopyAction = nullptr
 
QgsVectorLayermLayer = nullptr
 
QAction * mPasteAction = nullptr
 
QgsStylemStyle = nullptr
 

Detailed Description

A widget which allows configuration of the properties for a QgsPointClusterRenderer.

Since
QGIS 3.0

Definition at line 36 of file qgspointclusterrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsPointClusterRendererWidget()

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

Constructor for QgsPointClusterRendererWidget.

Parameters
layerassociated vector layer
stylestyle collection
renderersource QgsPointClusterRenderer renderer

Definition at line 34 of file qgspointclusterrendererwidget.cpp.

◆ ~QgsPointClusterRendererWidget()

QgsPointClusterRendererWidget::~QgsPointClusterRendererWidget ( )
override

Definition at line 111 of file qgspointclusterrendererwidget.cpp.

Member Function Documentation

◆ create()

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

Returns a new QgsPointClusterRendererWidget.

Parameters
layerassociated vector layer
stylestyle collection
renderersource QgsPointClusterRenderer renderer
Returns
new QgsRendererWidget

Definition at line 29 of file qgspointclusterrendererwidget.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsPointClusterRendererWidget::createExpressionContext ( ) const
overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Since
QGIS 3.0

Implements QgsExpressionContextGenerator.

Definition at line 199 of file qgspointclusterrendererwidget.cpp.

◆ renderer()

QgsFeatureRenderer * QgsPointClusterRendererWidget::renderer ( )
overridevirtual

Returns pointer to the renderer (no transfer of ownership)

Implements QgsRendererWidget.

Definition at line 116 of file qgspointclusterrendererwidget.cpp.

◆ setContext()

void QgsPointClusterRendererWidget::setContext ( const QgsSymbolWidgetContext context)
overridevirtual

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

Definition at line 121 of file qgspointclusterrendererwidget.cpp.


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