QGIS API Documentation  2.99.0-Master (9ed189e)
Public Member Functions | List of all members
QgsLabelSearchTree Class Reference

A class to query the labeling structure at a given point (small wraper around pal RTree class) More...

#include <qgslabelsearchtree.h>

Public Member Functions

 QgsLabelSearchTree ()
 
 QgsLabelSearchTree (const QgsLabelSearchTree &rh)=delete
 QgsLabelSearchTree cannot be copied. More...
 
 ~QgsLabelSearchTree ()
 
void clear ()
 Removes and deletes all the entries. More...
 
bool insertLabel (pal::LabelPosition *labelPos, int featureId, const QString &layerName, const QString &labeltext, const QFont &labelfont, bool diagram=false, bool pinned=false, const QString &providerId=QString())
 Inserts label position. More...
 
void label (const QgsPoint &p, QList< QgsLabelPosition *> &posList) const
 Returns label position(s) at a given point. More...
 
void labelsInRect (const QgsRectangle &r, QList< QgsLabelPosition *> &posList) const
 Returns label position(s) in given rectangle. More...
 
QgsLabelSearchTreeoperator= (const QgsLabelSearchTree &rh)=delete
 QgsLabelSearchTree cannot be copied. More...
 

Detailed Description

A class to query the labeling structure at a given point (small wraper around pal RTree class)

Definition at line 34 of file qgslabelsearchtree.h.

Constructor & Destructor Documentation

◆ QgsLabelSearchTree() [1/2]

QgsLabelSearchTree::QgsLabelSearchTree ( )

Definition at line 25 of file qgslabelsearchtree.cpp.

◆ ~QgsLabelSearchTree()

QgsLabelSearchTree::~QgsLabelSearchTree ( )

Definition at line 29 of file qgslabelsearchtree.cpp.

◆ QgsLabelSearchTree() [2/2]

QgsLabelSearchTree::QgsLabelSearchTree ( const QgsLabelSearchTree rh)
delete

QgsLabelSearchTree cannot be copied.

Member Function Documentation

◆ clear()

void QgsLabelSearchTree::clear ( )

Removes and deletes all the entries.

Definition at line 102 of file qgslabelsearchtree.cpp.

◆ insertLabel()

bool QgsLabelSearchTree::insertLabel ( pal::LabelPosition labelPos,
int  featureId,
const QString &  layerName,
const QString &  labeltext,
const QFont &  labelfont,
bool  diagram = false,
bool  pinned = false,
const QString &  providerId = QString() 
)

Inserts label position.

Does not take ownership of labelPos

Returns
true in case of success
Note
not available in python bindings

Definition at line 78 of file qgslabelsearchtree.cpp.

◆ label()

void QgsLabelSearchTree::label ( const QgsPoint p,
QList< QgsLabelPosition *> &  posList 
) const

Returns label position(s) at a given point.

QgsLabelSearchTree keeps ownership, don't delete the LabelPositions

Note
not available in python bindings TODO: why does this break bindings with QList<QgsLabelPosition>?

Definition at line 34 of file qgslabelsearchtree.cpp.

◆ labelsInRect()

void QgsLabelSearchTree::labelsInRect ( const QgsRectangle r,
QList< QgsLabelPosition *> &  posList 
) const

Returns label position(s) in given rectangle.

QgsLabelSearchTree keeps ownership, don't delete the LabelPositions

Note
not available in python bindings TODO: why does this break bindings with QList<QgsLabelPosition>?

Definition at line 58 of file qgslabelsearchtree.cpp.

◆ operator=()

QgsLabelSearchTree& QgsLabelSearchTree::operator= ( const QgsLabelSearchTree rh)
delete

QgsLabelSearchTree cannot be copied.


The documentation for this class was generated from the following files: