QGIS API Documentation  3.0.2-Girona (307d082)
qgslabelingenginesettings.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgslabelingenginesettings.cpp
3  --------------------------------------
4  Date : April 2017
5  Copyright : (C) 2017 by Martin Dobias
6  Email : wonder dot sk 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 
17 
18 #include "qgsproject.h"
19 
20 
22  : mFlags( RenderOutlineLabels | UsePartialCandidates )
23 {
24 }
25 
27 {
28  *this = QgsLabelingEngineSettings();
29 }
30 
32 {
33  bool saved = false;
34  mSearchMethod = static_cast< Search >( prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/SearchMethod" ), static_cast< int >( Chain ), &saved ) );
35  mCandPoint = prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesPoint" ), 16, &saved );
36  mCandLine = prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesLine" ), 50, &saved );
37  mCandPolygon = prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesPolygon" ), 30, &saved );
38 
39  mFlags = nullptr;
40  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingCandidates" ), false, &saved ) ) mFlags |= DrawCandidates;
41  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawRectOnly" ), false, &saved ) ) mFlags |= DrawLabelRectOnly;
42  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingAllLabels" ), false, &saved ) ) mFlags |= UseAllLabels;
43  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingPartialsLabels" ), true, &saved ) ) mFlags |= UsePartialCandidates;
44  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawOutlineLabels" ), true, &saved ) ) mFlags |= RenderOutlineLabels;
45 }
46 
48 {
49  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/SearchMethod" ), static_cast< int >( mSearchMethod ) );
50  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesPoint" ), mCandPoint );
51  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesLine" ), mCandLine );
52  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesPolygon" ), mCandPolygon );
53 
54  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingCandidates" ), mFlags.testFlag( DrawCandidates ) );
55  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawRectOnly" ), mFlags.testFlag( DrawLabelRectOnly ) );
56  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingAllLabels" ), mFlags.testFlag( UseAllLabels ) );
57  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingPartialsLabels" ), mFlags.testFlag( UsePartialCandidates ) );
58  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawOutlineLabels" ), mFlags.testFlag( RenderOutlineLabels ) );
59 }
bool readBoolEntry(const QString &scope, const QString &key, bool def=false, bool *ok=nullptr) const
Whether to use also label candidates that are partially outside of the map view.
Whether to only draw the label rect and not the actual label text (used for unit tests) ...
int readNumEntry(const QString &scope, const QString &key, int def=0, bool *ok=nullptr) const
Whether to render labels as text or outlines.
void readSettingsFromProject(QgsProject *project)
Read configuration of the labeling engine from a project.
void clear()
Return the configuration to the defaults.
Whether to draw all labels even if there would be collisions.
bool writeEntry(const QString &scope, const QString &key, bool value)
Write a boolean entry to the project file.
Reads and writes project states.
Definition: qgsproject.h:82
Whether to draw rectangles of generated candidates (good for debugging)
void writeSettingsToProject(QgsProject *project)
Write configuration of the labeling engine to a project.
Search
Search methods in the PAL library to remove colliding labels (methods have different processing speed...