Quantum GIS API Documentation  1.7.5-Wroclaw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | Private Member Functions | List of all members
QgsPalLayerSettings Class Reference

#include <qgspallabeling.h>

Collaboration diagram for QgsPalLayerSettings:
Collaboration graph
[legend]

Public Types

enum  Placement {
  AroundPoint, OverPoint, Line, Curved,
  Horizontal, Free
}
 
enum  LinePlacementFlags { OnLine = 1, AboveLine = 2, BelowLine = 4, MapOrientation = 8 }
 
enum  DataDefinedProperties {
  Size = 0, Bold, Italic, Underline,
  Color, Strikeout, Family, BufferSize,
  BufferColor, PositionX, PositionY, Hali,
  Vali, LabelDistance, Rotation
}
 

Public Member Functions

 QgsPalLayerSettings ()
 
 QgsPalLayerSettings (const QgsPalLayerSettings &s)
 
 ~QgsPalLayerSettings ()
 
void calculateLabelSize (const QFontMetricsF *fm, QString text, double &labelX, double &labelY)
 
void registerFeature (QgsFeature &f, const QgsRenderContext &context)
 
void readFromLayer (QgsVectorLayer *layer)
 
void writeToLayer (QgsVectorLayer *layer)
 
void setDataDefinedProperty (DataDefinedProperties p, int attributeIndex)
 Set a property as data defined. More...
 
void removeDataDefinedProperty (DataDefinedProperties p)
 Set a property to static instead data defined. More...
 
int sizeToPixel (double size, const QgsRenderContext &c) const
 Calculates pixel size (considering output size should be in pixel or map units, scale factors and oversampling) More...
 

Public Attributes

QString fieldName
 
Placement placement
 
unsigned int placementFlags
 
QFont textFont
 
QColor textColor
 
bool enabled
 
int priority
 
bool obstacle
 
double dist
 
double vectorScaleFactor
 
double rasterCompressFactor
 
int scaleMin
 
int scaleMax
 
double bufferSize
 
QColor bufferColor
 
bool labelPerPart
 
bool mergeLines
 
bool multiLineLabels
 
double minFeatureSize
 
bool addDirectionSymbol
 
bool fontSizeInMapUnits
 
bool distInMapUnits
 
pal::Layer * palLayer
 
int fieldIndex
 
QFontMetricsF * fontMetrics
 
const QgsMapToPixelxform
 
const QgsCoordinateTransformct
 
QgsPoint ptZero
 
QgsPoint ptOne
 
QList< QgsPalGeometry * > geometries
 
QMap< DataDefinedProperties, int > dataDefinedProperties
 Stores field indices for data defined layer properties. More...
 

Private Member Functions

bool checkMinimumSizeMM (const QgsRenderContext &ct, QgsGeometry *geom, double minSize) const
 Checks if a feature is larger than a minimum size (in mm) More...
 

Detailed Description

Definition at line 56 of file qgspallabeling.h.

Member Enumeration Documentation

Enumerator
Size 
Bold 
Italic 
Underline 
Color 
Strikeout 
Family 
BufferSize 
BufferColor 
PositionX 
PositionY 
Hali 
Vali 
LabelDistance 
Rotation 

Definition at line 81 of file qgspallabeling.h.

Enumerator
OnLine 
AboveLine 
BelowLine 
MapOrientation 

Definition at line 73 of file qgspallabeling.h.

Enumerator
AroundPoint 
OverPoint 
Line 
Curved 
Horizontal 
Free 

Definition at line 63 of file qgspallabeling.h.

Constructor & Destructor Documentation

QgsPalLayerSettings::QgsPalLayerSettings ( )
QgsPalLayerSettings::QgsPalLayerSettings ( const QgsPalLayerSettings s)
QgsPalLayerSettings::~QgsPalLayerSettings ( )

Definition at line 184 of file qgspallabeling.cpp.

References ct, and fontMetrics.

Member Function Documentation

void QgsPalLayerSettings::calculateLabelSize ( const QFontMetricsF *  fm,
QString  text,
double &  labelX,
double &  labelY 
)
bool QgsPalLayerSettings::checkMinimumSizeMM ( const QgsRenderContext ct,
QgsGeometry geom,
double  minSize 
) const
private

Checks if a feature is larger than a minimum size (in mm)

Returns
true if above size, false if below

Definition at line 351 of file qgspallabeling.cpp.

References QgsGeometry::area(), QgsGeometry::length(), QGis::Line, QgsRenderContext::mapToPixel(), QgsMapToPixel::mapUnitsPerPixel(), QGis::Point, QGis::Polygon, QgsRenderContext::scaleFactor(), and QgsGeometry::type().

Referenced by registerFeature().

void QgsPalLayerSettings::readFromLayer ( QgsVectorLayer layer)
void QgsPalLayerSettings::registerFeature ( QgsFeature f,
const QgsRenderContext context 
)
void QgsPalLayerSettings::removeDataDefinedProperty ( DataDefinedProperties  p)

Set a property to static instead data defined.

Definition at line 346 of file qgspallabeling.cpp.

References dataDefinedProperties.

void QgsPalLayerSettings::setDataDefinedProperty ( DataDefinedProperties  p,
int  attributeIndex 
)

Set a property as data defined.

Definition at line 341 of file qgspallabeling.cpp.

References dataDefinedProperties.

int QgsPalLayerSettings::sizeToPixel ( double  size,
const QgsRenderContext c 
) const

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

Parameters
sizesize to convert
crendercontext
Returns
font pixel size

Definition at line 618 of file qgspallabeling.cpp.

References fontSizeInMapUnits, QgsRenderContext::mapToPixel(), QgsMapToPixel::mapUnitsPerPixel(), QgsRenderContext::rasterScaleFactor(), and QgsRenderContext::scaleFactor().

Referenced by QgsPalLabeling::drawLabeling(), QgsPalLabeling::prepareLayer(), and registerFeature().

void QgsPalLayerSettings::writeToLayer ( QgsVectorLayer layer)

Member Data Documentation

bool QgsPalLayerSettings::addDirectionSymbol
QColor QgsPalLayerSettings::bufferColor
double QgsPalLayerSettings::bufferSize
const QgsCoordinateTransform* QgsPalLayerSettings::ct
QMap< DataDefinedProperties, int > QgsPalLayerSettings::dataDefinedProperties

Stores field indices for data defined layer properties.

Definition at line 148 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), QgsPalLayerSettings(), readFromLayer(), registerFeature(), removeDataDefinedProperty(), setDataDefinedProperty(), and writeToLayer().

double QgsPalLayerSettings::dist
bool QgsPalLayerSettings::distInMapUnits
bool QgsPalLayerSettings::enabled
int QgsPalLayerSettings::fieldIndex

Definition at line 140 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), and registerFeature().

QString QgsPalLayerSettings::fieldName
QFontMetricsF* QgsPalLayerSettings::fontMetrics
bool QgsPalLayerSettings::fontSizeInMapUnits

Definition at line 121 of file qgspallabeling.h.

Referenced by QgsPalLayerSettings(), readFromLayer(), sizeToPixel(), and writeToLayer().

QList<QgsPalGeometry*> QgsPalLayerSettings::geometries

Definition at line 145 of file qgspallabeling.h.

Referenced by QgsPalLabeling::drawLabeling(), and registerFeature().

bool QgsPalLayerSettings::labelPerPart
bool QgsPalLayerSettings::mergeLines
double QgsPalLayerSettings::minFeatureSize
bool QgsPalLayerSettings::multiLineLabels
bool QgsPalLayerSettings::obstacle
pal::Layer* QgsPalLayerSettings::palLayer

Definition at line 139 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), and registerFeature().

Placement QgsPalLayerSettings::placement
unsigned int QgsPalLayerSettings::placementFlags
int QgsPalLayerSettings::priority
QgsPoint QgsPalLayerSettings::ptOne

Definition at line 144 of file qgspallabeling.h.

Referenced by QgsPalLabeling::prepareLayer(), and registerFeature().

QgsPoint QgsPalLayerSettings::ptZero
double QgsPalLayerSettings::rasterCompressFactor
int QgsPalLayerSettings::scaleMax
int QgsPalLayerSettings::scaleMin
QColor QgsPalLayerSettings::textColor
QFont QgsPalLayerSettings::textFont
double QgsPalLayerSettings::vectorScaleFactor
const QgsMapToPixel* QgsPalLayerSettings::xform

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