Quantum GIS API Documentation  1.8
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes
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 ()
virtual int type () const
 return correct graphics item type.
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 80 of file qgscomposerarrow.h.


Constructor & Destructor Documentation

Definition at line 24 of file qgscomposerarrow.cpp.

References initGraphicsSettings().

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

Definition at line 34 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), and initGraphicsSettings().

Definition at line 45 of file qgscomposerarrow.cpp.


Member Function Documentation

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 260 of file qgscomposerarrow.cpp.

References DefaultMarker, mArrowHeadWidth, mMarkerMode, mPen, mStartArrowHeadHeight, mStartPoint, mStopArrowHeadHeight, mStopPoint, NoMarker, setSceneRect(), and SVGMarker.

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

QColor QgsComposerArrow::arrowColor ( ) const [inline]

Definition at line 60 of file qgscomposerarrow.h.

double QgsComposerArrow::arrowHeadWidth ( ) const [inline]

Definition at line 50 of file qgscomposerarrow.h.

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

Draws the default marker at the line end.

Definition at line 113 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]
QString QgsComposerArrow::endMarker ( ) const [inline]

Definition at line 58 of file qgscomposerarrow.h.

Apply default graphics settings.

Definition at line 50 of file qgscomposerarrow.cpp.

References mPen, and setArrowHeadWidth().

Referenced by QgsComposerArrow().

Definition at line 63 of file qgscomposerarrow.h.

double QgsComposerArrow::outlineWidth ( ) const [inline]

Definition at line 53 of file qgscomposerarrow.h.

Referenced by writeXML().

void QgsComposerArrow::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
)
bool QgsComposerArrow::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
) [virtual]

sets state from Dom document

Parameters:
itemElemis Dom node corresponding to item tag
docis the document to read

Implements QgsComposerItem.

Definition at line 317 of file qgscomposerarrow.cpp.

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

Referenced by QgsComposition::addItemsFromXML().

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

Definition at line 61 of file qgscomposerarrow.h.

void QgsComposerArrow::setArrowHeadWidth ( double  width)

Sets the width of the arrow head in mm.

Definition at line 252 of file qgscomposerarrow.cpp.

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

Referenced by initGraphicsSettings().

void QgsComposerArrow::setEndMarker ( const QString &  svgPath)

Definition at line 64 of file qgscomposerarrow.h.

void QgsComposerArrow::setOutlineWidth ( double  width)

Definition at line 246 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), and mPen.

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

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

Reimplemented from QgsComposerItem.

Definition at line 97 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mStartPoint, and mStopPoint.

Referenced by adaptItemSceneRect().

void QgsComposerArrow::setStartMarker ( const QString &  svgPath)
QString QgsComposerArrow::startMarker ( ) const [inline]

Definition at line 56 of file qgscomposerarrow.h.

virtual int QgsComposerArrow::type ( ) const [inline, virtual]

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 40 of file qgscomposerarrow.h.

References QgsComposerItem::ComposerArrow.

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

stores state in Dom element

Parameters:
elemis Dom element corresponding to 'Composer' tag
docdocument

Implements QgsComposerItem.

Definition at line 284 of file qgscomposerarrow.cpp.

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


Member Data Documentation

Definition at line 104 of file qgscomposerarrow.h.

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

Width of the arrow marker in mm.

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

Definition at line 93 of file qgscomposerarrow.h.

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

QBrush QgsComposerArrow::mBrush [private]

Definition at line 90 of file qgscomposerarrow.h.

Path to the end marker file.

Definition at line 101 of file qgscomposerarrow.h.

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

Default marker, no marker or svg marker.

Definition at line 103 of file qgscomposerarrow.h.

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

QPen QgsComposerArrow::mPen [private]

Height of the arrow marker in mm.

Is calculated from arrow marker width and apsect ratio of svg

Definition at line 95 of file qgscomposerarrow.h.

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

Path to the start marker file.

Definition at line 99 of file qgscomposerarrow.h.

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

QPointF QgsComposerArrow::mStartPoint [private]

Definition at line 96 of file qgscomposerarrow.h.

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

QPointF QgsComposerArrow::mStopPoint [private]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines