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

#include <qgscomposerarrow.h>

Inheritance diagram for QgsComposerArrow:

Collaboration diagram for QgsComposerArrow:

Public Types
enum	MarkerMode { DefaultMarker, NoMarker, SVGMarker }
Public Member Functions
	QgsComposerArrow (QgsComposition *c)
	QgsComposerArrow (const QPointF &startPoint, const QPointF &stopPoint, QgsComposition *c)
	~QgsComposerArrow ()
QColor	arrowColor () const
double	arrowHeadWidth () const
QString	endMarker () const
MarkerMode	markerMode () const
double	outlineWidth () const
void	paint (QPainter painter, const QStyleOptionGraphicsItem itemStyle, QWidget *pWidget)
	Reimplementation of QCanvasItem::paint - draw on canvas.
bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	sets state from Dom document
void	setArrowColor (const QColor &c)
void	setArrowHeadWidth (double width)
	Sets the width of the arrow head in mm.
void	setEndMarker (const QString &svgPath)
void	setMarkerMode (MarkerMode mode)
void	setOutlineWidth (double width)
void	setSceneRect (const QRectF &rectangle)
	Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect.
void	setStartMarker (const QString &svgPath)
QString	startMarker () const
virtual int	type () const
	return correct graphics item type.
bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	stores state in Dom element
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
QColor	mArrowColor
double	mArrowHeadWidth
	Width of the arrow marker in mm.
QBrush	mBrush
QString	mEndMarkerFile
	Path to the end marker file.
MarkerMode	mMarkerMode
	Default marker, no marker or svg marker.
QPen	mPen
double	mStartArrowHeadHeight
	Height of the arrow marker in mm.
QString	mStartMarkerFile
	Path to the start marker file.
QPointF	mStartPoint
double	mStopArrowHeadHeight
QPointF	mStopPoint

Detailed Description

An item that draws an arrow between to points.

Definition at line 26 of file qgscomposerarrow.h.

Member Enumeration Documentation

enum QgsComposerArrow::MarkerMode

Enumerator:

DefaultMarker
NoMarker
SVGMarker

Definition at line 30 of file qgscomposerarrow.h.

enum QgsComposerArrow::MarkerType [private]

Enumerator:

StartMarker
EndMarker

Definition at line 82 of file qgscomposerarrow.h.

Constructor & Destructor Documentation

QgsComposerArrow::QgsComposerArrow ( QgsComposition * c )

Definition at line 25 of file qgscomposerarrow.cpp.

References initGraphicsSettings().

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

Definition at line 35 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), and initGraphicsSettings().

QgsComposerArrow::~QgsComposerArrow ( )

Definition at line 46 of file qgscomposerarrow.cpp.

Member Function Documentation

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 261 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 62 of file qgscomposerarrow.h.

double QgsComposerArrow::arrowHeadWidth ( ) const [inline]

Definition at line 52 of file qgscomposerarrow.h.

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

Draws the default marker at the line end.

Definition at line 114 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]`

Draws a user-defined marker (must be an svg file)

Definition at line 123 of file qgscomposerarrow.cpp.

References QgsComposerItem::angle(), QgsComposerItem::horizontalViewScaleFactor(), M_PI, mArrowHeadWidth, QgsComposerItem::mComposition, mEndMarkerFile, mStartArrowHeadHeight, mStartMarkerFile, mStartPoint, mStopArrowHeadHeight, mStopPoint, QgsComposition::plotStyle(), QgsComposition::Preview, and StartMarker.

Referenced by paint().

QString QgsComposerArrow::endMarker ( ) const [inline]

Definition at line 60 of file qgscomposerarrow.h.

void QgsComposerArrow::initGraphicsSettings ( ) [private]

Apply default graphics settings.

Definition at line 51 of file qgscomposerarrow.cpp.

References mPen, and setArrowHeadWidth().

Referenced by QgsComposerArrow().

MarkerMode QgsComposerArrow::markerMode ( ) const [inline]

Definition at line 65 of file qgscomposerarrow.h.

double QgsComposerArrow::outlineWidth ( ) const [inline]

Definition at line 55 of file qgscomposerarrow.h.

Referenced by writeXML().

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

Reimplementation of QCanvasItem::paint - draw on canvas.

Definition at line 62 of file qgscomposerarrow.cpp.

References DefaultMarker, QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), drawHardcodedMarker(), QgsComposerItem::drawSelectionBoxes(), drawSVGMarker(), EndMarker, mArrowColor, mEndMarkerFile, mMarkerMode, mPen, mStartMarkerFile, mStartPoint, mStopPoint, StartMarker, and SVGMarker.

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 318 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 63 of file qgscomposerarrow.h.

void QgsComposerArrow::setArrowHeadWidth ( double width )

Sets the width of the arrow head in mm.

Definition at line 253 of file qgscomposerarrow.cpp.

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

Referenced by initGraphicsSettings().

void QgsComposerArrow::setEndMarker ( const QString & svgPath )

Definition at line 231 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mArrowHeadWidth, mEndMarkerFile, and mStopArrowHeadHeight.

Referenced by readXML(), and setArrowHeadWidth().

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

Definition at line 66 of file qgscomposerarrow.h.

void QgsComposerArrow::setOutlineWidth ( double width )

Definition at line 247 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 98 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mStartPoint, and mStopPoint.

Referenced by adaptItemSceneRect().

void QgsComposerArrow::setStartMarker ( const QString & svgPath )

Definition at line 215 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mArrowHeadWidth, mStartArrowHeadHeight, and mStartMarkerFile.

Referenced by readXML(), and setArrowHeadWidth().

QString QgsComposerArrow::startMarker ( ) const [inline]

Definition at line 58 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 42 of file qgscomposerarrow.h.

References QgsComposerItem::ComposerArrow.

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

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

Member Data Documentation

QColor QgsComposerArrow::mArrowColor [private]

Definition at line 106 of file qgscomposerarrow.h.

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

double QgsComposerArrow::mArrowHeadWidth [private]

Width of the arrow marker in mm.

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

Definition at line 95 of file qgscomposerarrow.h.

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

QBrush QgsComposerArrow::mBrush [private]

Definition at line 92 of file qgscomposerarrow.h.

QString QgsComposerArrow::mEndMarkerFile [private]

Path to the end marker file.

Definition at line 103 of file qgscomposerarrow.h.

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

MarkerMode QgsComposerArrow::mMarkerMode [private]

Default marker, no marker or svg marker.

Definition at line 105 of file qgscomposerarrow.h.

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

QPen QgsComposerArrow::mPen [private]

Definition at line 91 of file qgscomposerarrow.h.

Referenced by adaptItemSceneRect(), initGraphicsSettings(), paint(), readXML(), and setOutlineWidth().

double QgsComposerArrow::mStartArrowHeadHeight [private]

Height of the arrow marker in mm.

Is calculated from arrow marker width and apsect ratio of svg

Definition at line 97 of file qgscomposerarrow.h.

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

QString QgsComposerArrow::mStartMarkerFile [private]

Path to the start marker file.

Definition at line 101 of file qgscomposerarrow.h.

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

QPointF QgsComposerArrow::mStartPoint [private]

Definition at line 88 of file qgscomposerarrow.h.

Referenced by adaptItemSceneRect(), drawHardcodedMarker(), drawSVGMarker(), paint(), readXML(), setSceneRect(), and writeXML().

double QgsComposerArrow::mStopArrowHeadHeight [private]

Definition at line 98 of file qgscomposerarrow.h.

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

QPointF QgsComposerArrow::mStopPoint [private]

Definition at line 89 of file qgscomposerarrow.h.

Referenced by adaptItemSceneRect(), drawHardcodedMarker(), drawSVGMarker(), paint(), readXML(), setSceneRect(), and writeXML().

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

src/core/composer/qgscomposerarrow.h
src/core/composer/qgscomposerarrow.cpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation