mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-25 00:58:06 -05:00
109 lines
3.0 KiB
Plaintext
109 lines
3.0 KiB
Plaintext
/************************************************************************
|
|
* 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
|
|
Stores global configuration for labeling engine
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslabelingenginesettings.h"
|
|
%End
|
|
public:
|
|
enum Flag
|
|
{
|
|
UseAllLabels,
|
|
UsePartialCandidates,
|
|
RenderOutlineLabels,
|
|
DrawLabelRectOnly,
|
|
DrawCandidates,
|
|
};
|
|
typedef QFlags<QgsLabelingEngineSettings::Flag> Flags;
|
|
|
|
|
|
enum Search
|
|
{
|
|
Chain,
|
|
Popmusic_Tabu,
|
|
Popmusic_Chain,
|
|
Popmusic_Tabu_Chain,
|
|
Falp
|
|
};
|
|
|
|
QgsLabelingEngineSettings();
|
|
|
|
void clear();
|
|
%Docstring
|
|
Return the configuration to the defaults
|
|
%End
|
|
|
|
void setFlags( Flags flags );
|
|
%Docstring
|
|
Set flags of the labeling engine
|
|
%End
|
|
Flags flags() const;
|
|
%Docstring
|
|
Get flags of the labeling engine
|
|
:rtype: Flags
|
|
%End
|
|
bool testFlag( Flag f ) const;
|
|
%Docstring
|
|
Test whether a particular flag is enabled
|
|
:rtype: bool
|
|
%End
|
|
void setFlag( Flag f, bool enabled = true );
|
|
%Docstring
|
|
Set whether a particual flag is enabled
|
|
%End
|
|
|
|
void numCandidatePositions( int &candPoint, int &candLine, int &candPolygon ) const;
|
|
%Docstring
|
|
Get number of candidate positions that will be generated for each label feature (default to 8)
|
|
%End
|
|
void setNumCandidatePositions( int candPoint, int candLine, int candPolygon );
|
|
%Docstring
|
|
Set number of candidate positions that will be generated for each label feature
|
|
%End
|
|
|
|
void setSearchMethod( Search s );
|
|
%Docstring
|
|
Set which search method to use for removal collisions between labels
|
|
%End
|
|
Search searchMethod() const;
|
|
%Docstring
|
|
Which search method to use for removal collisions between labels
|
|
:rtype: Search
|
|
%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
|
|
|
|
};
|
|
|
|
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 *
|
|
************************************************************************/
|