mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-14 00:07:35 -04:00
5bdae75156
This enables correct loading/saving of relative paths of SVG files for background of labels
95 lines
3.8 KiB
C++
95 lines
3.8 KiB
C++
/***************************************************************************
|
|
qgsvectorlayerlabeling.h
|
|
---------------------
|
|
begin : September 2015
|
|
copyright : (C) 2015 by Martin Dobias
|
|
email : wonder dot sk at gmail dot com
|
|
***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************/
|
|
#ifndef QGSVECTORLAYERLABELING_H
|
|
#define QGSVECTORLAYERLABELING_H
|
|
|
|
#include <QString>
|
|
#include <QStringList>
|
|
|
|
#include "qgis_core.h"
|
|
|
|
class QDomDocument;
|
|
class QDomElement;
|
|
|
|
class QgsPalLayerSettings;
|
|
class QgsReadWriteContext;
|
|
class QgsVectorLayer;
|
|
class QgsVectorLayerLabelProvider;
|
|
|
|
/** \ingroup core
|
|
* Abstract base class - its implementations define different approaches to the labeling of a vector layer.
|
|
*
|
|
* \since QGIS 2.12
|
|
* \note not available in Python bindings
|
|
* \note this class is not a part of public API yet. See notes in QgsLabelingEngine
|
|
*/
|
|
class CORE_EXPORT QgsAbstractVectorLayerLabeling
|
|
{
|
|
public:
|
|
|
|
virtual ~QgsAbstractVectorLayerLabeling() = default;
|
|
|
|
//! Unique type string of the labeling configuration implementation
|
|
virtual QString type() const = 0;
|
|
|
|
//! Factory for label provider implementation
|
|
virtual QgsVectorLayerLabelProvider *provider( QgsVectorLayer *layer ) const = 0;
|
|
|
|
//! Return labeling configuration as XML element
|
|
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const = 0;
|
|
|
|
//! Get list of sub-providers within the layer's labeling.
|
|
virtual QStringList subProviders() const { return QStringList( QString() ); }
|
|
|
|
//! Get associated label settings. In case of multiple sub-providers with different settings,
|
|
//! they are identified by their ID (e.g. in case of rule-based labeling, provider ID == rule key)
|
|
virtual QgsPalLayerSettings settings( QgsVectorLayer *layer, const QString &providerId = QString() ) const = 0;
|
|
|
|
/**
|
|
* 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.
|
|
* \since QGIS 3.0
|
|
*/
|
|
virtual bool requiresAdvancedEffects( QgsVectorLayer *layer ) const = 0;
|
|
|
|
// static stuff
|
|
|
|
//! Try to create instance of an implementation based on the XML data
|
|
static QgsAbstractVectorLayerLabeling *create( const QDomElement &element, const QgsReadWriteContext &context );
|
|
};
|
|
|
|
/** \ingroup core
|
|
* Basic implementation of the labeling interface.
|
|
*
|
|
* The configuration is kept in layer's custom properties for backward compatibility.
|
|
*
|
|
* \since QGIS 2.12
|
|
* \note not available in Python bindings
|
|
* \note this class is not a part of public API yet. See notes in QgsLabelingEngine
|
|
*/
|
|
class CORE_EXPORT QgsVectorLayerSimpleLabeling : public QgsAbstractVectorLayerLabeling
|
|
{
|
|
public:
|
|
|
|
virtual QString type() const override;
|
|
virtual QgsVectorLayerLabelProvider *provider( QgsVectorLayer *layer ) const override;
|
|
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const override;
|
|
virtual QgsPalLayerSettings settings( QgsVectorLayer *layer, const QString &providerId = QString() ) const override;
|
|
bool requiresAdvancedEffects( QgsVectorLayer *layer ) const override;
|
|
};
|
|
|
|
#endif // QGSVECTORLAYERLABELING_H
|