mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
78 lines
2.5 KiB
Plaintext
78 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.
|
|
%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 *
|
|
************************************************************************/
|