mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
96 lines
3.0 KiB
Plaintext
96 lines
3.0 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/labeling/qgslabelplacementsettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsLabelPlacementSettings
|
|
{
|
|
%Docstring(signature="appended")
|
|
Contains general settings related to how labels are placed.
|
|
|
|
.. versionadded:: 3.26
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslabelplacementsettings.h"
|
|
%End
|
|
public:
|
|
|
|
Qgis::LabelOverlapHandling overlapHandling() const;
|
|
%Docstring
|
|
Returns the technique used to handle overlapping labels.
|
|
|
|
.. seealso:: :py:func:`setOverlapHandling`
|
|
%End
|
|
|
|
void setOverlapHandling( Qgis::LabelOverlapHandling handling );
|
|
%Docstring
|
|
Sets the technique used to handle overlapping labels.
|
|
|
|
.. seealso:: :py:func:`overlapHandling`
|
|
%End
|
|
|
|
bool allowDegradedPlacement() const;
|
|
%Docstring
|
|
Returns ``True`` if labels can be placed in inferior fallback positions
|
|
if they cannot otherwise be placed.
|
|
|
|
For instance, this will permit a curved line label to fallback to a
|
|
horizontal label at the end of the line if the label cannot otherwise be
|
|
placed on the line in a curved manner.
|
|
|
|
.. seealso:: :py:func:`setAllowDegradedPlacement`
|
|
%End
|
|
|
|
void setAllowDegradedPlacement( bool allow );
|
|
%Docstring
|
|
Sets whether labels can be placed in inferior fallback positions if they
|
|
cannot otherwise be placed.
|
|
|
|
For instance, this will permit a curved line label to fallback to a
|
|
horizontal label at the end of the line if the label cannot otherwise be
|
|
placed on the line in a curved manner.
|
|
|
|
.. seealso:: :py:func:`allowDegradedPlacement`
|
|
%End
|
|
|
|
Qgis::LabelPrioritization prioritization() const;
|
|
%Docstring
|
|
Returns the label prioritization technique.
|
|
|
|
.. seealso:: :py:func:`setPrioritization`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
void setPrioritization( Qgis::LabelPrioritization prioritization );
|
|
%Docstring
|
|
Sets the technique used to prioritize labels.
|
|
|
|
.. seealso:: :py:func:`prioritization`
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
|
|
%Docstring
|
|
Updates the placement settings to respect any data defined properties
|
|
set within the specified ``properties`` collection.
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/labeling/qgslabelplacementsettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|