QgsSymbolV2 Class Reference

#include <qgssymbolv2.h>

Inheritance diagram for QgsSymbolV2:

Inheritance graph
[legend]

List of all members.

Public Types

enum  OutputUnit { MM, MapUnit }
enum  SymbolType { Marker, Line, Fill }
enum  RenderHint { DataDefinedSizeScale = 1, DataDefinedRotation = 2 }

Public Member Functions

virtual ~QgsSymbolV2 ()
SymbolType type () const
QgsSymbolLayerV2symbolLayer (int layer)
int symbolLayerCount ()
bool insertSymbolLayer (int index, QgsSymbolLayerV2 *layer)
 insert symbol layer to specified index
bool appendSymbolLayer (QgsSymbolLayerV2 *layer)
 append symbol layer at the end of the list
bool deleteSymbolLayer (int index)
 delete symbol layer at specified index
QgsSymbolLayerV2takeSymbolLayer (int index)
 remove symbol layer from the list and return pointer to it
bool changeSymbolLayer (int index, QgsSymbolLayerV2 *layer)
 delete layer at specified index and set a new one
void startRender (QgsRenderContext &context)
void stopRender (QgsRenderContext &context)
void setColor (const QColor &color)
QColor color ()
void drawPreviewIcon (QPainter *painter, QSize size)
QImage bigSymbolPreviewImage ()
QString dump ()
virtual QgsSymbolV2clone () const =0
OutputUnit outputUnit () const
void setOutputUnit (OutputUnit u)
qreal alpha () const
void setAlpha (qreal alpha)
void setRenderHints (int hints)
int renderHints ()

Static Public Member Functions

static QgsSymbolV2defaultSymbol (QGis::GeometryType geomType)
 return new default symbol for specified geometry type

Protected Member Functions

 QgsSymbolV2 (SymbolType type, QgsSymbolLayerV2List layers)
QgsSymbolLayerV2List cloneLayers () const

Protected Attributes

SymbolType mType
QgsSymbolLayerV2List mLayers
OutputUnit mOutputUnit
qreal mAlpha
 Symbol opacity (in the range 0 - 1).
int mRenderHints


Detailed Description

Definition at line 21 of file qgssymbolv2.h.


Member Enumeration Documentation

Enumerator:
MM 
MapUnit 

Definition at line 25 of file qgssymbolv2.h.

Enumerator:
Marker 
Line 
Fill 

Definition at line 31 of file qgssymbolv2.h.

Note:
added in 1.5
Enumerator:
DataDefinedSizeScale 
DataDefinedRotation 

Definition at line 39 of file qgssymbolv2.h.


Constructor & Destructor Documentation

QgsSymbolV2::~QgsSymbolV2 (  )  [virtual]

Definition at line 40 of file qgssymbolv2.cpp.

References mLayers.

QgsSymbolV2::QgsSymbolV2 ( SymbolType  type,
QgsSymbolLayerV2List  layers 
) [protected]

Definition at line 20 of file qgssymbolv2.cpp.

References mLayers, mType, and type().


Member Function Documentation

QgsSymbolV2 * QgsSymbolV2::defaultSymbol ( QGis::GeometryType  geomType  )  [static]

return new default symbol for specified geometry type

Definition at line 47 of file qgssymbolv2.cpp.

References QGis::Line, QGis::Point, QGis::Polygon, QgsDebugMsg, and setColor().

Referenced by QgsFeatureRendererV2::defaultRenderer(), and QgsVectorLayer::drawRendererV2Levels().

SymbolType QgsSymbolV2::type (  )  const [inline]

QgsSymbolLayerV2 * QgsSymbolV2::symbolLayer ( int  layer  ) 

int QgsSymbolV2::symbolLayerCount (  )  [inline]

bool QgsSymbolV2::insertSymbolLayer ( int  index,
QgsSymbolLayerV2 layer 
)

insert symbol layer to specified index

Definition at line 73 of file qgssymbolv2.cpp.

References mLayers, mType, and QgsSymbolLayerV2::type().

bool QgsSymbolV2::appendSymbolLayer ( QgsSymbolLayerV2 layer  ) 

append symbol layer at the end of the list

Definition at line 85 of file qgssymbolv2.cpp.

References mLayers, mType, and QgsSymbolLayerV2::type().

bool QgsSymbolV2::deleteSymbolLayer ( int  index  ) 

delete symbol layer at specified index

Definition at line 95 of file qgssymbolv2.cpp.

References mLayers.

QgsSymbolLayerV2 * QgsSymbolV2::takeSymbolLayer ( int  index  ) 

remove symbol layer from the list and return pointer to it

Definition at line 106 of file qgssymbolv2.cpp.

References mLayers.

bool QgsSymbolV2::changeSymbolLayer ( int  index,
QgsSymbolLayerV2 layer 
)

delete layer at specified index and set a new one

Definition at line 115 of file qgssymbolv2.cpp.

References mLayers, mType, and QgsSymbolLayerV2::type().

void QgsSymbolV2::startRender ( QgsRenderContext context  ) 

void QgsSymbolV2::stopRender ( QgsRenderContext context  ) 

void QgsSymbolV2::setColor ( const QColor &  color  ) 

QColor QgsSymbolV2::color ( void   ) 

Definition at line 151 of file qgssymbolv2.cpp.

References mLayers.

Referenced by dump(), and QgsMarkerLineSymbolLayerV2::setSubSymbol().

void QgsSymbolV2::drawPreviewIcon ( QPainter *  painter,
QSize  size 
)

QImage QgsSymbolV2::bigSymbolPreviewImage (  ) 

QString QgsSymbolV2::dump (  ) 

virtual QgsSymbolV2* QgsSymbolV2::clone (  )  const [pure virtual]

OutputUnit QgsSymbolV2::outputUnit (  )  const [inline]

Definition at line 88 of file qgssymbolv2.h.

Referenced by QgsSymbolLayerV2Utils::saveSymbol().

void QgsSymbolV2::setOutputUnit ( OutputUnit  u  )  [inline]

qreal QgsSymbolV2::alpha (  )  const [inline]

Definition at line 91 of file qgssymbolv2.h.

Referenced by QgsSymbolLayerV2Utils::saveSymbol().

void QgsSymbolV2::setAlpha ( qreal  alpha  )  [inline]

void QgsSymbolV2::setRenderHints ( int  hints  )  [inline]

int QgsSymbolV2::renderHints (  )  [inline]

Note:
added in 1.5

Definition at line 97 of file qgssymbolv2.h.

QgsSymbolLayerV2List QgsSymbolV2::cloneLayers (  )  const [protected]


Member Data Documentation

qreal QgsSymbolV2::mAlpha [protected]

int QgsSymbolV2::mRenderHints [protected]


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

Generated on Sat Feb 4 19:17:55 2012 for Quantum GIS API Documentation by  doxygen 1.5.6