Doxygen fixes

This commit is contained in:
Martin Dobias 2020-04-08 13:29:24 +02:00 committed by Nyall Dawson
parent 7c1d1fe97c
commit 1f554621b2
3 changed files with 10 additions and 0 deletions

View File

@ -107,6 +107,12 @@ class CORE_EXPORT QgsVectorLayerLabelProvider : public QgsAbstractLabelProvider
*/
const QgsPalLayerSettings &settings() const;
/**
* Sets fields of this label provider. Normally this is not needed, but when used for vector tiles,
* fields are not known at the time of creation of label providers. It should be called before
* a call to prepare() which uses the list of fields.
* \since QGIS 3.14
*/
void setFields( const QgsFields &fields ) { mFields = fields; }
protected:

View File

@ -137,7 +137,9 @@ class CORE_EXPORT QgsVectorTileBasicLabeling : public QgsVectorTileLabeling
class QgsVectorTileBasicLabelProvider : public QgsVectorTileLabelProvider
{
public:
//! Constructs a label provider for the given vector tile layer and using styling from QgsVectorTileBasicLabeling
QgsVectorTileBasicLabelProvider( QgsVectorTileLayer *layer, const QList<QgsVectorTileBasicLabelingStyle> &styles );
QList<QgsAbstractLabelProvider *> subProviders() override;
bool prepare( QgsRenderContext &context, QSet<QString> &attributeNames ) override;
void registerTileFeatures( const QgsVectorTileRendererData &tile, QgsRenderContext &context ) override;
@ -155,6 +157,7 @@ class QgsVectorTileBasicLabelProvider : public QgsVectorTileLabelProvider
QMap<QString, QSet<QString> > mRequiredFields;
};
/// @endcond
#endif

View File

@ -33,6 +33,7 @@ class QgsVectorTileRendererData;
class QgsVectorTileLabelProvider : public QgsVectorLayerLabelProvider
{
public:
//! Constructs base label provider class for the given vector tile layer
explicit QgsVectorTileLabelProvider( QgsVectorTileLayer *layer );
//! Returns field names for each sub-layer that are required for labeling