#include <qgslabelingwidget.h>
Inheritance diagram for QgsLabelingWidget:
Public Slots | |
| void | adaptToLayer () |
| reload the settings shown in the dialog from the current layer More... | |
| void | apply () override |
| Saves the labeling configuration and immediately updates the map canvas to reflect the changes. More... | |
| void | resetSettings () |
| Reset the settings. More... | |
| void | setLayer (QgsMapLayer *layer) |
| Sets the layer to configure. More... | |
| void | writeSettingsToLayer () |
| save config to layer More... | |
 Public Slots inherited from QgsMapLayerConfigWidget | |
| virtual void | apply ()=0 |
| Called when changes to the layer need to be made. More... | |
| 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 | |
| void | auxiliaryFieldCreated () |
| Emitted when an auxiliary field is created. 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 | |
| QgsLabelingWidget (QgsVectorLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr, QgsMessageBar *messageBar=nullptr) | |
| constructor More... | |
| QgsLabelingGui * | labelingGui () |
Returns the labeling gui widget or nullptr if none. More... | |
| Public Member Functions inherited from QgsMapLayerConfigWidget | |
| QgsMapLayerConfigWidget (QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr) | |
| A panel widget that can be shown in the map style dock. More... | |
| virtual bool | shouldTriggerLayerRepaint () const |
| Whether this config widget changes map layer properties in a way that triggerRepaint() should be called for the layer after applying changes. More... | |
| virtual void | syncToLayer (QgsMapLayer *layer) |
| Reset to original (vector layer) values. 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... | |
| virtual QMenu * | menuButtonMenu () |
Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More... | |
| virtual QString | menuButtonTooltip () const |
| Returns the (translated) tooltip text to use for the menu button for this panel. 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 | |
| Static Public Member Functions inherited from QgsPanelWidget | |
| static QgsPanelWidget * | findParentPanel (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) override |
| Overridden key press event to handle the esc event on the widget. More... | |
| Protected Attributes inherited from QgsMapLayerConfigWidget | |
| QgsMapLayer * | mLayer = nullptr |
| QgsMapCanvas * | mMapCanvas = nullptr |
Detailed Description
Master widget for configuration of labeling of a vector layer
- Note
- This class is not a part of public API
- Since
- QGIS 3.14
Definition at line 44 of file qgslabelingwidget.h.
Constructor & Destructor Documentation
◆ QgsLabelingWidget()
| QgsLabelingWidget::QgsLabelingWidget | ( | QgsVectorLayer * | layer, |
| QgsMapCanvas * | canvas, | ||
| QWidget * | parent = nullptr, |
||
| QgsMessageBar * | messageBar = nullptr |
||
| ) |
constructor
Definition at line 31 of file qgslabelingwidget.cpp.
Member Function Documentation
◆ adaptToLayer
|
slot |
reload the settings shown in the dialog from the current layer
Definition at line 95 of file qgslabelingwidget.cpp.
◆ apply
|
overrideslot |
Saves the labeling configuration and immediately updates the map canvas to reflect the changes.
Definition at line 160 of file qgslabelingwidget.cpp.
◆ auxiliaryFieldCreated
|
signal |
Emitted when an auxiliary field is created.
◆ labelingGui()
| QgsLabelingGui * QgsLabelingWidget::labelingGui | ( | ) |
Returns the labeling gui widget or nullptr if none.
- Since
- QGIS 3.0
Definition at line 54 of file qgslabelingwidget.cpp.
◆ resetSettings
|
slot |
Reset the settings.
Definition at line 59 of file qgslabelingwidget.cpp.
◆ setLayer
|
slot |
Sets the layer to configure.
Definition at line 70 of file qgslabelingwidget.cpp.
◆ writeSettingsToLayer
|
slot |
save config to layer
Definition at line 124 of file qgslabelingwidget.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.14.0+99unstable/src/gui/labeling/qgslabelingwidget.h
- /build/qgis-3.14.0+99unstable/src/gui/labeling/qgslabelingwidget.cpp
