QGIS API Documentation  2.99.0-Master (cd0ba91)
Public Member Functions | List of all members
QgsDataDefinedSizeLegendWidget Class Reference

Widget for configuration of appearance of legend for marker symbols with data-defined size. More...

#include <qgsdatadefinedsizelegendwidget.h>

Inheritance diagram for QgsDataDefinedSizeLegendWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsDataDefinedSizeLegendWidget (const QgsDataDefinedSizeLegend *ddsLegend, const QgsProperty &ddSize, QgsMarkerSymbol *overrideSymbol, QgsMapCanvas *canvas=nullptr, QWidget *parent=nullptr)
 Creates the dialog and initializes the content to what is passed in the legend configuration (may be null). More...
 
 ~QgsDataDefinedSizeLegendWidget ()
 
QgsDataDefinedSizeLegenddataDefinedSizeLegend () const
 Returns configuration as set up in the dialog (may be null). Ownership is passed to the caller. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=0)
 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 ()
 Return 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...
 

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

Detailed Description

Widget for configuration of appearance of legend for marker symbols with data-defined size.

Since
QGIS 3.0

Definition at line 46 of file qgsdatadefinedsizelegendwidget.h.

Constructor & Destructor Documentation

◆ QgsDataDefinedSizeLegendWidget()

QgsDataDefinedSizeLegendWidget::QgsDataDefinedSizeLegendWidget ( const QgsDataDefinedSizeLegend ddsLegend,
const QgsProperty ddSize,
QgsMarkerSymbol overrideSymbol,
QgsMapCanvas canvas = nullptr,
QWidget *  parent = nullptr 
)
explicit

Creates the dialog and initializes the content to what is passed in the legend configuration (may be null).

The ddSize argument determines scaling of the marker symbol - it should have a size scale transformer assigned to know the range of sizes. The overrideSymbol argument may override the source symbol: this is useful in case when the symbol is given from outside rather than being set inside QgsDataDefinedSizeLegend.

Definition at line 33 of file qgsdatadefinedsizelegendwidget.cpp.

◆ ~QgsDataDefinedSizeLegendWidget()

QgsDataDefinedSizeLegendWidget::~QgsDataDefinedSizeLegendWidget ( )

Definition at line 124 of file qgsdatadefinedsizelegendwidget.cpp.

Member Function Documentation

◆ dataDefinedSizeLegend()

QgsDataDefinedSizeLegend * QgsDataDefinedSizeLegendWidget::dataDefinedSizeLegend ( ) const

Returns configuration as set up in the dialog (may be null). Ownership is passed to the caller.

Definition at line 131 of file qgsdatadefinedsizelegendwidget.cpp.


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