QGIS API Documentation  2.14.0-Essen
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsLineSymbolLayerV2 Class Referenceabstract

#include <qgssymbollayerv2.h>

Inheritance diagram for QgsLineSymbolLayerV2:
Inheritance graph
[legend]

Public Member Functions

void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override
 
virtual double dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const override
 
QgsMapUnitScale mapUnitScale () const override
 
double offset () const
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 
QgsSymbolV2::OutputUnit offsetUnit () const
 
QgsSymbolV2::OutputUnit outputUnit () const override
 
virtual void renderPolygonOutline (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolV2RenderContext &context)
 
virtual void renderPolyline (const QPolygonF &points, QgsSymbolV2RenderContext &context)=0
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOffset (double offset)
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 
void setOffsetUnit (QgsSymbolV2::OutputUnit unit)
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit) override
 
virtual void setWidth (double width)
 
void setWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setWidthUnit (QgsSymbolV2::OutputUnit unit)
 
virtual double width () const
 
const QgsMapUnitScalewidthMapUnitScale () const
 
QgsSymbolV2::OutputUnit widthUnit () const
 
- Public Member Functions inherited from QgsSymbolLayerV2
virtual ~QgsSymbolLayerV2 ()
 
virtual QgsSymbolLayerV2clone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
virtual QColor color () const
 The fill color. More...
 
virtual Q_DECL_DEPRECATED const QgsExpressiondataDefinedProperty (const QString &property) const
 Returns a data defined expression for a property, if set. More...
 
virtual Q_DECL_DEPRECATED QString dataDefinedPropertyString (const QString &property) const
 Returns a data defined expression for a property, if set. More...
 
virtual QColor dxfBrushColor (QgsSymbolV2RenderContext &context) const
 
virtual Qt::BrushStyle dxfBrushStyle () const
 
virtual QColor dxfColor (QgsSymbolV2RenderContext &context) const
 
virtual QVector< qreal > dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const
 
virtual Qt::PenStyle dxfPenStyle () const
 
virtual double estimateMaxBleed () const
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More...
 
virtual Q_DECL_DEPRECATED QVariant evaluateDataDefinedProperty (const QString &property, const QgsFeature *feature, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const
 Evaluates the matching data defined property and returns the calculated value. More...
 
virtual QVariant evaluateDataDefinedProperty (const QString &property, const QgsSymbolV2RenderContext &context, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const
 Evaluates the matching data defined property and returns the calculated value. More...
 
virtual QColor fillColor () const
 Get fill color. More...
 
virtual QgsDataDefinedgetDataDefinedProperty (const QString &property) const
 Returns the data defined property corresponding to the specified property key. More...
 
virtual bool hasDataDefinedProperties () const
 Checks whether the layer has any associated data defined properties. More...
 
virtual bool hasDataDefinedProperty (const QString &property) const
 Checks whether the layer has a matching data defined property and if that property is currently actived. More...
 
virtual bool isCompatibleWithSymbol (QgsSymbolV2 *symbol) const
 Returns if the layer can be used below the specified symbol. More...
 
bool isLocked () const
 
virtual QString layerType () const =0
 Returns a string that represents this layer type. More...
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
virtual QColor outlineColor () const
 Get outline color. More...
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the layer. More...
 
virtual QgsStringMap properties () const =0
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More...
 
virtual void removeDataDefinedProperties ()
 Removes all data defined properties from the layer and deletes associated objects. More...
 
virtual void removeDataDefinedProperty (const QString &property)
 Removes a data defined property from the layer. More...
 
int renderingPass () const
 
virtual void setColor (const QColor &color)
 The fill color. More...
 
virtual Q_DECL_DEPRECATED void setDataDefinedProperty (const QString &property, const QString &expressionString)
 Sets a data defined expression for a property. More...
 
virtual void setDataDefinedProperty (const QString &property, QgsDataDefined *dataDefined)
 Sets a data defined property for the layer. More...
 
virtual void setFillColor (const QColor &color)
 Set fill color. More...
 
void setLocked (bool locked)
 
virtual void setOutlineColor (const QColor &color)
 Set outline color. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the layer. More...
 
void setRenderingPass (int renderingPass)
 
virtual bool setSubSymbol (QgsSymbolV2 *symbol)
 set layer's subsymbol. takes ownership of the passed symbol More...
 
virtual void startRender (QgsSymbolV2RenderContext &context)=0
 
virtual void stopRender (QgsSymbolV2RenderContext &context)=0
 
virtual QgsSymbolV2subSymbol ()
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const
 
QgsSymbolV2::SymbolType type () const
 
virtual QSet< QStringusedAttributes () const
 Returns the set of attributes referenced by the layer. More...
 
virtual bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolV2RenderContext *context, const QgsFeature *f, QPointF shift=QPointF(0.0, 0.0)) const
 

Protected Member Functions

 QgsLineSymbolLayerV2 (bool locked=false)
 
- Protected Member Functions inherited from QgsSymbolLayerV2
 QgsSymbolLayerV2 (QgsSymbolV2::SymbolType type, bool locked=false)
 
void copyDataDefinedProperties (QgsSymbolLayerV2 *destLayer) const
 Copies all data defined properties of this layer to another symbol layer. More...
 
void copyPaintEffect (QgsSymbolLayerV2 *destLayer) const
 Copies paint effect of this layer to another symbol layer. More...
 
virtual Q_DECL_DEPRECATED QgsExpressionexpression (const QString &property) const
 Returns the data defined expression associated with a property. More...
 
virtual Q_DECL_DEPRECATED void prepareExpressions (const QgsFields *fields, double scale=-1.0)
 Prepares all data defined property expressions for evaluation. More...
 
virtual void prepareExpressions (const QgsSymbolV2RenderContext &context)
 Prepares all data defined property expressions for evaluation. More...
 
void restoreDataDefinedProperties (const QgsStringMap &stringMap)
 Restores all data defined properties from string map. More...
 
void saveDataDefinedProperties (QgsStringMap &stringMap) const
 Saves all data defined properties to a string map. More...
 

Protected Attributes

double mOffset
 
QgsMapUnitScale mOffsetMapUnitScale
 
QgsSymbolV2::OutputUnit mOffsetUnit
 
double mWidth
 
QgsMapUnitScale mWidthMapUnitScale
 
QgsSymbolV2::OutputUnit mWidthUnit
 
- Protected Attributes inherited from QgsSymbolLayerV2
QColor mColor
 
QMap< QString, QgsDataDefined * > mDataDefinedProperties
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect
 
int mRenderingPass
 
QgsSymbolV2::SymbolType mType
 

Additional Inherited Members

- Static Protected Attributes inherited from QgsSymbolLayerV2
static const QString EXPR_ALPHA
 
static const QString EXPR_ANGLE
 
static const QString EXPR_BLUR_RADIUS
 
static const QString EXPR_BORDER_COLOR
 
static const QString EXPR_BORDER_STYLE
 
static const QString EXPR_CAPSTYLE
 
static const QString EXPR_CHAR
 
static const QString EXPR_COLOR
 
static const QString EXPR_COLOR2
 
static const QString EXPR_COLOR_BORDER
 
static const QString EXPR_COORDINATE_MODE
 
static const QString EXPR_CUSTOMDASH
 
static const QString EXPR_DISPLACEMENT_X
 
static const QString EXPR_DISPLACEMENT_Y
 
static const QString EXPR_DISTANCE
 
static const QString EXPR_DISTANCE_X
 
static const QString EXPR_DISTANCE_Y
 
static const QString EXPR_FILE
 
static const QString EXPR_FILL
 
static const QString EXPR_FILL_COLOR
 
static const QString EXPR_FILL_STYLE
 
static const QString EXPR_GRADIENT_TYPE
 
static const QString EXPR_HEIGHT
 
static const QString EXPR_HORIZONTAL_ANCHOR_POINT
 
static const QString EXPR_IGNORE_RINGS
 
static const QString EXPR_INTERVAL
 
static const QString EXPR_JOIN_STYLE
 
static const QString EXPR_JOINSTYLE
 
static const QString EXPR_LINE_STYLE
 
static const QString EXPR_LINEANGLE
 
static const QString EXPR_LINEWIDTH
 
static const QString EXPR_MAX_DISTANCE
 
static const QString EXPR_NAME
 
static const QString EXPR_OFFSET
 
static const QString EXPR_OFFSET_ALONG_LINE
 
static const QString EXPR_OUTLINE
 
static const QString EXPR_OUTLINE_COLOR
 
static const QString EXPR_OUTLINE_STYLE
 
static const QString EXPR_OUTLINE_WIDTH
 
static const QString EXPR_PLACEMENT
 
static const QString EXPR_REFERENCE1_ISCENTROID
 
static const QString EXPR_REFERENCE1_X
 
static const QString EXPR_REFERENCE1_Y
 
static const QString EXPR_REFERENCE2_ISCENTROID
 
static const QString EXPR_REFERENCE2_X
 
static const QString EXPR_REFERENCE2_Y
 
static const QString EXPR_ROTATION
 
static const QString EXPR_SIZE
 
static const QString EXPR_SPREAD
 
static const QString EXPR_SVG_FILE
 
static const QString EXPR_SVG_FILL_COLOR
 
static const QString EXPR_SVG_OUTLINE_COLOR
 
static const QString EXPR_SVG_OUTLINE_WIDTH
 
static const QString EXPR_SYMBOL_NAME
 
static const QString EXPR_USE_WHOLE_SHAPE
 
static const QString EXPR_VERTICAL_ANCHOR_POINT
 
static const QString EXPR_WIDTH
 
static const QString EXPR_WIDTH_BORDER
 
static const bool selectFillBorder = false
 
static const bool selectFillStyle = false
 
static const bool selectionIsOpaque = true
 

Detailed Description

Definition at line 508 of file qgssymbollayerv2.h.

Constructor & Destructor Documentation

QgsLineSymbolLayerV2::QgsLineSymbolLayerV2 ( bool  locked = false)
protected

Definition at line 503 of file qgssymbollayerv2.cpp.

Member Function Documentation

void QgsLineSymbolLayerV2::drawPreviewIcon ( QgsSymbolV2RenderContext context,
QSize  size 
)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 687 of file qgssymbollayerv2.cpp.

double QgsLineSymbolLayerV2::dxfWidth ( const QgsDxfExport e,
QgsSymbolV2RenderContext context 
) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Reimplemented in QgsSimpleLineSymbolLayerV2.

Definition at line 709 of file qgssymbollayerv2.cpp.

QgsMapUnitScale QgsLineSymbolLayerV2::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 681 of file qgssymbollayerv2.cpp.

double QgsLineSymbolLayerV2::offset ( ) const
inline

Definition at line 518 of file qgssymbollayerv2.h.

const QgsMapUnitScale& QgsLineSymbolLayerV2::offsetMapUnitScale ( ) const
inline

Definition at line 531 of file qgssymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsLineSymbolLayerV2::offsetUnit ( ) const
inline

Definition at line 528 of file qgssymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsLineSymbolLayerV2::outputUnit ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 671 of file qgssymbollayerv2.cpp.

void QgsLineSymbolLayerV2::renderPolygonOutline ( const QPolygonF points,
QList< QPolygonF > *  rings,
QgsSymbolV2RenderContext context 
)
virtual

Reimplemented in QgsMarkerLineSymbolLayerV2, and QgsSimpleLineSymbolLayerV2.

Definition at line 699 of file qgssymbollayerv2.cpp.

virtual void QgsLineSymbolLayerV2::renderPolyline ( const QPolygonF points,
QgsSymbolV2RenderContext context 
)
pure virtual
void QgsLineSymbolLayerV2::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 676 of file qgssymbollayerv2.cpp.

void QgsLineSymbolLayerV2::setOffset ( double  offset)
inline

Definition at line 519 of file qgssymbollayerv2.h.

void QgsLineSymbolLayerV2::setOffsetMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 530 of file qgssymbollayerv2.h.

void QgsLineSymbolLayerV2::setOffsetUnit ( QgsSymbolV2::OutputUnit  unit)
inline

Definition at line 527 of file qgssymbollayerv2.h.

void QgsLineSymbolLayerV2::setOutputUnit ( QgsSymbolV2::OutputUnit  unit)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 666 of file qgssymbollayerv2.cpp.

virtual void QgsLineSymbolLayerV2::setWidth ( double  width)
inlinevirtual

Reimplemented in QgsMarkerLineSymbolLayerV2.

Definition at line 515 of file qgssymbollayerv2.h.

void QgsLineSymbolLayerV2::setWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 524 of file qgssymbollayerv2.h.

void QgsLineSymbolLayerV2::setWidthUnit ( QgsSymbolV2::OutputUnit  unit)
inline

Definition at line 521 of file qgssymbollayerv2.h.

virtual double QgsLineSymbolLayerV2::width ( ) const
inlinevirtual

Reimplemented in QgsMarkerLineSymbolLayerV2.

Definition at line 516 of file qgssymbollayerv2.h.

const QgsMapUnitScale& QgsLineSymbolLayerV2::widthMapUnitScale ( ) const
inline

Definition at line 525 of file qgssymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsLineSymbolLayerV2::widthUnit ( ) const
inline

Definition at line 522 of file qgssymbollayerv2.h.

Member Data Documentation

double QgsLineSymbolLayerV2::mOffset
protected

Definition at line 549 of file qgssymbollayerv2.h.

QgsMapUnitScale QgsLineSymbolLayerV2::mOffsetMapUnitScale
protected

Definition at line 551 of file qgssymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsLineSymbolLayerV2::mOffsetUnit
protected

Definition at line 550 of file qgssymbollayerv2.h.

double QgsLineSymbolLayerV2::mWidth
protected

Definition at line 546 of file qgssymbollayerv2.h.

QgsMapUnitScale QgsLineSymbolLayerV2::mWidthMapUnitScale
protected

Definition at line 548 of file qgssymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsLineSymbolLayerV2::mWidthUnit
protected

Definition at line 547 of file qgssymbollayerv2.h.


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