QGIS API Documentation 3.27.0-Master (0a97e3138f)
qgslabelplacementsettings.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslabelplacementsettings.h
3 --------------------------
4 Date : May 2022
5 Copyright : (C) 2022 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 QGSLABELPLACEMENTSETTINGS_H
17#define QGSLABELPLACEMENTSETTINGS_H
18
19#include "qgis_core.h"
20#include "qgis_sip.h"
21#include "qgis.h"
22
25
35{
36 public:
37
42 Qgis::LabelOverlapHandling overlapHandling() const { return mOverlapHandling; }
43
48 void setOverlapHandling( Qgis::LabelOverlapHandling handling ) { mOverlapHandling = handling; }
49
59 bool allowDegradedPlacement() const { return mAllowDegradedPlacement; }
60
70 void setAllowDegradedPlacement( bool allow ) { mAllowDegradedPlacement = allow; }
71
76 void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
77
78 private:
79
81
82 bool mAllowDegradedPlacement = false;
83
84};
85
86#endif // QGSLABELPLACEMENTSETTINGS_H
LabelOverlapHandling
Label overlap handling.
Definition: qgis.h:546
@ PreventOverlap
Do not allow labels to overlap other labels.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Contains general settings related to how labels are placed.
void setOverlapHandling(Qgis::LabelOverlapHandling handling)
Sets the technique used to handle overlapping labels.
Qgis::LabelOverlapHandling overlapHandling() const
Returns the technique used to handle overlapping labels.
bool allowDegradedPlacement() const
Returns true if labels can be placed in inferior fallback positions if they cannot otherwise be place...
void setAllowDegradedPlacement(bool allow)
Sets whether labels can be placed in inferior fallback positions if they cannot otherwise be placed.
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.