QGIS API Documentation
2.12.0-Lyon
|
The QgsAbstractLabelProvider class is an interface class. More...
#include <qgslabelingenginev2.h>
Public Types | |
enum | Flag { DrawLabels = 1 << 1, DrawAllLabels = 1 << 2, MergeConnectedLines = 1 << 3, CentroidMustBeInside = 1 << 4, FitInPolygonOnly = 1 << 5, LabelPerFeaturePart = 1 << 6 } |
Public Member Functions | |
QgsAbstractLabelProvider () | |
Construct the provider with default values. More... | |
virtual | ~QgsAbstractLabelProvider () |
Vritual destructor. More... | |
virtual void | drawLabel (QgsRenderContext &context, pal::LabelPosition *label) const =0 |
draw this label at the position determined by the labeling engine More... | |
Flags | flags () const |
Flags associated with the provider. More... | |
virtual QList< QgsLabelFeature * > | labelFeatures (QgsRenderContext &context)=0 |
Return list of label features (they are owned by the provider and thus deleted on its destruction) More... | |
unsigned int | linePlacementFlags () const |
For layers with linestring geometries - extra placement flags (or-ed combination of QgsPalLayerSettings::LinePlacementFlags) More... | |
QString | name () const |
Name of the layer (for statistics, debugging etc.) - does not need to be unique. More... | |
QgsPalLayerSettings::ObstacleType | obstacleType () const |
How the feature geometries will work as obstacles. More... | |
QgsPalLayerSettings::Placement | placement () const |
What placement strategy to use for the labels. More... | |
double | priority () const |
Default priority of labels (may be overridden by individual labels) More... | |
void | setEngine (const QgsLabelingEngineV2 *engine) |
Associate provider with a labeling engine (should be only called internally from QgsLabelingEngineV2) More... | |
virtual QList< QgsAbstractLabelProvider * > | subProviders () |
Return list of child providers - useful if the provider needs to put labels into more layers with different configuration. More... | |
QgsPalLayerSettings::UpsideDownLabels | upsidedownLabels () const |
How to handle labels that would be upside down. More... | |
Protected Attributes | |
const QgsLabelingEngineV2 * | mEngine |
Associated labeling engine. More... | |
Flags | mFlags |
Flags altering drawing and registration of features. More... | |
unsigned int | mLinePlacementFlags |
Extra placement flags for linestring geometries. More... | |
QString | mName |
Name of the layer. More... | |
QgsPalLayerSettings::ObstacleType | mObstacleType |
Type of the obstacle of feature geometries. More... | |
QgsPalLayerSettings::Placement | mPlacement |
Placement strategy. More... | |
double | mPriority |
Default priority of labels. More... | |
QgsPalLayerSettings::UpsideDownLabels | mUpsidedownLabels |
How to handle labels that would be upside down. More... | |
The QgsAbstractLabelProvider class is an interface class.
Implementations return list of labels and their associated geometries - these are used by QgsLabelingEngineV2 to compute the final layout of labels.
Implementations also take care of drawing the returned final label positions.
Definition at line 248 of file qgslabelingenginev2.h.
Definition at line 260 of file qgslabelingenginev2.h.
QgsAbstractLabelProvider::QgsAbstractLabelProvider | ( | ) |
Construct the provider with default values.
Definition at line 381 of file qgslabelingenginev2.cpp.
|
inlinevirtual |
Vritual destructor.
Definition at line 255 of file qgslabelingenginev2.h.
|
pure virtual |
draw this label at the position determined by the labeling engine
Implemented in QgsVectorLayerDiagramProvider, QgsVectorLayerLabelProvider, and QgsDxfLabelProvider.
|
inline |
Flags associated with the provider.
Definition at line 284 of file qgslabelingenginev2.h.
|
pure virtual |
Return list of label features (they are owned by the provider and thus deleted on its destruction)
Implemented in QgsVectorLayerDiagramProvider, and QgsVectorLayerLabelProvider.
|
inline |
For layers with linestring geometries - extra placement flags (or-ed combination of QgsPalLayerSettings::LinePlacementFlags)
Definition at line 290 of file qgslabelingenginev2.h.
|
inline |
Name of the layer (for statistics, debugging etc.) - does not need to be unique.
Definition at line 281 of file qgslabelingenginev2.h.
|
inline |
How the feature geometries will work as obstacles.
Definition at line 296 of file qgslabelingenginev2.h.
|
inline |
What placement strategy to use for the labels.
Definition at line 287 of file qgslabelingenginev2.h.
|
inline |
Default priority of labels (may be overridden by individual labels)
Definition at line 293 of file qgslabelingenginev2.h.
|
inline |
Associate provider with a labeling engine (should be only called internally from QgsLabelingEngineV2)
Definition at line 258 of file qgslabelingenginev2.h.
|
inlinevirtual |
Return list of child providers - useful if the provider needs to put labels into more layers with different configuration.
Reimplemented in QgsRuleBasedLabelProvider.
Definition at line 278 of file qgslabelingenginev2.h.
|
inline |
How to handle labels that would be upside down.
Definition at line 299 of file qgslabelingenginev2.h.
|
protected |
Associated labeling engine.
Definition at line 303 of file qgslabelingenginev2.h.
|
protected |
Flags altering drawing and registration of features.
Definition at line 308 of file qgslabelingenginev2.h.
|
protected |
Extra placement flags for linestring geometries.
Definition at line 312 of file qgslabelingenginev2.h.
|
protected |
Name of the layer.
Definition at line 306 of file qgslabelingenginev2.h.
|
protected |
Type of the obstacle of feature geometries.
Definition at line 316 of file qgslabelingenginev2.h.
|
protected |
Placement strategy.
Definition at line 310 of file qgslabelingenginev2.h.
|
protected |
Default priority of labels.
Definition at line 314 of file qgslabelingenginev2.h.
|
protected |
How to handle labels that would be upside down.
Definition at line 318 of file qgslabelingenginev2.h.