mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-26 00:02:08 -05:00
21f03bc11c
Historically the configuration used to be stored in layer's custom properties, but that does not scale beyond simple rendering and so rule-based labeling introduced storage of configuration natively in XML elements. That left us with two different ways of reading/writing labeling configurations. This work makes all configuration to use native XML elements. To keep compatibility of 2.x projects, reading of configuration from custom properties is preserved. This commit also adds Python APIs for direct manipulation of labeling configuration through vector layer's setLabeling() and labeling() calls.
122 lines
3.8 KiB
Plaintext
122 lines
3.8 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsvectorlayerlabeling.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsAbstractVectorLayerLabeling
|
|
{
|
|
%Docstring
|
|
Abstract base class - its implementations define different approaches to the labeling of a vector layer.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsvectorlayerlabeling.h"
|
|
%End
|
|
public:
|
|
|
|
QgsAbstractVectorLayerLabeling();
|
|
virtual ~QgsAbstractVectorLayerLabeling();
|
|
|
|
virtual QString type() const = 0;
|
|
%Docstring
|
|
Unique type string of the labeling configuration implementation
|
|
:rtype: str
|
|
%End
|
|
|
|
virtual QgsAbstractVectorLayerLabeling *clone() const = 0 /Factory/;
|
|
%Docstring
|
|
Return a new copy of the object
|
|
:rtype: QgsAbstractVectorLayerLabeling
|
|
%End
|
|
|
|
|
|
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const = 0;
|
|
%Docstring
|
|
Return labeling configuration as XML element
|
|
:rtype: QDomElement
|
|
%End
|
|
|
|
virtual QStringList subProviders() const;
|
|
%Docstring
|
|
Get list of sub-providers within the layer's labeling.
|
|
:rtype: list of str
|
|
%End
|
|
|
|
virtual QgsPalLayerSettings settings( const QString &providerId = QString() ) const = 0;
|
|
%Docstring
|
|
they are identified by their ID (e.g. in case of rule-based labeling, provider ID == rule key)
|
|
:rtype: QgsPalLayerSettings
|
|
%End
|
|
|
|
virtual bool requiresAdvancedEffects() const = 0;
|
|
%Docstring
|
|
Returns true if drawing labels requires advanced effects like composition
|
|
modes, which could prevent it being used as an isolated cached image
|
|
or exported to a vector format.
|
|
.. versionadded:: 3.0
|
|
:rtype: bool
|
|
%End
|
|
|
|
|
|
static QgsAbstractVectorLayerLabeling *create( const QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
|
|
%Docstring
|
|
Try to create instance of an implementation based on the XML data
|
|
:rtype: QgsAbstractVectorLayerLabeling
|
|
%End
|
|
|
|
private:
|
|
QgsAbstractVectorLayerLabeling( const QgsAbstractVectorLayerLabeling &rhs );
|
|
};
|
|
|
|
class QgsVectorLayerSimpleLabeling : QgsAbstractVectorLayerLabeling
|
|
{
|
|
%Docstring
|
|
Basic implementation of the labeling interface.
|
|
|
|
The configuration is kept in layer's custom properties for backward compatibility.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsvectorlayerlabeling.h"
|
|
%End
|
|
public:
|
|
explicit QgsVectorLayerSimpleLabeling( const QgsPalLayerSettings &settings );
|
|
%Docstring
|
|
Constructs simple labeling configuration with given initial settings
|
|
%End
|
|
|
|
virtual QString type() const;
|
|
virtual QgsAbstractVectorLayerLabeling *clone() const /Factory/;
|
|
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const;
|
|
virtual QgsPalLayerSettings settings( const QString &providerId = QString() ) const;
|
|
virtual bool requiresAdvancedEffects() const;
|
|
|
|
|
|
static QgsVectorLayerSimpleLabeling *create( const QDomElement &element, const QgsReadWriteContext &context );
|
|
%Docstring
|
|
Create the instance from a DOM element with saved configuration
|
|
:rtype: QgsVectorLayerSimpleLabeling
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsvectorlayerlabeling.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|