Skip to content
Permalink
Browse files

Update docs

  • Loading branch information
m-kuhn committed Mar 11, 2019
1 parent 6b42ccb commit 05ff817a975d5ba7e3352d3099b8b203f482fb2e
Showing with 28 additions and 0 deletions.
  1. +14 −0 python/core/auto_generated/qgspallabeling.sip.in
  2. +14 −0 src/core/qgspallabeling.h
@@ -261,6 +261,20 @@ class QgsPalLayerSettings
AlwaysShow
};


bool prepare( const QgsRenderContext &context, QSet<QString> &attributeNames /In,Out/, const QgsFields &fields, const QgsMapSettings &mapSettings, const QgsCoordinateReferenceSystem &crs );
%Docstring
Prepare for registration of features.
The ``context``, ``mapSettings`` and ``fields`` parameters give more
information about the rendering environment.
If target ``crs`` is not specified, the targetCrs from ``mapSettings``
will be taken.
The parameter ``attributeNames`` should be updated to contain all the field
names which the labeling requires for the rendering.

.. versionadded:: 3.8
%End

static const QgsPropertiesDefinition &propertyDefinitions();
%Docstring
Returns the labeling property definitions.
@@ -370,6 +370,20 @@ class CORE_EXPORT QgsPalLayerSettings
AlwaysShow = 20
};


/**
* Prepare for registration of features.
* The \a context, \a mapSettings and \a fields parameters give more
* information about the rendering environment.
* If target \a crs is not specified, the targetCrs from \a mapSettings
* will be taken.
* The parameter \a attributeNames should be updated to contain all the field
* names which the labeling requires for the rendering.
*
* \since QGIS 3.8
*/
bool prepare( const QgsRenderContext &context, QSet<QString> &attributeNames SIP_INOUT, const QgsFields &fields, const QgsMapSettings &mapSettings, const QgsCoordinateReferenceSystem &crs );

/**
* Returns the labeling property definitions.
* \since QGIS 3.0

0 comments on commit 05ff817

Please sign in to comment.
You can’t perform that action at this time.