QGIS/python/core/auto_generated/labeling/qgslabelingresults.sip.in
Denis Rouzaud 5bccd556e2
move QgsTolerance::UnitType to Qgis::MapUnitType (#53347)
* move QgsTolerance::UnitType to Qgis::MapUnitType

* missing forward declaration

* forward declaration

* use MapToolUnit

* forward declaration

* sipify

* fix tests

* Apply suggestions from code review

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

* forward declaration

* forward declaration

* forward declaration

* sipify

* fix missing parenthesis

---------

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>
2023-06-06 18:33:50 +02:00

80 lines
2.5 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelingresults.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLabelingResults
{
%Docstring(signature="appended")
Class that stores computed placement from labeling engine.
.. versionadded:: 2.4
%End
%TypeHeaderCode
#include "qgslabelingresults.h"
%End
public:
QgsLabelingResults();
~QgsLabelingResults();
QList< QgsLabelPosition > allLabels() const;
%Docstring
Returns a list of all labels generated by the labeling run.
.. versionadded:: 3.20
%End
QList<QgsLabelPosition> labelsAtPosition( const QgsPointXY &p ) const;
%Docstring
Returns the details of any labels placed at the specified point (in map coordinates).
%End
QList<QgsLabelPosition> labelsWithinRect( const QgsRectangle &r ) const;
%Docstring
Returns the details of any labels placed within the specified rectangle (in map coordinates).
%End
QList<QgsLabelPosition> groupedLabelPositions( long long groupId ) const;
%Docstring
Returns a list of all label positions sharing the same group ID (i.e. positions for individual characters in a curved label).
.. versionadded:: 3.26
%End
QList<QgsCalloutPosition> calloutsWithinRectangle( const QgsRectangle &rectangle ) const;
%Docstring
Returns a list of callouts with origins or destinations inside the given ``rectangle``.
The ``rectangle`` is specified in map coordinates.
.. versionadded:: 3.20
%End
void setMapSettings( const QgsMapSettings &settings );
%Docstring
Sets the map ``settings`` associated with the labeling run.
.. versionadded:: 3.4.8
%End
private:
QgsLabelingResults( const QgsLabelingResults & );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelingresults.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/