QgsComposerShape Class Reference

A composer items that draws common shapes (ellipse, triangle, rectangle) More...

#include <qgscomposershape.h>

Inheritance diagram for QgsComposerShape:

Collaboration diagram for QgsComposerShape:

List of all members.

Public Types
enum	Shape { Ellipse, Rectangle, Triangle }
Public Slots
virtual void	setRotation (double r)
	Sets item rotation and resizes item bounds such that the shape always has the same size.
Public Member Functions
	QgsComposerShape (QgsComposition *composition)
	QgsComposerShape (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition)
	~QgsComposerShape ()
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.
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
void	setLineWidth (double width)
double	lineWidth () const
void	setOutlineColor (const QColor &color)
QColor	outlineColor () const
void	setFillColor (const QColor &color)
QColor	fillColor () const
QgsComposerShape::Shape	shapeType () const
void	setShapeType (QgsComposerShape::Shape s)
bool	transparentFill () const
void	setTransparentFill (bool transparent)
void	setSceneRect (const QRectF &rectangle)
	Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.
Private Member Functions
void	initGraphicsSettings ()
	Apply default graphics settings.
QPointF	pointOnLineWithDistance (const QPointF &startPoint, const QPointF &directionPoint, double distance) const
	Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point.
Private Attributes
Shape	mShape
	Ellipse, rectangle or triangle.
QPen	mPen
	Shape outline.
QBrush	mBrush
	Shape fill.
double	mShapeWidth
double	mShapeHeight

---

Detailed Description

A composer items that draws common shapes (ellipse, triangle, rectangle)

Definition at line 24 of file qgscomposershape.h.

---

Member Enumeration Documentation

enum QgsComposerShape::Shape

Enumerator:

Ellipse
Rectangle
Triangle

Definition at line 29 of file qgscomposershape.h.

---

Constructor & Destructor Documentation

QgsComposerShape::QgsComposerShape

(

QgsComposition *

composition

)

Definition at line 21 of file qgscomposershape.cpp.

References initGraphicsSettings().

QgsComposerShape::QgsComposerShape	(	qreal	x,
		qreal	y,
		qreal	width,
		qreal	height,
		QgsComposition *	composition
	)

Definition at line 26 of file qgscomposershape.cpp.

References initGraphicsSettings(), mShapeHeight, mShapeWidth, and setSceneRect().

QgsComposerShape::~QgsComposerShape

(

)

Definition at line 34 of file qgscomposershape.cpp.

---

Member Function Documentation

QColor QgsComposerShape::fillColor

(

)

const

Definition at line 187 of file qgscomposershape.cpp.

References mBrush.

void QgsComposerShape::initGraphicsSettings

(

)

[private]

Apply default graphics settings.

Definition at line 209 of file qgscomposershape.cpp.

References mBrush, and mPen.

Referenced by QgsComposerShape().

double QgsComposerShape::lineWidth

(

)

const

Definition at line 167 of file qgscomposershape.cpp.

References mPen.

QColor QgsComposerShape::outlineColor

(

)

const

Definition at line 177 of file qgscomposershape.cpp.

References mPen.

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

Reimplementation of QCanvasItem::paint - draw on canvas.

Definition at line 39 of file qgscomposershape.cpp.

References QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), QgsComposerItem::drawSelectionBoxes(), Ellipse, mBrush, mPen, QgsComposerItem::mRotation, mShape, mShapeHeight, mShapeWidth, Rectangle, and Triangle.

QPointF QgsComposerShape::pointOnLineWithDistance	(	const QPointF &	startPoint,
		const QPointF &	directionPoint,
		double	distance
	)		const [private]

Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point.

Reimplemented from QgsComposerItem.

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

sets state from Dom document

Parameters:

itemElem	is Dom node corresponding to item tag
doc	is Dom document

Implements QgsComposerItem.

Definition at line 108 of file qgscomposershape.cpp.

References QgsComposerItem::_readXML(), QgsComposerItem::itemChanged(), mBrush, mPen, mShape, mShapeHeight, and mShapeWidth.

void QgsComposerShape::setFillColor

(

const QColor &

color

)

Definition at line 182 of file qgscomposershape.cpp.

References mBrush.

void QgsComposerShape::setLineWidth

(

double

width

)

Definition at line 162 of file qgscomposershape.cpp.

References mPen.

void QgsComposerShape::setOutlineColor

(

const QColor &

color

)

Definition at line 172 of file qgscomposershape.cpp.

References mPen.

void QgsComposerShape::setRotation

(

double

r

)

[virtual, slot]

Sets item rotation and resizes item bounds such that the shape always has the same size.

Reimplemented from QgsComposerItem.

Definition at line 222 of file qgscomposershape.cpp.

References mShapeHeight, mShapeWidth, setSceneRect(), and QgsComposerItem::sizeChangedByRotation().

void QgsComposerShape::setSceneRect

(

const QRectF &

rectangle

)

[virtual]

Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.

Also, the shape is scaled

Reimplemented from QgsComposerItem.

Definition at line 237 of file qgscomposershape.cpp.

References QgsComposerItem::imageSizeConsideringRotation(), mShapeHeight, and mShapeWidth.

Referenced by QgsComposerShape(), and setRotation().

void QgsComposerShape::setShapeType

(

QgsComposerShape::Shape

s

)

[inline]

Definition at line 66 of file qgscomposershape.h.

void QgsComposerShape::setTransparentFill

(

bool

transparent

)

Definition at line 197 of file qgscomposershape.cpp.

References mBrush.

QgsComposerShape::Shape QgsComposerShape::shapeType

(

)

const [inline]

Definition at line 65 of file qgscomposershape.h.

bool QgsComposerShape::transparentFill

(

)

const

Definition at line 192 of file qgscomposershape.cpp.

References mBrush.

virtual int QgsComposerShape::type

(

)

const [inline, virtual]

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 41 of file qgscomposershape.h.

References QgsComposerItem::ComposerShape.

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

stores state in Dom element

Parameters:

elem	is Dom element corresponding to 'Composer' tag
doc	write template file

Implements QgsComposerItem.

Definition at line 84 of file qgscomposershape.cpp.

References QgsComposerItem::_writeXML(), mBrush, mPen, mShape, mShapeHeight, and mShapeWidth.

---

Member Data Documentation

QBrush QgsComposerShape::mBrush [private]

Shape fill.

Definition at line 85 of file qgscomposershape.h.

Referenced by fillColor(), initGraphicsSettings(), paint(), readXML(), setFillColor(), setTransparentFill(), transparentFill(), and writeXML().

QPen QgsComposerShape::mPen [private]

Shape outline.

Definition at line 83 of file qgscomposershape.h.

Referenced by initGraphicsSettings(), lineWidth(), outlineColor(), paint(), readXML(), setLineWidth(), setOutlineColor(), and writeXML().

Shape QgsComposerShape::mShape [private]

Ellipse, rectangle or triangle.

Definition at line 81 of file qgscomposershape.h.

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

double QgsComposerShape::mShapeHeight [private]

Definition at line 87 of file qgscomposershape.h.

Referenced by paint(), QgsComposerShape(), readXML(), setRotation(), setSceneRect(), and writeXML().

double QgsComposerShape::mShapeWidth [private]

Definition at line 86 of file qgscomposershape.h.

Referenced by paint(), QgsComposerShape(), readXML(), setRotation(), setSceneRect(), and writeXML().

---

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

• src/core/composer/qgscomposershape.h
• src/core/composer/qgscomposershape.cpp