QGIS/python/core/auto_generated/labeling/qgslabelpointsettings.sip.in
2024-05-23 17:20:30 +10:00

65 lines
2.3 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelpointsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLabelPointSettings
{
%Docstring(signature="appended")
Contains settings related to how the label engine places and formats
labels for point features.
.. versionadded:: 3.38
%End
%TypeHeaderCode
#include "qgslabelpointsettings.h"
%End
public:
static const QMetaObject staticMetaObject;
public:
void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
%Docstring
Updates the point settings to respect any data defined properties
set within the specified ``properties`` collection.
%End
QVector< Qgis::LabelPredefinedPointPosition > predefinedPositionOrder() const;
%Docstring
Returns the ordered list of predefined label positions for points.
Positions earlier in the list will be prioritized over later positions.
Only used when the placement is set to :py:class:`Qgis`.LabelPlacement.OrderedPositionsAroundPoint.
.. seealso:: :py:func:`setPredefinedPositionOrder`
%End
void setPredefinedPositionOrder( const QVector< Qgis::LabelPredefinedPointPosition > &order );
%Docstring
Sets the ordered list of predefined label positions for points.
Positions earlier in the list will be prioritized over later positions.
Only used when the placement is set to :py:class:`Qgis`.LabelPlacement.OrderedPositionsAroundPoint.
.. seealso:: :py:func:`predefinedPositionOrder`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelpointsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/