QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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 ()
 
void clear ()
 Removes and deletes all the entries. 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...
 
bool insertLabel (LabelPosition *labelPos, int featureId, const QString &layerName, const QString &labeltext, const QFont &labelfont, bool diagram=false, bool pinned=false)
 Inserts label position. More...
 

Detailed Description

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

Constructor & Destructor Documentation

QgsLabelSearchTree::QgsLabelSearchTree ( )
QgsLabelSearchTree::~QgsLabelSearchTree ( )

Member Function Documentation

void QgsLabelSearchTree::clear ( )

Removes and deletes all the entries.

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

Inserts label position.

Does not take ownership of labelPos

Returns
true in case of success
Note
not available in python bindings
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>?
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>?

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