sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-03-04 00:30:59 -05:00
Code Issues Packages Projects Releases Wiki Activity
QGIS/python/core/auto_generated/qgslabelingenginesettings.sip.in

151 lines
4.0 KiB
Plaintext
Raw Normal View History

Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgslabelingenginesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLabelingEngineSettings
{
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
Stores global configuration for labeling engine
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslabelingenginesettings.h"
%End
public:
enum Flag
{
UseAllLabels,
UsePartialCandidates,
[needs-docs] Upgrade project level setting for Label as Outlines/text setting to use newer API And replace labeling engine dialog "Draw text as outlines" checkbox with a combobox presenting the choice of always rendering as outlines OR text. (This will allow us to easily add additional methods in future, e.g. potentially a "Render as text wherever possible" setting, for defaulting to text objects whenever it doesn't impact the rendering quality to do so)
2018-11-28 08:16:21 +10:00
// TODO QGIS 4.0: remove
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
RenderOutlineLabels,
DrawLabelRectOnly,
DrawCandidates,
Append additional "QgsCalloutContext" member to callout rendering virtual methods While unused for now, this gives us flexibility in future to specify additional useful contextual information about how a callout should be rendered without breaking API (e.g. label text alignment, label font settings, etc)
2019-07-19 11:55:15 +10:00
DrawUnplacedLabels,
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
};
typedef QFlags<QgsLabelingEngineSettings::Flag> Flags;
[needs-docs][labeling] Drop setting to control label solution method from project labeling settings This is an unnecessary setting, resulting in 1000's of extra, very complex and untested lines of code. Furthermore, the differences are almost non-existant and it's extremely unlikely end users would (or should) need to change this setting.
2019-07-29 09:55:35 +10:00
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
enum Search
{
Chain,
Popmusic_Tabu,
Popmusic_Chain,
Popmusic_Tabu_Chain,
Falp
};
QgsLabelingEngineSettings();
void clear();
%Docstring
More documentation compliance Use Qt style "returns .." tense instead of "return ..", and lock this in with a documentation compliance unit test
2018-05-25 13:54:27 +10:00
Returns the configuration to the defaults
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%End
void setFlags( Flags flags );
%Docstring
More documentation compliance Use Qt style "returns .." tense instead of "return ..", and lock this in with a documentation compliance unit test
2018-05-25 13:54:27 +10:00
Sets flags of the labeling engine
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%End
Flags flags() const;
%Docstring
Add "get ..." to doxygen compliance blacklist Should be "gets ..." for consistent tense, or better yet "returns ..." for consistency.
2018-05-26 18:44:30 +10:00
Gets flags of the labeling engine
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%End
bool testFlag( Flag f ) const;
%Docstring
Test whether a particular flag is enabled
%End
void setFlag( Flag f, bool enabled = true );
%Docstring
More documentation compliance Use Qt style "returns .." tense instead of "return ..", and lock this in with a documentation compliance unit test
2018-05-25 13:54:27 +10:00
Sets whether a particual flag is enabled
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%End
void numCandidatePositions( int &candPoint, int &candLine, int &candPolygon ) const;
%Docstring
Add "get ..." to doxygen compliance blacklist Should be "gets ..." for consistent tense, or better yet "returns ..." for consistency.
2018-05-26 18:44:30 +10:00
Gets number of candidate positions that will be generated for each label feature (default to 8)
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%End
void setNumCandidatePositions( int candPoint, int candLine, int candPolygon );
%Docstring
More documentation compliance Use Qt style "returns .." tense instead of "return ..", and lock this in with a documentation compliance unit test
2018-05-25 13:54:27 +10:00
Sets number of candidate positions that will be generated for each label feature
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%End
[needs-docs][labeling] Drop setting to control label solution method from project labeling settings This is an unnecessary setting, resulting in 1000's of extra, very complex and untested lines of code. Furthermore, the differences are almost non-existant and it's extremely unlikely end users would (or should) need to change this setting.
2019-07-29 09:55:35 +10:00
void setSearchMethod( Search s ) /Deprecated/;
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%Docstring
[needs-docs][labeling] Drop setting to control label solution method from project labeling settings This is an unnecessary setting, resulting in 1000's of extra, very complex and untested lines of code. Furthermore, the differences are almost non-existant and it's extremely unlikely end users would (or should) need to change this setting.
2019-07-29 09:55:35 +10:00
Used to set which search method to use for removal collisions between labels
.. deprecated:: since QGIS 3.10 - Chain is always used.
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%End
[needs-docs][labeling] Drop setting to control label solution method from project labeling settings This is an unnecessary setting, resulting in 1000's of extra, very complex and untested lines of code. Furthermore, the differences are almost non-existant and it's extremely unlikely end users would (or should) need to change this setting.
2019-07-29 09:55:35 +10:00
Search searchMethod() const /Deprecated/;
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%Docstring
Which search method to use for removal collisions between labels
[needs-docs][labeling] Drop setting to control label solution method from project labeling settings This is an unnecessary setting, resulting in 1000's of extra, very complex and untested lines of code. Furthermore, the differences are almost non-existant and it's extremely unlikely end users would (or should) need to change this setting.
2019-07-29 09:55:35 +10:00
.. deprecated:: since QGIS 3.10 - Chain is always used.
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
%End
void readSettingsFromProject( QgsProject *project );
%Docstring
Read configuration of the labeling engine from a project
%End
void writeSettingsToProject( QgsProject *project );
%Docstring
Write configuration of the labeling engine to a project
%End
[needs-docs] Upgrade project level setting for Label as Outlines/text setting to use newer API And replace labeling engine dialog "Draw text as outlines" checkbox with a combobox presenting the choice of always rendering as outlines OR text. (This will allow us to easily add additional methods in future, e.g. potentially a "Render as text wherever possible" setting, for defaulting to text objects whenever it doesn't impact the rendering quality to do so)
2018-11-28 08:16:21 +10:00
QgsRenderContext::TextRenderFormat defaultTextRenderFormat() const;
%Docstring
Returns the default text rendering format for the labels.
.. seealso:: :py:func:`setDefaultTextRenderFormat`
.. versionadded:: 3.4.3
%End
void setDefaultTextRenderFormat( QgsRenderContext::TextRenderFormat format );
%Docstring
Sets the default text rendering ``format`` for the labels.
.. seealso:: :py:func:`defaultTextRenderFormat`
.. versionadded:: 3.4.3
Append additional "QgsCalloutContext" member to callout rendering virtual methods While unused for now, this gives us flexibility in future to specify additional useful contextual information about how a callout should be rendered without breaking API (e.g. label text alignment, label font settings, etc)
2019-07-19 11:55:15 +10:00
%End
QColor unplacedLabelColor() const;
%Docstring
Returns the color to use when rendering unplaced labels.
.. seealso:: :py:func:`setUnplacedLabelColor`
.. versionadded:: 3.10
%End
void setUnplacedLabelColor( const QColor &color );
%Docstring
Sets the ``color`` to use when rendering unplaced labels.
.. seealso:: :py:func:`unplacedLabelColor`
.. versionadded:: 3.10
[needs-docs] Upgrade project level setting for Label as Outlines/text setting to use newer API And replace labeling engine dialog "Draw text as outlines" checkbox with a combobox presenting the choice of always rendering as outlines OR text. (This will allow us to easily add additional methods in future, e.g. potentially a "Render as text wherever possible" setting, for defaulting to text objects whenever it doesn't impact the rendering quality to do so)
2018-11-28 08:16:21 +10:00
%End
Move labeling engine config to a new class + QgsPalLabeling cleanup Another bit to make core library independent from QgsProject::instance(). Until now labeling engine configuration was taken from project singleton. Removed legacy methods from QgsPalLabeling - the class now does not have any more member variables/methods, it is just a bunch of helper functions. (PR #4384)
2017-04-21 18:04:09 +08:00
};
QFlags<QgsLabelingEngineSettings::Flag> operator|(QgsLabelingEngineSettings::Flag f1, QFlags<QgsLabelingEngineSettings::Flag> f2);
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgslabelingenginesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
Reference in New Issue Copy Permalink