QGIS API Documentation 3.99.0-Master (e9821da5c6b)
Loading...
Searching...
No Matches
QgsStackedDiagramPropertiesDialog Class Reference

Dialog for editing sub diagrams. More...

#include <qgsstackeddiagramproperties.h>

Inheritance diagram for QgsStackedDiagramPropertiesDialog:

Public Slots

void accept () override
 Applies changes from the widget to the internal renderer and diagram layer settings.

Public Member Functions

 QgsStackedDiagramPropertiesDialog (QgsVectorLayer *layer, QWidget *parent=nullptr, QgsMapCanvas *mapCanvas=nullptr)
 Constructor for QgsStackedDiagramPropertiesDialog.
QgsDiagramLayerSettings diagramLayerSettings () const
 Gets diagram layer settings built from the diagram properties widget.
bool isAllowedToEditDiagramLayerSettings () const
 Returns whether the main widget is allowed to edit diagram layer settings.
QgsDiagramRendererrenderer ()
 Gets a renderer object built from the diagram properties widget.
void setAllowedToEditDiagramLayerSettings (bool allowed) const
 Delegates to the main widget to set whether the widget should show diagram layer settings to be edited.
void syncToRenderer (const QgsDiagramRenderer *dr) const
 Delegates to the diagram properties widget to sync with the given renderer.
void syncToSettings (const QgsDiagramLayerSettings *dls) const
 Delegates to the diagram properties widget to sync with the given diagram layer settings.

Detailed Description

Dialog for editing sub diagrams.

Note
This class is not a part of public API
Since
QGIS 3.40

Definition at line 209 of file qgsstackeddiagramproperties.h.

Constructor & Destructor Documentation

◆ QgsStackedDiagramPropertiesDialog()

QgsStackedDiagramPropertiesDialog::QgsStackedDiagramPropertiesDialog ( QgsVectorLayer * layer,
QWidget * parent = nullptr,
QgsMapCanvas * mapCanvas = nullptr )

Constructor for QgsStackedDiagramPropertiesDialog.

Parameters
layersource vector layer
parentparent widget
mapCanvasmap canvas

Definition at line 307 of file qgsstackeddiagramproperties.cpp.

Member Function Documentation

◆ accept

void QgsStackedDiagramPropertiesDialog::accept ( )
overrideslot

Applies changes from the widget to the internal renderer and diagram layer settings.

Definition at line 343 of file qgsstackeddiagramproperties.cpp.

◆ diagramLayerSettings()

QgsDiagramLayerSettings QgsStackedDiagramPropertiesDialog::diagramLayerSettings ( ) const

Gets diagram layer settings built from the diagram properties widget.

Definition at line 356 of file qgsstackeddiagramproperties.cpp.

◆ isAllowedToEditDiagramLayerSettings()

bool QgsStackedDiagramPropertiesDialog::isAllowedToEditDiagramLayerSettings ( ) const

Returns whether the main widget is allowed to edit diagram layer settings.

Definition at line 366 of file qgsstackeddiagramproperties.cpp.

◆ renderer()

QgsDiagramRenderer * QgsStackedDiagramPropertiesDialog::renderer ( )

Gets a renderer object built from the diagram properties widget.

Transfers ownership.

Definition at line 351 of file qgsstackeddiagramproperties.cpp.

◆ setAllowedToEditDiagramLayerSettings()

void QgsStackedDiagramPropertiesDialog::setAllowedToEditDiagramLayerSettings ( bool allowed) const

Delegates to the main widget to set whether the widget should show diagram layer settings to be edited.

Parameters
allowedWhether the main widget should be allowed to edit diagram layer settings.

Definition at line 361 of file qgsstackeddiagramproperties.cpp.

◆ syncToRenderer()

void QgsStackedDiagramPropertiesDialog::syncToRenderer ( const QgsDiagramRenderer * dr) const

Delegates to the diagram properties widget to sync with the given renderer.

Definition at line 333 of file qgsstackeddiagramproperties.cpp.

◆ syncToSettings()

void QgsStackedDiagramPropertiesDialog::syncToSettings ( const QgsDiagramLayerSettings * dls) const

Delegates to the diagram properties widget to sync with the given diagram layer settings.

Definition at line 338 of file qgsstackeddiagramproperties.cpp.


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