15#ifndef QGSLABELINGENGINESETTINGS_H
16#define QGSLABELINGENGINESETTINGS_H
108 Q_UNUSED( candPoint )
110 Q_UNUSED( candPolygon )
119 Q_UNUSED( candPoint )
121 Q_UNUSED( candPolygon )
143 void readSettingsFromProject(
QgsProject *project );
150 void writeSettingsToProject(
QgsProject *project );
162 void writeXml( QDomDocument &doc, QDomElement &element,
const QgsReadWriteContext &context )
const;
185 void resolveReferences(
const QgsProject *project );
199 return mDefaultTextRenderFormat;
210 mDefaultTextRenderFormat = format;
219 QColor unplacedLabelColor()
const;
227 void setUnplacedLabelColor(
const QColor &color );
253 QList< QgsAbstractLabelingEngineRule * > rules();
263 QList< const QgsAbstractLabelingEngineRule * > rules() const
SIP_SKIP;
291 Qgis::LabelingFlags mFlags =
Qgis::LabelingFlag::UsePartialCandidates;
293 Search mSearchMethod = Chain;
296 double mMaxLineCandidatesPerCm = 5;
297 double mMaxPolygonCandidatesPerCmSquared = 2.5;
299 QColor mUnplacedLabelColor = QColor( 255, 0, 0 );
301 Qgis::LabelPlacementEngineVersion mPlacementVersion =
Qgis::LabelPlacementEngineVersion::Version2;
303 Qgis::TextRenderFormat mDefaultTextRenderFormat =
Qgis::TextRenderFormat::AlwaysOutlines;
The Qgis class provides global constants for use throughout the application.
LabelingFlag
Various flags that affect drawing and placement of labels.
TextRenderFormat
Options for rendering text.
QFlags< LabelingFlag > LabelingFlags
Flags that affect drawing and placement of labels.
LabelPlacementEngineVersion
Labeling placement engine version.
Abstract base class for labeling engine rules.
Stores global configuration for labeling engine.
Q_DECL_DEPRECATED void numCandidatePositions(int &candPoint, int &candLine, int &candPolygon) const
Gets number of candidate positions that will be generated for each label feature.
Qgis::TextRenderFormat defaultTextRenderFormat() const
Returns the default text rendering format for the labels.
void setDefaultTextRenderFormat(Qgis::TextRenderFormat format)
Sets the default text rendering format for the labels.
void setFlag(Qgis::LabelingFlag f, bool enabled=true)
Sets whether a particual flag is enabled.
Q_DECL_DEPRECATED Search searchMethod() const
Which search method to use for removal collisions between labels.
Search
Search methods in the PAL library to remove colliding labels (methods have different processing speed...
void setMaximumPolygonCandidatesPerCmSquared(double candidates)
Sets the maximum number of polygon label candidates per centimeter squared.
bool testFlag(Qgis::LabelingFlag f) const
Test whether a particular flag is enabled.
~QgsLabelingEngineSettings()
Qgis::LabelingFlags flags() const
Gets flags of the labeling engine.
Q_DECL_DEPRECATED void setNumCandidatePositions(int candPoint, int candLine, int candPolygon)
Sets the number of candidate positions that will be generated for each label feature.
void setFlags(Qgis::LabelingFlags flags)
Sets flags of the labeling engine.
double maximumPolygonCandidatesPerCmSquared() const
Returns the maximum number of polygon label candidate positions per centimeter squared.
Q_DECL_DEPRECATED void setSearchMethod(Search s)
Used to set which search method to use for removal collisions between labels.
void setMaximumLineCandidatesPerCm(double candidates)
Sets the maximum number of line label candidates per centimeter.
double maximumLineCandidatesPerCm() const
Returns the maximum number of line label candidate positions per centimeter.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
The class is used as a container of context for various read/write operations on other objects.