QGIS API Documentation 3.41.0-Master (45a0abf3bec)
Loading...
Searching...
No Matches
Public Slots | Signals | Public Member Functions | Friends | List of all members
QgsDiagramProperties Class Reference

#include <qgsdiagramproperties.h>

Inheritance diagram for QgsDiagramProperties:
Inheritance graph
[legend]

Public Slots

void apply ()
 
void mAddCategoryPushButton_clicked ()
 
void mAttributesTreeWidget_itemDoubleClicked (QTreeWidgetItem *item, int column)
 
void mDiagramAttributesTreeWidget_itemDoubleClicked (QTreeWidgetItem *item, int column)
 
void mDiagramStackedWidget_currentChanged (int index)
 
void mDiagramTypeComboBox_currentIndexChanged (int index)
 
void mFindMaximumValueButton_clicked ()
 
void mRemoveCategoryPushButton_clicked ()
 
void scalingTypeChanged ()
 
void showAddAttributeExpressionDialog ()
 
void showSizeLegendDialog ()
 
void updatePlacementWidgets ()
 
- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel.
 
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.
 

Signals

void auxiliaryFieldCreated ()
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user.
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface.
 
void widgetChanged ()
 Emitted when the widget state changes.
 

Public Member Functions

 QgsDiagramProperties (QgsVectorLayer *layer, QWidget *parent, QgsMapCanvas *canvas)
 
 ~QgsDiagramProperties () override
 
void addAttribute (QTreeWidgetItem *item)
 Adds an attribute from the list of available attributes to the assigned attributes with a random color.
 
bool isAllowedToEditDiagramLayerSettings () const
 Returns whether this widget is allowed to edit diagram layer settings.
 
void setAllowedToEditDiagramLayerSettings (bool allowed)
 Sets whether the widget should show diagram layer settings.
 
void setDiagramType (const QString diagramType)
 Defines the widget's diagram type and lets it know it should hide the type comboBox.
 
void setDockMode (bool dockMode) override
 Sets the widget in dock mode.
 
void syncToLayer ()
 Updates the widget to reflect the layer's current diagram settings.
 
void syncToRenderer (const QgsDiagramRenderer *dr)
 Updates the widget to reflect the diagram renderer.
 
void syncToSettings (const QgsDiagramLayerSettings *dls)
 Updates the widget to reflect the diagram layer settings.
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel.
 
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.
 
bool autoDelete ()
 The the auto delete property on the widget.
 
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.
 
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.
 
bool dockMode ()
 Returns the dock mode state.
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required.
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel.
 
QString panelTitle ()
 The title of the panel.
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget.
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface.
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 

Friends

class QgsStackedDiagramProperties
 
class QgsStackedDiagramPropertiesDialog
 

Additional Inherited Members

- 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.
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget.
 

Detailed Description

Note
This class is not a part of public API

Definition at line 42 of file qgsdiagramproperties.h.

Constructor & Destructor Documentation

◆ QgsDiagramProperties()

QgsDiagramProperties::QgsDiagramProperties ( QgsVectorLayer layer,
QWidget *  parent,
QgsMapCanvas canvas 
)

Definition at line 69 of file qgsdiagramproperties.cpp.

◆ ~QgsDiagramProperties()

QgsDiagramProperties::~QgsDiagramProperties ( )
override

Definition at line 640 of file qgsdiagramproperties.cpp.

Member Function Documentation

◆ addAttribute()

void QgsDiagramProperties::addAttribute ( QTreeWidgetItem *  item)

Adds an attribute from the list of available attributes to the assigned attributes with a random color.

Definition at line 756 of file qgsdiagramproperties.cpp.

◆ apply

void QgsDiagramProperties::apply ( )
slot

Definition at line 1054 of file qgsdiagramproperties.cpp.

◆ auxiliaryFieldCreated

void QgsDiagramProperties::auxiliaryFieldCreated ( )
signal

◆ isAllowedToEditDiagramLayerSettings()

bool QgsDiagramProperties::isAllowedToEditDiagramLayerSettings ( ) const

Returns whether this widget is allowed to edit diagram layer settings.

Definition at line 1191 of file qgsdiagramproperties.cpp.

◆ mAddCategoryPushButton_clicked

void QgsDiagramProperties::mAddCategoryPushButton_clicked ( )
slot

Definition at line 774 of file qgsdiagramproperties.cpp.

◆ mAttributesTreeWidget_itemDoubleClicked

void QgsDiagramProperties::mAttributesTreeWidget_itemDoubleClicked ( QTreeWidgetItem *  item,
int  column 
)
slot

Definition at line 783 of file qgsdiagramproperties.cpp.

◆ mDiagramAttributesTreeWidget_itemDoubleClicked

void QgsDiagramProperties::mDiagramAttributesTreeWidget_itemDoubleClicked ( QTreeWidgetItem *  item,
int  column 
)
slot

Definition at line 841 of file qgsdiagramproperties.cpp.

◆ mDiagramStackedWidget_currentChanged

void QgsDiagramProperties::mDiagramStackedWidget_currentChanged ( int  index)
slot

Definition at line 1134 of file qgsdiagramproperties.cpp.

◆ mDiagramTypeComboBox_currentIndexChanged

void QgsDiagramProperties::mDiagramTypeComboBox_currentIndexChanged ( int  index)
slot

Definition at line 663 of file qgsdiagramproperties.cpp.

◆ mFindMaximumValueButton_clicked

void QgsDiagramProperties::mFindMaximumValueButton_clicked ( )
slot

Definition at line 798 of file qgsdiagramproperties.cpp.

◆ mRemoveCategoryPushButton_clicked

void QgsDiagramProperties::mRemoveCategoryPushButton_clicked ( )
slot

Definition at line 789 of file qgsdiagramproperties.cpp.

◆ scalingTypeChanged

void QgsDiagramProperties::scalingTypeChanged ( )
slot

Definition at line 1167 of file qgsdiagramproperties.cpp.

◆ setAllowedToEditDiagramLayerSettings()

void QgsDiagramProperties::setAllowedToEditDiagramLayerSettings ( bool  allowed)

Sets whether the widget should show diagram layer settings.

Used by stacked diagrams, which disable editing of DLS for sub diagrams other than the first one.

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

Definition at line 1172 of file qgsdiagramproperties.cpp.

◆ setDiagramType()

void QgsDiagramProperties::setDiagramType ( const QString  diagramType)

Defines the widget's diagram type and lets it know it should hide the type comboBox.

Parameters
diagramTypeType of diagram to be set

Definition at line 363 of file qgsdiagramproperties.cpp.

◆ setDockMode()

void QgsDiagramProperties::setDockMode ( bool  dockMode)
overridevirtual

Sets the widget in dock mode.

Parameters
dockModetrue for dock mode.

Reimplemented from QgsPanelWidget.

Definition at line 350 of file qgsdiagramproperties.cpp.

◆ showAddAttributeExpressionDialog

void QgsDiagramProperties::showAddAttributeExpressionDialog ( )
slot

Definition at line 1100 of file qgsdiagramproperties.cpp.

◆ showSizeLegendDialog

void QgsDiagramProperties::showSizeLegendDialog ( )
slot

Definition at line 1196 of file qgsdiagramproperties.cpp.

◆ syncToLayer()

void QgsDiagramProperties::syncToLayer ( )

Updates the widget to reflect the layer's current diagram settings.

Since
QGIS 3.16

Definition at line 422 of file qgsdiagramproperties.cpp.

◆ syncToRenderer()

void QgsDiagramProperties::syncToRenderer ( const QgsDiagramRenderer dr)

Updates the widget to reflect the diagram renderer.

Does not take ownership.

Parameters
drDiagram renderer where settings are taken from.
Since
QGIS 3.40

Definition at line 441 of file qgsdiagramproperties.cpp.

◆ syncToSettings()

void QgsDiagramProperties::syncToSettings ( const QgsDiagramLayerSettings dls)

Updates the widget to reflect the diagram layer settings.

Does not take ownership.

Parameters
dlsDiagram Layer Settings to update the widget.
Since
QGIS 3.40

Definition at line 593 of file qgsdiagramproperties.cpp.

◆ updatePlacementWidgets

void QgsDiagramProperties::updatePlacementWidgets ( )
slot

Definition at line 1141 of file qgsdiagramproperties.cpp.

Friends And Related Symbol Documentation

◆ QgsStackedDiagramProperties

friend class QgsStackedDiagramProperties
friend

Definition at line 230 of file qgsdiagramproperties.h.

◆ QgsStackedDiagramPropertiesDialog

friend class QgsStackedDiagramPropertiesDialog
friend

Definition at line 231 of file qgsdiagramproperties.h.


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