Update docs

qgis · Mar 11, 2019 · 05ff817 · 05ff817
1 parent 6b42ccb
commit 05ff817
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/python/core/auto_generated/qgspallabeling.sip.in b/python/core/auto_generated/qgspallabeling.sip.in
@@ -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.

diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h
@@ -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