QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgslabelobstaclesettingswidget.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslabelobstaclesettingswidget.h
3  ----------------------
4  begin : December 2019
5  copyright : (C) 2019 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSLABELOBSTACLESETTINGSWIDGET_H
17 #define QGSLABELOBSTACLESETTINGSWIDGET_H
18 
19 #include "ui_qgslabelobstaclesettingswidgetbase.h"
21 #include "qgspallabeling.h"
22 #include "qgis_gui.h"
23 #include "qgis_sip.h"
24 
31 class GUI_EXPORT QgsLabelObstacleSettingsWidget : public QgsLabelSettingsWidgetBase, private Ui::QgsLabelObstacleSettingsWidgetBase
32 {
33  Q_OBJECT
34 
35  public:
36 
42  QgsLabelObstacleSettingsWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr, QgsVectorLayer *vl = nullptr );
43 
49  void setSettings( const QgsLabelObstacleSettings &settings );
50 
56  QgsLabelObstacleSettings settings() const;
57 
58  void setGeometryType( QgsWkbTypes::GeometryType type ) override;
59 
60  void updateDataDefinedProperties( QgsPropertyCollection &properties ) override;
61 
62  private:
63 
64  bool mBlockSignals = false;
65 
66 };
67 
68 #endif // QGSLABELOBSTACLESETTINGSWIDGET_H
qgslabelsettingswidgetbase.h
qgspallabeling.h
QgsLabelObstacleSettings
Contains settings related to how the label engine treats features as obstacles.
Definition: qgslabelobstaclesettings.h:35
QgsLabelSettingsWidgetBase::setGeometryType
virtual void setGeometryType(QgsWkbTypes::GeometryType type)
Sets the geometry type of the features to customize the widget accordingly.
Definition: qgslabelsettingswidgetbase.cpp:42
qgis_sip.h
QgsLabelSettingsWidgetBase::updateDataDefinedProperties
virtual void updateDataDefinedProperties(QgsPropertyCollection &properties)
Updates a data defined properties collection, correctly setting the values for any properties related...
Definition: qgslabelsettingswidgetbase.cpp:140
QgsPropertyCollection
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
Definition: qgspropertycollection.h:319
QgsLabelSettingsWidgetBase
Base class for widgets which allow customization of label engine properties, such as label placement ...
Definition: qgslabelsettingswidgetbase.h:39
QgsWkbTypes::GeometryType
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Definition: qgswkbtypes.h:141
QgsVectorLayer
Represents a vector layer which manages a vector based data sets.
Definition: qgsvectorlayer.h:387
QgsLabelObstacleSettingsWidget
A widget for customising label obstacle settings.
Definition: qgslabelobstaclesettingswidget.h:32
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53