QGIS/python/core/auto_generated/labeling/qgslabelsearchtree.sip.in
Nyall Dawson 955cc8bf8c [labeling] Highlight all characters in curved labels when hovering
using a map label tool, instead of just one character
2022-03-15 15:08:22 +10:00

87 lines
2.4 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelsearchtree.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLabelSearchTree
{
%Docstring(signature="appended")
A class to query the labeling structure at a given point (small wrapper around pal RTree class)
%End
%TypeHeaderCode
#include "qgslabelsearchtree.h"
%End
public:
QgsLabelSearchTree();
%Docstring
Constructor for QgsLabelSearchTree.
%End
~QgsLabelSearchTree();
void clear() /Deprecated/;
%Docstring
Removes and deletes all the entries.
.. deprecated::
has no effect since QGIS 3.12
%End
QList< QgsLabelPosition > allLabels() const;
%Docstring
Returns a list of all labels generated by the labeling run.
.. versionadded:: 3.20
%End
QList<const QgsCalloutPosition *> calloutsInRectangle( const QgsRectangle &rectangle ) const;
%Docstring
Returns the list of callouts with origins or destinations inside the given ``rectangle``.
The ``rectangle`` is specified in map coordinates.
QgsLabelSearchTree keeps ownership, don't delete the returned objects.
.. 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:
//! QgsLabelSearchTree cannot be copied.
QgsLabelSearchTree( const QgsLabelSearchTree &rh );
//! QgsLabelSearchTree cannot be copied.
QgsLabelSearchTree &operator=( const QgsLabelSearchTree & );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelsearchtree.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/