QgsComposerArrow Class Reference

An item that draws an arrow between to points. More...

#include <qgscomposerarrow.h>

Inheritance diagram for QgsComposerArrow:

Inheritance graph
[legend]
Collaboration diagram for QgsComposerArrow:

Collaboration graph
[legend]

List of all members.

Public Types

enum  MarkerMode { DefaultMarker, NoMarker, SVGMarker }

Public Member Functions

 QgsComposerArrow (QgsComposition *c)
 QgsComposerArrow (const QPointF &startPoint, const QPointF &stopPoint, QgsComposition *c)
 ~QgsComposerArrow ()
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint - draw on canvas.
void setSceneRect (const QRectF &rectangle)
 Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect.
void setArrowHeadWidth (double width)
 Sets the width of the arrow head in mm.
double arrowHeadWidth () const
void setOutlineWidth (double width)
double outlineWidth () const
void setStartMarker (const QString &svgPath)
QString startMarker () const
void setEndMarker (const QString &svgPath)
QString endMarker () const
QColor arrowColor () const
void setArrowColor (const QColor &c)
MarkerMode markerMode () const
void setMarkerMode (MarkerMode mode)
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 stores state in Dom element
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document

Private Types

enum  MarkerType { StartMarker, EndMarker }

Private Member Functions

void adaptItemSceneRect ()
 Adapts the item scene rect to contain the start point, the stop point including the arrow marker and the outline.
void drawHardcodedMarker (QPainter *p, MarkerType type)
 Draws the default marker at the line end.
void drawSVGMarker (QPainter *p, MarkerType type, const QString &markerPath)
 Draws a user-defined marker (must be an svg file).
void initGraphicsSettings ()
 Apply default graphics settings.

Private Attributes

QPointF mStartPoint
QPointF mStopPoint
QPen mPen
QBrush mBrush
double mArrowHeadWidth
 Width of the arrow marker in mm.
double mStartArrowHeadHeight
 Height of the arrow marker in mm.
double mStopArrowHeadHeight
QString mStartMarkerFile
 Path to the start marker file.
QString mEndMarkerFile
 Path to the end marker file.
MarkerMode mMarkerMode
 Default marker, no marker or svg marker.
QColor mArrowColor


Detailed Description

An item that draws an arrow between to points.

Definition at line 24 of file qgscomposerarrow.h.


Member Enumeration Documentation

Enumerator:
DefaultMarker 
NoMarker 
SVGMarker 

Definition at line 28 of file qgscomposerarrow.h.

Enumerator:
StartMarker 
EndMarker 

Definition at line 77 of file qgscomposerarrow.h.


Constructor & Destructor Documentation

QgsComposerArrow::QgsComposerArrow ( QgsComposition c  ) 

Definition at line 28 of file qgscomposerarrow.cpp.

References initGraphicsSettings().

QgsComposerArrow::QgsComposerArrow ( const QPointF &  startPoint,
const QPointF &  stopPoint,
QgsComposition c 
)

Definition at line 33 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), and initGraphicsSettings().

QgsComposerArrow::~QgsComposerArrow (  ) 

Definition at line 40 of file qgscomposerarrow.cpp.


Member Function Documentation

void QgsComposerArrow::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
)

void QgsComposerArrow::setSceneRect ( const QRectF &  rectangle  )  [virtual]

Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect.

Reimplemented from QgsComposerItem.

Definition at line 90 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mStartPoint, and mStopPoint.

void QgsComposerArrow::setArrowHeadWidth ( double  width  ) 

Sets the width of the arrow head in mm.

Definition at line 243 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mArrowHeadWidth, mEndMarkerFile, mStartMarkerFile, setEndMarker(), and setStartMarker().

Referenced by initGraphicsSettings().

double QgsComposerArrow::arrowHeadWidth (  )  const [inline]

Definition at line 47 of file qgscomposerarrow.h.

void QgsComposerArrow::setOutlineWidth ( double  width  ) 

Definition at line 237 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), and mPen.

double QgsComposerArrow::outlineWidth (  )  const [inline]

Definition at line 50 of file qgscomposerarrow.h.

Referenced by writeXML().

void QgsComposerArrow::setStartMarker ( const QString &  svgPath  ) 

QString QgsComposerArrow::startMarker (  )  const [inline]

Definition at line 53 of file qgscomposerarrow.h.

void QgsComposerArrow::setEndMarker ( const QString &  svgPath  ) 

QString QgsComposerArrow::endMarker (  )  const [inline]

Definition at line 55 of file qgscomposerarrow.h.

QColor QgsComposerArrow::arrowColor (  )  const [inline]

Definition at line 57 of file qgscomposerarrow.h.

void QgsComposerArrow::setArrowColor ( const QColor &  c  )  [inline]

Definition at line 58 of file qgscomposerarrow.h.

MarkerMode QgsComposerArrow::markerMode (  )  const [inline]

Definition at line 60 of file qgscomposerarrow.h.

void QgsComposerArrow::setMarkerMode ( MarkerMode  mode  )  [inline]

Definition at line 61 of file qgscomposerarrow.h.

bool QgsComposerArrow::writeXML ( QDomElement &  elem,
QDomDocument &  doc 
) const [virtual]

stores state in Dom element

Parameters:
elem is Dom element corresponding to 'Composer' tag
doc document

Implements QgsComposerItem.

Definition at line 275 of file qgscomposerarrow.cpp.

References QgsComposerItem::_writeXML(), mArrowColor, mArrowHeadWidth, mEndMarkerFile, mMarkerMode, mStartMarkerFile, mStartPoint, mStopPoint, and outlineWidth().

bool QgsComposerArrow::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
) [virtual]

sets state from Dom document

Parameters:
itemElem is Dom node corresponding to item tag
doc is the document to read

Implements QgsComposerItem.

Definition at line 308 of file qgscomposerarrow.cpp.

References QgsComposerItem::_readXML(), adaptItemSceneRect(), mArrowColor, mArrowHeadWidth, mMarkerMode, mPen, mStartPoint, mStopPoint, setEndMarker(), and setStartMarker().

void QgsComposerArrow::adaptItemSceneRect (  )  [private]

Adapts the item scene rect to contain the start point, the stop point including the arrow marker and the outline.

Needs to be called whenever the arrow width/height, the outline with or the endpoints are changed

Definition at line 251 of file qgscomposerarrow.cpp.

References DefaultMarker, mArrowHeadWidth, MathUtils::max(), MathUtils::min(), mMarkerMode, mPen, mStartArrowHeadHeight, mStartPoint, mStopArrowHeadHeight, mStopPoint, NoMarker, QgsComposerItem::setSceneRect(), and SVGMarker.

Referenced by QgsComposerArrow(), readXML(), setArrowHeadWidth(), setEndMarker(), setOutlineWidth(), setSceneRect(), and setStartMarker().

void QgsComposerArrow::drawHardcodedMarker ( QPainter *  p,
MarkerType  type 
) [private]

Draws the default marker at the line end.

Definition at line 106 of file qgscomposerarrow.cpp.

References QgsComposerItem::angle(), QgsComposerItem::drawArrowHead(), mArrowColor, mArrowHeadWidth, mStartPoint, and mStopPoint.

Referenced by paint().

void QgsComposerArrow::drawSVGMarker ( QPainter *  p,
MarkerType  type,
const QString &  markerPath 
) [private]

void QgsComposerArrow::initGraphicsSettings (  )  [private]

Apply default graphics settings.

Definition at line 45 of file qgscomposerarrow.cpp.

References mPen, and setArrowHeadWidth().

Referenced by QgsComposerArrow().


Member Data Documentation

QPointF QgsComposerArrow::mStartPoint [private]

QPointF QgsComposerArrow::mStopPoint [private]

QPen QgsComposerArrow::mPen [private]

QBrush QgsComposerArrow::mBrush [private]

Definition at line 87 of file qgscomposerarrow.h.

Width of the arrow marker in mm.

May be specified by the user. The height is automatically adapted

Definition at line 90 of file qgscomposerarrow.h.

Referenced by adaptItemSceneRect(), drawHardcodedMarker(), drawSVGMarker(), readXML(), setArrowHeadWidth(), setEndMarker(), setStartMarker(), and writeXML().

Height of the arrow marker in mm.

Is calculated from arrow marker width and apsect ratio of svg

Definition at line 92 of file qgscomposerarrow.h.

Referenced by adaptItemSceneRect(), drawSVGMarker(), and setStartMarker().

Definition at line 93 of file qgscomposerarrow.h.

Referenced by adaptItemSceneRect(), drawSVGMarker(), and setEndMarker().

Path to the start marker file.

Definition at line 96 of file qgscomposerarrow.h.

Referenced by drawSVGMarker(), paint(), setArrowHeadWidth(), setStartMarker(), and writeXML().

Path to the end marker file.

Definition at line 98 of file qgscomposerarrow.h.

Referenced by drawSVGMarker(), paint(), setArrowHeadWidth(), setEndMarker(), and writeXML().

Default marker, no marker or svg marker.

Definition at line 100 of file qgscomposerarrow.h.

Referenced by adaptItemSceneRect(), paint(), readXML(), and writeXML().

Definition at line 101 of file qgscomposerarrow.h.

Referenced by drawHardcodedMarker(), paint(), readXML(), and writeXML().


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

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