Implements a derived label provider internally used for DXF export. More...
#include <qgsdxfpallabeling.h>
Inheritance diagram for QgsDxfLabelProvider:
Public Member Functions | |
| QgsDxfLabelProvider (QgsVectorLayer *layer, const QString &providerId, QgsDxfExport *dxf, const QgsPalLayerSettings *settings) | |
| construct the provider More... | |
| void | drawLabel (QgsRenderContext &context, pal::LabelPosition *label) const override |
| Re-implementation that writes to DXF file instead of drawing with QPainter. More... | |
| void | registerDxfFeature (const QgsFeature &feature, QgsRenderContext &context, const QString &dxfLayerName) |
| Registration method that keeps track of DXF layer names of individual features. More... | |
 Public Member Functions inherited from QgsVectorLayerLabelProvider | |
| QgsVectorLayerLabelProvider (QgsVectorLayer *layer, const QString &providerId, bool withFeatureLoop, const QgsPalLayerSettings *settings, const QString &layerName=QString()) | |
| Convenience constructor to initialize the provider from given vector layer. More... | |
| ~QgsVectorLayerLabelProvider () override | |
| QList< QgsLabelFeature * > | labelFeatures (QgsRenderContext &context) override |
| Returns list of label features (they are owned by the provider and thus deleted on its destruction) More... | |
| virtual bool | prepare (const QgsRenderContext &context, QSet< QString > &attributeNames) |
| Prepare for registration of features. More... | |
| virtual void | registerFeature (const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry=QgsGeometry()) |
| Register a feature for labeling as one or more QgsLabelFeature objects stored into mLabels. More... | |
| Public Member Functions inherited from QgsAbstractLabelProvider | |
| QgsAbstractLabelProvider (QgsMapLayer *layer, const QString &providerId=QString()) | |
| Construct the provider with default values. More... | |
| virtual | ~QgsAbstractLabelProvider ()=default |
| Flags | flags () const |
| Flags associated with the provider. More... | |
| QgsMapLayer * | layer () const |
| Returns the associated layer, or nullptr if no layer is associated with the provider. More... | |
| QString | layerId () const |
| Returns ID of associated layer, or empty string if no layer is associated with the provider. 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... | |
| QString | providerId () const |
| Returns provider ID - useful in case there is more than one label provider within a layer (e.g. More... | |
| void | setEngine (const QgsLabelingEngine *engine) |
| Associate provider with a labeling engine (should be only called internally from QgsLabelingEngine) More... | |
| virtual QList< QgsAbstractLabelProvider * > | subProviders () |
| Returns 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 | |
| QgsDxfExport * | mDxfExport = nullptr |
| pointer to parent DXF export where this instance is used More... | |
| Protected Attributes inherited from QgsVectorLayerLabelProvider | |
| QgsCoordinateReferenceSystem | mCrs |
| Layer's CRS. More... | |
| QgsFields | mFields |
| Layer's fields. More... | |
| QList< QgsLabelFeature * > | mLabels |
| List of generated. More... | |
| QgsWkbTypes::GeometryType | mLayerGeometryType |
| Geometry type of layer. More... | |
| bool | mOwnsSource |
| Whether layer's feature source is owned. More... | |
| QgsFeatureRenderer * | mRenderer = nullptr |
| QgsPalLayerSettings | mSettings |
| Layer's labeling configuration. More... | |
| QgsAbstractFeatureSource * | mSource = nullptr |
| Layer's feature source. More... | |
| Protected Attributes inherited from QgsAbstractLabelProvider | |
| const QgsLabelingEngine * | mEngine = nullptr |
| Associated labeling engine. More... | |
| Flags | mFlags |
| Flags altering drawing and registration of features. More... | |
| QgsWeakMapLayerPointer | mLayer |
| Weak pointer to source layer. More... | |
| QString | mLayerId |
| Associated layer's ID, if applicable. 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... | |
| QString | mProviderId |
| Associated provider ID (one layer may have multiple providers, e.g. in rule-based labeling) More... | |
| QgsPalLayerSettings::UpsideDownLabels | mUpsidedownLabels |
| How to handle labels that would be upside down. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsAbstractLabelProvider | |
| enum | Flag { DrawLabels = 1 << 1, DrawAllLabels = 1 << 2, MergeConnectedLines = 1 << 3, CentroidMustBeInside = 1 << 4, LabelPerFeaturePart = 1 << 6 } |
| Static Public Member Functions inherited from QgsVectorLayerLabelProvider | |
| static QgsGeometry | getPointObstacleGeometry (QgsFeature &fet, QgsRenderContext &context, const QgsSymbolList &symbols) |
| Returns the geometry for a point feature which should be used as an obstacle for labels. More... | |
| Protected Member Functions inherited from QgsVectorLayerLabelProvider | |
| void | drawLabelPrivate (pal::LabelPosition *label, QgsRenderContext &context, QgsPalLayerSettings &tmpLyr, QgsTextRenderer::TextPart drawType, double dpiRatio=1.0) const |
| Internal label drawing method. More... | |
| void | init () |
| initialization method - called from constructors More... | |
Detailed Description
Implements a derived label provider internally used for DXF export.
Internal class, not in public API. Added in QGIS 2.12
- Note
- not available in Python bindings
Definition at line 38 of file qgsdxfpallabeling.h.
Constructor & Destructor Documentation
◆ QgsDxfLabelProvider()
|
explicit |
construct the provider
Definition at line 25 of file qgsdxfpallabeling.cpp.
Member Function Documentation
◆ drawLabel()
|
overridevirtual |
Re-implementation that writes to DXF file instead of drawing with QPainter.
- Parameters
-
context render context label label
Reimplemented from QgsVectorLayerLabelProvider.
Definition at line 31 of file qgsdxfpallabeling.cpp.
◆ registerDxfFeature()
| void QgsDxfLabelProvider::registerDxfFeature | ( | const QgsFeature & | feature, |
| QgsRenderContext & | context, | ||
| const QString & | dxfLayerName | ||
| ) |
Registration method that keeps track of DXF layer names of individual features.
- Parameters
-
feature feature context render context dxfLayerName name of dxf layer
Definition at line 37 of file qgsdxfpallabeling.cpp.
Member Data Documentation
◆ mDxfExport
|
protected |
pointer to parent DXF export where this instance is used
Definition at line 61 of file qgsdxfpallabeling.h.
The documentation for this class was generated from the following files:
- /tmp/buildd/qgis-3.6.0+99unstable/src/core/dxf/qgsdxfpallabeling.h
- /tmp/buildd/qgis-3.6.0+99unstable/src/core/dxf/qgsdxfpallabeling.cpp
