sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-06-18 00:04:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Matthias Kuhn 2019-03-11 12:27:42 +01:00
parent 6b42ccb737
commit 05ff817a97
No known key found for this signature in database
GPG Key ID: 7A7F1A1C90C3E6A7
2 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
python/core/auto_generated/qgspallabeling.sip.in
View File

@ -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.

14
src/core/qgspallabeling.h
View File

@ -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