QGIS API Documentation  2.12.0-Lyon
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
QgsPalLayerSettings Class Reference

#include <qgspallabeling.h>

Public Types

enum  DataDefinedProperties {
  Size = 0, Bold = 1, Italic = 2, Underline = 3,
  Color = 4, Strikeout = 5, Family = 6, FontStyle = 21,
  FontSizeUnit = 22, FontTransp = 18, FontCase = 27, FontLetterSpacing = 28,
  FontWordSpacing = 29, FontBlendMode = 30, MultiLineWrapChar = 31, MultiLineHeight = 32,
  MultiLineAlignment = 33, DirSymbDraw = 34, DirSymbLeft = 35, DirSymbRight = 36,
  DirSymbPlacement = 37, DirSymbReverse = 38, NumFormat = 39, NumDecimals = 40,
  NumPlusSign = 41, BufferDraw = 42, BufferSize = 7, BufferUnit = 43,
  BufferColor = 8, BufferTransp = 19, BufferJoinStyle = 44, BufferBlendMode = 45,
  ShapeDraw = 46, ShapeKind = 47, ShapeSVGFile = 48, ShapeSizeType = 49,
  ShapeSizeX = 50, ShapeSizeY = 85, ShapeSizeUnits = 51, ShapeRotationType = 52,
  ShapeRotation = 53, ShapeOffset = 54, ShapeOffsetUnits = 55, ShapeRadii = 56,
  ShapeRadiiUnits = 57, ShapeTransparency = 63, ShapeBlendMode = 64, ShapeFillColor = 58,
  ShapeBorderColor = 59, ShapeBorderWidth = 60, ShapeBorderWidthUnits = 61, ShapeJoinStyle = 62,
  ShadowDraw = 65, ShadowUnder = 66, ShadowOffsetAngle = 67, ShadowOffsetDist = 68,
  ShadowOffsetUnits = 69, ShadowRadius = 70, ShadowRadiusUnits = 71, ShadowTransparency = 72,
  ShadowScale = 73, ShadowColor = 74, ShadowBlendMode = 75, CentroidWhole = 76,
  OffsetQuad = 77, OffsetXY = 78, OffsetUnits = 80, LabelDistance = 13,
  DistanceUnits = 81, OffsetRotation = 82, CurvedCharAngleInOut = 83, PositionX = 9,
  PositionY = 10, Hali = 11, Vali = 12, Rotation = 14,
  RepeatDistance = 84, RepeatDistanceUnit = 86, Priority = 87, ScaleVisibility = 23,
  MinScale = 16, MaxScale = 17, FontLimitPixel = 24, FontMinPixel = 25,
  FontMaxPixel = 26, IsObstacle = 88, ObstacleFactor = 89, Show = 15,
  AlwaysShow = 20
}
 
enum  DirectionSymbols { SymbolLeftRight, SymbolAbove, SymbolBelow }
 
enum  LinePlacementFlags { OnLine = 1, AboveLine = 2, BelowLine = 4, MapOrientation = 8 }
 
enum  MultiLineAlign { MultiLeft = 0, MultiCenter, MultiRight, MultiFollowPlacement }
 
enum  ObstacleType { PolygonInterior, PolygonBoundary }
 Valid obstacle types, which affect how features within the layer will act as obstacles for labels. More...
 
enum  Placement {
  AroundPoint, OverPoint, Line, Curved,
  Horizontal, Free
}
 
enum  QuadrantPosition {
  QuadrantAboveLeft, QuadrantAbove, QuadrantAboveRight, QuadrantLeft,
  QuadrantOver, QuadrantRight, QuadrantBelowLeft, QuadrantBelow,
  QuadrantBelowRight
}
 
enum  RotationType { RotationSync = 0, RotationOffset, RotationFixed }
 
enum  ShadowType { ShadowLowest = 0, ShadowText, ShadowBuffer, ShadowShape }
 
enum  ShapeType {
  ShapeRectangle = 0, ShapeSquare, ShapeEllipse, ShapeCircle,
  ShapeSVG
}
 
enum  SizeType { SizeBuffer = 0, SizeFixed, SizePercent }
 
enum  SizeUnit { Points = 0, MM, MapUnits, Percent }
 Units used for option sizes, before being converted to rendered sizes. More...
 
enum  UpsideDownLabels { Upright, ShowDefined, ShowAll }
 

Public Member Functions

 QgsPalLayerSettings ()
 
 QgsPalLayerSettings (const QgsPalLayerSettings &s)
 
 ~QgsPalLayerSettings ()
 
void calculateLabelSize (const QFontMetricsF *fm, QString text, double &labelX, double &labelY, QgsFeature *f=0, QgsRenderContext *context=0)
 
bool dataDefinedEvaluate (QgsPalLayerSettings::DataDefinedProperties p, QVariant &exprVal, QgsExpressionContext *context=0, const QVariant &originalValue=QVariant()) const
 Get data defined property value from expression string or attribute field name. More...
 
bool dataDefinedIsActive (QgsPalLayerSettings::DataDefinedProperties p) const
 Whether data definition is active. More...
 
QMap< QString, QString > dataDefinedMap (QgsPalLayerSettings::DataDefinedProperties p) const
 Get property value as separate values split into Qmap. More...
 
QMap< QgsPalLayerSettings::DataDefinedProperties, QPair< QString, int > > dataDefinedNames () const
 Map of data defined enum to names and old-style indecies The QPair contains a new string for layer property key, and a reference to old-style numeric key (< QGIS 2.0) More...
 
QgsDataDefined * dataDefinedProperty (QgsPalLayerSettings::DataDefinedProperties p)
 Get a data defined property pointer. More...
 
bool dataDefinedUseExpression (QgsPalLayerSettings::DataDefinedProperties p) const
 Whether data definition is set to use an expression. More...
 
QVariant dataDefinedValue (QgsPalLayerSettings::DataDefinedProperties p, QgsFeature &f, const QgsFields &fields, const QgsExpressionContext *context=0) const
 Get data defined property value from expression string or attribute field name. More...
 
QgsExpression * getLabelExpression ()
 Returns the QgsExpression for this label settings. More...
 
QgsPalLayerSettings & operator= (const QgsPalLayerSettings &s)
 copy operator - only copies the permanent members More...
 
void readFromLayer (QgsVectorLayer *layer)
 
void readXml (QDomElement &elem)
 Read settings from a DOM element. More...
 
void registerFeature (QgsFeature &f, QgsRenderContext &context, const QString &dxfLayer, QgsLabelFeature **labelFeature=0)
 Register a feature for labelling. More...
 
void removeAllDataDefinedProperties ()
 Clear all data-defined properties. More...
 
void removeDataDefinedProperty (QgsPalLayerSettings::DataDefinedProperties p)
 Set a property to static instead data defined. More...
 
double scaleToPixelContext (double size, const QgsRenderContext &c, SizeUnit unit, bool rasterfactor=false, const QgsMapUnitScale &mapUnitScale=QgsMapUnitScale()) const
 Calculates size (considering output size should be in pixel or map units, scale factors and optionally oversampling) More...
 
void setDataDefinedProperty (QgsPalLayerSettings::DataDefinedProperties p, bool active, bool useExpr, const QString &expr, const QString &field)
 Set a property as data defined. More...
 
int sizeToPixel (double size, const QgsRenderContext &c, SizeUnit unit, bool rasterfactor=false, const QgsMapUnitScale &mapUnitScale=QgsMapUnitScale()) const
 Calculates pixel size (considering output size should be in pixel or map units, scale factors and optionally oversampling) More...
 
QString updateDataDefinedString (const QString &value)
 Convert old property value to new one as delimited values. More...
 
void writeToLayer (QgsVectorLayer *layer)
 
QDomElement writeXml (QDomDocument &doc)
 Write settings into a DOM element. More...
 

Static Public Member Functions

static QgsPalLayerSettings fromLayer (QgsVectorLayer *layer)
 

Public Attributes

bool addDirectionSymbol
 
double angleOffset
 
QPainter::CompositionMode blendMode
 
QPainter::CompositionMode bufferBlendMode
 
QColor bufferColor
 
bool bufferDraw
 
Qt::PenJoinStyle bufferJoinStyle
 
bool bufferNoFill
 
double bufferSize
 
bool bufferSizeInMapUnits
 
QgsMapUnitScale bufferSizeMapUnitScale
 
int bufferTransp
 
bool centroidInside
 
bool centroidWhole
 
const QgsCoordinateTransform * ct
 
QMap< QgsPalLayerSettings::DataDefinedProperties, QgsDataDefined * > dataDefinedProperties
 Map of current data defined properties. More...
 
int decimals
 
bool displayAll
 
double dist
 
bool distInMapUnits
 
QgsMapUnitScale distMapUnitScale
 
bool drawLabels
 Whether to draw labels for this layer. More...
 
bool enabled
 
QgsGeometry * extentGeom
 
int fieldIndex
 
QString fieldName
 
bool fitInPolygonOnly
 True if only labels which completely fit within a polygon are allowed. More...
 
bool fontLimitPixelSize
 
int fontMaxPixelSize
 
int fontMinPixelSize
 
bool fontSizeInMapUnits
 
QgsMapUnitScale fontSizeMapUnitScale
 
bool formatNumbers
 
bool isExpression
 Is this label made from a expression string eg FieldName || 'mm'. More...
 
bool labelOffsetInMapUnits
 
QgsMapUnitScale labelOffsetMapUnitScale
 
bool labelPerPart
 
QString leftDirectionSymbol
 
bool limitNumLabels
 
double maxCurvedCharAngleIn
 
double maxCurvedCharAngleOut
 
int maxNumLabels
 
QgsFeature * mCurFeat
 
QgsFields mCurFields
 
bool mergeLines
 
int mFeatsRegPal
 
int mFeatsSendingToPal
 
int mFeaturesToLabel
 
double minFeatureSize
 
QString mTextFontFamily
 
bool mTextFontFound
 
MultiLineAlign multilineAlign
 
double multilineHeight
 
bool obstacle
 
double obstacleFactor
 Obstacle factor, where 1.0 = default, < 1.0 more likely to be covered by labels,

1.0 less likely to be covered

More...
 
ObstacleType obstacleType
 Controls how features act as obstacles for labels. More...
 
DirectionSymbols placeDirectionSymbol
 
Placement placement
 
unsigned int placementFlags
 
bool plusSign
 
bool preserveRotation
 
QColor previewBkgrdColor
 
int priority
 
QgsPoint ptOne
 
QgsPoint ptZero
 
QuadrantPosition quadOffset
 
double rasterCompressFactor
 
double repeatDistance
 
QgsMapUnitScale repeatDistanceMapUnitScale
 
SizeUnit repeatDistanceUnit
 
bool reverseDirectionSymbol
 
QString rightDirectionSymbol
 
int scaleMax
 
int scaleMin
 
bool scaleVisibility
 
QPainter::CompositionMode shadowBlendMode
 
QColor shadowColor
 
bool shadowDraw
 
int shadowOffsetAngle
 
double shadowOffsetDist
 
bool shadowOffsetGlobal
 
QgsMapUnitScale shadowOffsetMapUnitScale
 
SizeUnit shadowOffsetUnits
 
double shadowRadius
 
bool shadowRadiusAlphaOnly
 
QgsMapUnitScale shadowRadiusMapUnitScale
 
SizeUnit shadowRadiusUnits
 
int shadowScale
 
int shadowTransparency
 
ShadowType shadowUnder
 
QPainter::CompositionMode shapeBlendMode
 
QColor shapeBorderColor
 
double shapeBorderWidth
 
QgsMapUnitScale shapeBorderWidthMapUnitScale
 
SizeUnit shapeBorderWidthUnits
 
bool shapeDraw
 
QColor shapeFillColor
 
Qt::PenJoinStyle shapeJoinStyle
 
QPointF shapeOffset
 
QgsMapUnitScale shapeOffsetMapUnitScale
 
SizeUnit shapeOffsetUnits
 
QPointF shapeRadii
 
QgsMapUnitScale shapeRadiiMapUnitScale
 
SizeUnit shapeRadiiUnits
 
double shapeRotation
 
RotationType shapeRotationType
 
QPointF shapeSize
 
QgsMapUnitScale shapeSizeMapUnitScale
 
SizeType shapeSizeType
 
SizeUnit shapeSizeUnits
 
QString shapeSVGFile
 
int shapeTransparency
 
ShapeType shapeType
 
bool showingShadowRects
 
QColor textColor
 
QFont textFont
 
QString textNamedStyle
 
int textTransp
 
UpsideDownLabels upsidedownLabels
 
double vectorScaleFactor
 
QString wrapChar
 
const QgsMapToPixel * xform
 
double xOffset
 
double yOffset
 

Detailed Description

Definition at line 63 of file qgspallabeling.h.

Member Enumeration Documentation

enum QgsPalLayerSettings::DataDefinedProperties
Enumerator
Size 
Bold 
Italic 
Underline 
Color 
Strikeout 
Family 
FontStyle 
FontSizeUnit 
FontTransp 
FontCase 
FontLetterSpacing 
FontWordSpacing 
FontBlendMode 
MultiLineWrapChar 
MultiLineHeight 
MultiLineAlignment 
DirSymbDraw 
DirSymbLeft 
DirSymbRight 
DirSymbPlacement 
DirSymbReverse 
NumFormat 
NumDecimals 
NumPlusSign 
BufferDraw 
BufferSize 
BufferUnit 
BufferColor 
BufferTransp 
BufferJoinStyle 
BufferBlendMode 
ShapeDraw 
ShapeKind 
ShapeSVGFile 
ShapeSizeType 
ShapeSizeX 
ShapeSizeY 
ShapeSizeUnits 
ShapeRotationType 
ShapeRotation 
ShapeOffset 
ShapeOffsetUnits 
ShapeRadii 
ShapeRadiiUnits 
ShapeTransparency 
ShapeBlendMode 
ShapeFillColor 
ShapeBorderColor 
ShapeBorderWidth 
ShapeBorderWidthUnits 
ShapeJoinStyle 
ShadowDraw 
ShadowUnder 
ShadowOffsetAngle 
ShadowOffsetDist 
ShadowOffsetUnits 
ShadowRadius 
ShadowRadiusUnits 
ShadowTransparency 
ShadowScale 
ShadowColor 
ShadowBlendMode 
CentroidWhole 
OffsetQuad 
OffsetXY 
OffsetUnits 
LabelDistance 
DistanceUnits 
OffsetRotation 
CurvedCharAngleInOut 
PositionX 
PositionY 
Hali 
Vali 
Rotation 
RepeatDistance 
RepeatDistanceUnit 
Priority 
ScaleVisibility 
MinScale 
MaxScale 
FontLimitPixel 
FontMinPixel 
FontMaxPixel 
IsObstacle 
ObstacleFactor 
Show 
AlwaysShow 

Definition at line 182 of file qgspallabeling.h.

enum QgsPalLayerSettings::DirectionSymbols
Enumerator
SymbolLeftRight 

place direction symbols on left/right of label

SymbolAbove 

place direction symbols on above label

SymbolBelow 

place direction symbols on below label

Definition at line 114 of file qgspallabeling.h.

enum QgsPalLayerSettings::LinePlacementFlags
Enumerator
OnLine 
AboveLine 
BelowLine 
MapOrientation 

Definition at line 86 of file qgspallabeling.h.

enum QgsPalLayerSettings::MultiLineAlign
Enumerator
MultiLeft 
MultiCenter 
MultiRight 
MultiFollowPlacement 

Alignment follows placement of label, eg labels to the left of a feature will be drawn with right alignment

Definition at line 121 of file qgspallabeling.h.

enum QgsPalLayerSettings::ObstacleType

Valid obstacle types, which affect how features within the layer will act as obstacles for labels.

Enumerator
PolygonInterior 

avoid placing labels over interior of polygon (prefer placing labels totally outside or just slightly inside polygon)

PolygonBoundary 

avoid placing labels over boundary of polygon (prefer placing outside or completely inside polygon)

Definition at line 133 of file qgspallabeling.h.

enum QgsPalLayerSettings::Placement
Enumerator
AroundPoint 
OverPoint 
Line 
Curved 
Horizontal 
Free 

Definition at line 76 of file qgspallabeling.h.

enum QgsPalLayerSettings::QuadrantPosition
Enumerator
QuadrantAboveLeft 
QuadrantAbove 
QuadrantAboveRight 
QuadrantLeft 
QuadrantOver 
QuadrantRight 
QuadrantBelowLeft 
QuadrantBelow 
QuadrantBelowRight 

Definition at line 94 of file qgspallabeling.h.

enum QgsPalLayerSettings::RotationType
Enumerator
RotationSync 
RotationOffset 
RotationFixed 

Definition at line 157 of file qgspallabeling.h.

enum QgsPalLayerSettings::ShadowType
Enumerator
ShadowLowest 
ShadowText 
ShadowBuffer 
ShadowShape 

Definition at line 173 of file qgspallabeling.h.

enum QgsPalLayerSettings::ShapeType
Enumerator
ShapeRectangle 
ShapeSquare 
ShapeEllipse 
ShapeCircle 
ShapeSVG 

Definition at line 141 of file qgspallabeling.h.

enum QgsPalLayerSettings::SizeType
Enumerator
SizeBuffer 
SizeFixed 
SizePercent 

Definition at line 150 of file qgspallabeling.h.

enum QgsPalLayerSettings::SizeUnit

Units used for option sizes, before being converted to rendered sizes.

Enumerator
Points 
MM 
MapUnits 
Percent 

Definition at line 165 of file qgspallabeling.h.

enum QgsPalLayerSettings::UpsideDownLabels
Enumerator
Upright 

upside-down labels (90 <= angle < 270) are shown upright

ShowDefined 

show upside down when rotation is layer- or data-defined

ShowAll 

show upside down for all labels, including dynamic ones

Definition at line 107 of file qgspallabeling.h.

Constructor & Destructor Documentation

QgsPalLayerSettings::QgsPalLayerSettings ( )

Definition at line 81 of file qgspallabeling.cpp.

QgsPalLayerSettings::QgsPalLayerSettings ( const QgsPalLayerSettings &  s)

Definition at line 323 of file qgspallabeling.cpp.

QgsPalLayerSettings::~QgsPalLayerSettings ( )

Definition at line 487 of file qgspallabeling.cpp.

Member Function Documentation

void QgsPalLayerSettings::calculateLabelSize ( const QFontMetricsF *  fm,
QString  text,
double &  labelX,
double &  labelY,
QgsFeature *  f = 0,
QgsRenderContext *  context = 0 
)

Definition at line 1722 of file qgspallabeling.cpp.

bool QgsPalLayerSettings::dataDefinedEvaluate ( QgsPalLayerSettings::DataDefinedProperties  p,
QVariant &  exprVal,
QgsExpressionContext *  context = 0,
const QVariant &  originalValue = QVariant() 
) const

Get data defined property value from expression string or attribute field name.

Returns
true/false whether result is null or invalid
Note
not available in python bindings

Definition at line 1655 of file qgspallabeling.cpp.

bool QgsPalLayerSettings::dataDefinedIsActive ( QgsPalLayerSettings::DataDefinedProperties  p) const

Whether data definition is active.

Definition at line 1686 of file qgspallabeling.cpp.

QMap< QString, QString > QgsPalLayerSettings::dataDefinedMap ( QgsPalLayerSettings::DataDefinedProperties  p) const

Get property value as separate values split into Qmap.

Note
not available in python bindings

Definition at line 1577 of file qgspallabeling.cpp.

QMap<QgsPalLayerSettings::DataDefinedProperties, QPair<QString, int> > QgsPalLayerSettings::dataDefinedNames ( ) const
inline

Map of data defined enum to names and old-style indecies The QPair contains a new string for layer property key, and a reference to old-style numeric key (< QGIS 2.0)

Note
not available in python bindings;

Definition at line 575 of file qgspallabeling.h.

QgsDataDefined * QgsPalLayerSettings::dataDefinedProperty ( QgsPalLayerSettings::DataDefinedProperties  p)

Get a data defined property pointer.

Note
helpful for Python access

Definition at line 1564 of file qgspallabeling.cpp.

bool QgsPalLayerSettings::dataDefinedUseExpression ( QgsPalLayerSettings::DataDefinedProperties  p) const

Whether data definition is set to use an expression.

Definition at line 1702 of file qgspallabeling.cpp.

QVariant QgsPalLayerSettings::dataDefinedValue ( QgsPalLayerSettings::DataDefinedProperties  p,
QgsFeature &  f,
const QgsFields &  fields,
const QgsExpressionContext *  context = 0 
) const

Get data defined property value from expression string or attribute field name.

Returns
value inside QVariant
Note
not available in python bindings

Definition at line 1588 of file qgspallabeling.cpp.

QgsPalLayerSettings QgsPalLayerSettings::fromLayer ( QgsVectorLayer *  layer)
static
Note
added in 2.4

Definition at line 500 of file qgspallabeling.cpp.

QgsExpression * QgsPalLayerSettings::getLabelExpression ( )

Returns the QgsExpression for this label settings.

Definition at line 508 of file qgspallabeling.cpp.

QgsPalLayerSettings & QgsPalLayerSettings::operator= ( const QgsPalLayerSettings &  s)

copy operator - only copies the permanent members

Definition at line 338 of file qgspallabeling.cpp.

void QgsPalLayerSettings::readFromLayer ( QgsVectorLayer *  layer)

Definition at line 755 of file qgspallabeling.cpp.

void QgsPalLayerSettings::readXml ( QDomElement &  elem)

Read settings from a DOM element.

Note
added in 2.12

Definition at line 1133 of file qgspallabeling.cpp.

void QgsPalLayerSettings::registerFeature ( QgsFeature &  f,
QgsRenderContext &  context,
const QString &  dxfLayer,
QgsLabelFeature **  labelFeature = 0 
)

Register a feature for labelling.

Parameters
ffeature to label
contextrender context. The QgsExpressionContext contained within the render context must have already had the feature and fields sets prior to calling this method.
dxfLayerdxfLayer name
labelFeatureif using QgsLabelingEngineV2, this will receive the label feature

Definition at line 1900 of file qgspallabeling.cpp.

void QgsPalLayerSettings::removeAllDataDefinedProperties ( )

Clear all data-defined properties.

Note
added in QGIS 2.12

Definition at line 1536 of file qgspallabeling.cpp.

void QgsPalLayerSettings::removeDataDefinedProperty ( QgsPalLayerSettings::DataDefinedProperties  p)

Set a property to static instead data defined.

Definition at line 1526 of file qgspallabeling.cpp.

double QgsPalLayerSettings::scaleToPixelContext ( double  size,
const QgsRenderContext &  c,
SizeUnit  unit,
bool  rasterfactor = false,
const QgsMapUnitScale &  mapUnitScale = QgsMapUnitScale() 
) const

Calculates size (considering output size should be in pixel or map units, scale factors and optionally oversampling)

Parameters
sizesize to convert
crendercontext
unitSizeUnit enum value of size
rasterfactorwhether to consider oversampling
mapUnitScalea mapUnitScale clamper
Returns
size that will render, as double

Definition at line 3578 of file qgspallabeling.cpp.

void QgsPalLayerSettings::setDataDefinedProperty ( QgsPalLayerSettings::DataDefinedProperties  p,
bool  active,
bool  useExpr,
const QString &  expr,
const QString &  field 
)

Set a property as data defined.

Note
helpful for Python access

Definition at line 1502 of file qgspallabeling.cpp.

int QgsPalLayerSettings::sizeToPixel ( double  size,
const QgsRenderContext &  c,
SizeUnit  unit,
bool  rasterfactor = false,
const QgsMapUnitScale &  mapUnitScale = QgsMapUnitScale() 
) const

Calculates pixel size (considering output size should be in pixel or map units, scale factors and optionally oversampling)

Parameters
sizesize to convert
crendercontext
unitSizeUnit enum value of size
rasterfactorwhether to consider oversampling
mapUnitScalea mapUnitScale clamper
Returns
font pixel size

Definition at line 3573 of file qgspallabeling.cpp.

QString QgsPalLayerSettings::updateDataDefinedString ( const QString &  value)

Convert old property value to new one as delimited values.

Note
not available in python bindings; as temporary solution until refactoring of project settings

Definition at line 1547 of file qgspallabeling.cpp.

void QgsPalLayerSettings::writeToLayer ( QgsVectorLayer *  layer)

Definition at line 978 of file qgspallabeling.cpp.

QDomElement QgsPalLayerSettings::writeXml ( QDomDocument &  doc)

Write settings into a DOM element.

Note
added in 2.12

Definition at line 1334 of file qgspallabeling.cpp.

Member Data Documentation

bool QgsPalLayerSettings::addDirectionSymbol

Definition at line 333 of file qgspallabeling.h.

double QgsPalLayerSettings::angleOffset

Definition at line 426 of file qgspallabeling.h.

QPainter::CompositionMode QgsPalLayerSettings::blendMode

Definition at line 321 of file qgspallabeling.h.

QPainter::CompositionMode QgsPalLayerSettings::bufferBlendMode

Definition at line 353 of file qgspallabeling.h.

QColor QgsPalLayerSettings::bufferColor

Definition at line 349 of file qgspallabeling.h.

bool QgsPalLayerSettings::bufferDraw

Definition at line 345 of file qgspallabeling.h.

Qt::PenJoinStyle QgsPalLayerSettings::bufferJoinStyle

Definition at line 352 of file qgspallabeling.h.

bool QgsPalLayerSettings::bufferNoFill

Definition at line 350 of file qgspallabeling.h.

double QgsPalLayerSettings::bufferSize

Definition at line 346 of file qgspallabeling.h.

bool QgsPalLayerSettings::bufferSizeInMapUnits

Definition at line 347 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::bufferSizeMapUnitScale

Definition at line 348 of file qgspallabeling.h.

int QgsPalLayerSettings::bufferTransp

Definition at line 351 of file qgspallabeling.h.

bool QgsPalLayerSettings::centroidInside

Definition at line 405 of file qgspallabeling.h.

bool QgsPalLayerSettings::centroidWhole

Definition at line 404 of file qgspallabeling.h.

const QgsCoordinateTransform* QgsPalLayerSettings::ct

Definition at line 582 of file qgspallabeling.h.

QMap< QgsPalLayerSettings::DataDefinedProperties, QgsDataDefined* > QgsPalLayerSettings::dataDefinedProperties

Map of current data defined properties.

Pointers to QgsDataDefined should never be null, the pointers are owned by this class

Definition at line 548 of file qgspallabeling.h.

int QgsPalLayerSettings::decimals

Definition at line 340 of file qgspallabeling.h.

bool QgsPalLayerSettings::displayAll

Definition at line 444 of file qgspallabeling.h.

double QgsPalLayerSettings::dist

Definition at line 410 of file qgspallabeling.h.

bool QgsPalLayerSettings::distInMapUnits

Definition at line 411 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::distMapUnitScale

Definition at line 412 of file qgspallabeling.h.

bool QgsPalLayerSettings::drawLabels

Whether to draw labels for this layer.

For some layers it may be desirable to register their features as obstacles for other labels without requiring labels to be drawn for the layer itself. In this case drawLabels can be set to false and obstacle set to true, which will result in the layer acting as an obstacle but having no labels of its own.

Note
added in QGIS 2.12

Definition at line 301 of file qgspallabeling.h.

bool QgsPalLayerSettings::enabled

Definition at line 292 of file qgspallabeling.h.

QgsGeometry* QgsPalLayerSettings::extentGeom

Definition at line 584 of file qgspallabeling.h.

int QgsPalLayerSettings::fieldIndex

Definition at line 580 of file qgspallabeling.h.

QString QgsPalLayerSettings::fieldName

Definition at line 305 of file qgspallabeling.h.

bool QgsPalLayerSettings::fitInPolygonOnly

True if only labels which completely fit within a polygon are allowed.

Definition at line 409 of file qgspallabeling.h.

bool QgsPalLayerSettings::fontLimitPixelSize

Definition at line 440 of file qgspallabeling.h.

int QgsPalLayerSettings::fontMaxPixelSize

Definition at line 442 of file qgspallabeling.h.

int QgsPalLayerSettings::fontMinPixelSize

Definition at line 441 of file qgspallabeling.h.

bool QgsPalLayerSettings::fontSizeInMapUnits

Definition at line 317 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::fontSizeMapUnitScale

Definition at line 318 of file qgspallabeling.h.

bool QgsPalLayerSettings::formatNumbers

Definition at line 339 of file qgspallabeling.h.

bool QgsPalLayerSettings::isExpression

Is this label made from a expression string eg FieldName || 'mm'.

Definition at line 309 of file qgspallabeling.h.

bool QgsPalLayerSettings::labelOffsetInMapUnits

Definition at line 424 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::labelOffsetMapUnitScale

Definition at line 425 of file qgspallabeling.h.

bool QgsPalLayerSettings::labelPerPart

Definition at line 447 of file qgspallabeling.h.

QString QgsPalLayerSettings::leftDirectionSymbol

Definition at line 334 of file qgspallabeling.h.

bool QgsPalLayerSettings::limitNumLabels

Definition at line 450 of file qgspallabeling.h.

double QgsPalLayerSettings::maxCurvedCharAngleIn

Definition at line 429 of file qgspallabeling.h.

double QgsPalLayerSettings::maxCurvedCharAngleOut

Definition at line 430 of file qgspallabeling.h.

int QgsPalLayerSettings::maxNumLabels

Definition at line 451 of file qgspallabeling.h.

QgsFeature* QgsPalLayerSettings::mCurFeat

Definition at line 578 of file qgspallabeling.h.

QgsFields QgsPalLayerSettings::mCurFields

Definition at line 579 of file qgspallabeling.h.

bool QgsPalLayerSettings::mergeLines

Definition at line 448 of file qgspallabeling.h.

int QgsPalLayerSettings::mFeatsRegPal

Definition at line 587 of file qgspallabeling.h.

int QgsPalLayerSettings::mFeatsSendingToPal

Definition at line 586 of file qgspallabeling.h.

int QgsPalLayerSettings::mFeaturesToLabel

Definition at line 585 of file qgspallabeling.h.

double QgsPalLayerSettings::minFeatureSize

Definition at line 453 of file qgspallabeling.h.

QString QgsPalLayerSettings::mTextFontFamily

Definition at line 589 of file qgspallabeling.h.

bool QgsPalLayerSettings::mTextFontFound

Definition at line 590 of file qgspallabeling.h.

MultiLineAlign QgsPalLayerSettings::multilineAlign

Definition at line 328 of file qgspallabeling.h.

double QgsPalLayerSettings::multilineHeight

Definition at line 327 of file qgspallabeling.h.

bool QgsPalLayerSettings::obstacle

Definition at line 454 of file qgspallabeling.h.

double QgsPalLayerSettings::obstacleFactor

Obstacle factor, where 1.0 = default, < 1.0 more likely to be covered by labels,

1.0 less likely to be covered

Definition at line 459 of file qgspallabeling.h.

ObstacleType QgsPalLayerSettings::obstacleType

Controls how features act as obstacles for labels.

Definition at line 463 of file qgspallabeling.h.

DirectionSymbols QgsPalLayerSettings::placeDirectionSymbol

Definition at line 336 of file qgspallabeling.h.

Placement QgsPalLayerSettings::placement

Definition at line 401 of file qgspallabeling.h.

unsigned int QgsPalLayerSettings::placementFlags

Definition at line 402 of file qgspallabeling.h.

bool QgsPalLayerSettings::plusSign

Definition at line 341 of file qgspallabeling.h.

bool QgsPalLayerSettings::preserveRotation

Definition at line 427 of file qgspallabeling.h.

QColor QgsPalLayerSettings::previewBkgrdColor

Definition at line 322 of file qgspallabeling.h.

int QgsPalLayerSettings::priority

Definition at line 432 of file qgspallabeling.h.

QgsPoint QgsPalLayerSettings::ptOne

Definition at line 583 of file qgspallabeling.h.

QgsPoint QgsPalLayerSettings::ptZero

Definition at line 583 of file qgspallabeling.h.

QuadrantPosition QgsPalLayerSettings::quadOffset

Definition at line 420 of file qgspallabeling.h.

double QgsPalLayerSettings::rasterCompressFactor

Definition at line 467 of file qgspallabeling.h.

double QgsPalLayerSettings::repeatDistance

Definition at line 414 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::repeatDistanceMapUnitScale

Definition at line 416 of file qgspallabeling.h.

SizeUnit QgsPalLayerSettings::repeatDistanceUnit

Definition at line 415 of file qgspallabeling.h.

bool QgsPalLayerSettings::reverseDirectionSymbol

Definition at line 337 of file qgspallabeling.h.

QString QgsPalLayerSettings::rightDirectionSymbol

Definition at line 335 of file qgspallabeling.h.

int QgsPalLayerSettings::scaleMax

Definition at line 438 of file qgspallabeling.h.

int QgsPalLayerSettings::scaleMin

Definition at line 437 of file qgspallabeling.h.

bool QgsPalLayerSettings::scaleVisibility

Definition at line 436 of file qgspallabeling.h.

QPainter::CompositionMode QgsPalLayerSettings::shadowBlendMode

Definition at line 397 of file qgspallabeling.h.

QColor QgsPalLayerSettings::shadowColor

Definition at line 396 of file qgspallabeling.h.

bool QgsPalLayerSettings::shadowDraw

Definition at line 383 of file qgspallabeling.h.

int QgsPalLayerSettings::shadowOffsetAngle

Definition at line 385 of file qgspallabeling.h.

double QgsPalLayerSettings::shadowOffsetDist

Definition at line 386 of file qgspallabeling.h.

bool QgsPalLayerSettings::shadowOffsetGlobal

Definition at line 389 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::shadowOffsetMapUnitScale

Definition at line 388 of file qgspallabeling.h.

SizeUnit QgsPalLayerSettings::shadowOffsetUnits

Definition at line 387 of file qgspallabeling.h.

double QgsPalLayerSettings::shadowRadius

Definition at line 390 of file qgspallabeling.h.

bool QgsPalLayerSettings::shadowRadiusAlphaOnly

Definition at line 393 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::shadowRadiusMapUnitScale

Definition at line 392 of file qgspallabeling.h.

SizeUnit QgsPalLayerSettings::shadowRadiusUnits

Definition at line 391 of file qgspallabeling.h.

int QgsPalLayerSettings::shadowScale

Definition at line 395 of file qgspallabeling.h.

int QgsPalLayerSettings::shadowTransparency

Definition at line 394 of file qgspallabeling.h.

ShadowType QgsPalLayerSettings::shadowUnder

Definition at line 384 of file qgspallabeling.h.

QPainter::CompositionMode QgsPalLayerSettings::shapeBlendMode

Definition at line 373 of file qgspallabeling.h.

QColor QgsPalLayerSettings::shapeBorderColor

Definition at line 375 of file qgspallabeling.h.

double QgsPalLayerSettings::shapeBorderWidth

Definition at line 376 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::shapeBorderWidthMapUnitScale

Definition at line 378 of file qgspallabeling.h.

SizeUnit QgsPalLayerSettings::shapeBorderWidthUnits

Definition at line 377 of file qgspallabeling.h.

bool QgsPalLayerSettings::shapeDraw

Definition at line 357 of file qgspallabeling.h.

QColor QgsPalLayerSettings::shapeFillColor

Definition at line 374 of file qgspallabeling.h.

Qt::PenJoinStyle QgsPalLayerSettings::shapeJoinStyle

Definition at line 379 of file qgspallabeling.h.

QPointF QgsPalLayerSettings::shapeOffset

Definition at line 366 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::shapeOffsetMapUnitScale

Definition at line 368 of file qgspallabeling.h.

SizeUnit QgsPalLayerSettings::shapeOffsetUnits

Definition at line 367 of file qgspallabeling.h.

QPointF QgsPalLayerSettings::shapeRadii

Definition at line 369 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::shapeRadiiMapUnitScale

Definition at line 371 of file qgspallabeling.h.

SizeUnit QgsPalLayerSettings::shapeRadiiUnits

Definition at line 370 of file qgspallabeling.h.

double QgsPalLayerSettings::shapeRotation

Definition at line 365 of file qgspallabeling.h.

RotationType QgsPalLayerSettings::shapeRotationType

Definition at line 364 of file qgspallabeling.h.

QPointF QgsPalLayerSettings::shapeSize

Definition at line 361 of file qgspallabeling.h.

QgsMapUnitScale QgsPalLayerSettings::shapeSizeMapUnitScale

Definition at line 363 of file qgspallabeling.h.

SizeType QgsPalLayerSettings::shapeSizeType

Definition at line 360 of file qgspallabeling.h.

SizeUnit QgsPalLayerSettings::shapeSizeUnits

Definition at line 362 of file qgspallabeling.h.

QString QgsPalLayerSettings::shapeSVGFile

Definition at line 359 of file qgspallabeling.h.

int QgsPalLayerSettings::shapeTransparency

Definition at line 372 of file qgspallabeling.h.

ShapeType QgsPalLayerSettings::shapeType

Definition at line 358 of file qgspallabeling.h.

bool QgsPalLayerSettings::showingShadowRects

Definition at line 592 of file qgspallabeling.h.

QColor QgsPalLayerSettings::textColor

Definition at line 319 of file qgspallabeling.h.

QFont QgsPalLayerSettings::textFont

Definition at line 315 of file qgspallabeling.h.

QString QgsPalLayerSettings::textNamedStyle

Definition at line 316 of file qgspallabeling.h.

int QgsPalLayerSettings::textTransp

Definition at line 320 of file qgspallabeling.h.

UpsideDownLabels QgsPalLayerSettings::upsidedownLabels

Definition at line 445 of file qgspallabeling.h.

double QgsPalLayerSettings::vectorScaleFactor

Definition at line 466 of file qgspallabeling.h.

QString QgsPalLayerSettings::wrapChar

Definition at line 326 of file qgspallabeling.h.

const QgsMapToPixel* QgsPalLayerSettings::xform

Definition at line 581 of file qgspallabeling.h.

double QgsPalLayerSettings::xOffset

Definition at line 422 of file qgspallabeling.h.

double QgsPalLayerSettings::yOffset

Definition at line 423 of file qgspallabeling.h.

The documentation for this class was generated from the following files:
Generated on Sat Oct 24 2015 04:11:32 for QGIS API Documentation by   doxygen 1.8.9.1