A item that forms part of a map composition. More...

#include <qgscomposeritem.h>

Inheritance diagram for QgsComposerItem:

Collaboration diagram for QgsComposerItem:

Public Types
enum	ItemType { ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel, ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture, ComposerScaleBar, ComposerShape, ComposerTable, ComposerAttributeTable, ComposerTextTable }
enum	MouseMoveAction { MoveItem, ResizeUp, ResizeDown, ResizeLeft, ResizeRight, ResizeLeftUp, ResizeRightUp, ResizeLeftDown, ResizeRightDown, NoAction }
	Describes the action (move or resize in different directon) to be done during mouse move. More...
enum	ItemPositionMode { UpperLeft, UpperMiddle, UpperRight, MiddleLeft, Middle, MiddleRight, LowerLeft, LowerMiddle, LowerRight }
Public Slots
virtual void	setRotation (double r)
void	repaint ()
Signals
void	rotationChanged (double newRotation)
	Is emitted on rotation change to notify north arrow pictures.
void	itemChanged ()
	Used e.g.
Public Member Functions
	QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
	Constructor.
	QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
	Constructor with box position and composer object.
virtual	~QgsComposerItem ()
virtual int	type () const
	return correct graphics item type.
virtual void	setSelected (bool s)
	Set selected, selected item should be highlighted.
virtual bool	selected (void)
	Is selected.
virtual bool	writeSettings (void)
	stores state in project
virtual bool	readSettings (void)
	read state from project
virtual bool	removeSettings (void)
	delete settings from project file
void	move (double dx, double dy)
	Moves item in canvas coordinates.
virtual void	moveContent (double dx, double dy)
	Move Content of item.
virtual void	zoomContent (int delta, double x, double y)
	Zoom content of item.
void	setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft)
	Moves the item to a new position (in canvas coordinates)
void	setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft)
	Sets item position and width / height in one go.
virtual void	setSceneRect (const QRectF &rectangle)
	Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.
virtual bool	writeXML (QDomElement &elem, QDomDocument &doc) const =0
	stores state in Dom element
bool	_writeXML (QDomElement &itemElem, QDomDocument &doc) const
	Writes parameter that are not subclass specific in document.
virtual bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)=0
	sets state from Dom document
bool	_readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Reads parameter that are not subclass specific in document.
Q_DECL_DEPRECATED bool	frame () const
	Whether this item has a frame or not.
bool	hasFrame () const
	Whether this item has a frame or not.
Q_DECL_DEPRECATED void	setFrame (bool drawFrame)
	Set whether this item has a frame drawn around it or not.
void	setFrameEnabled (bool drawFrame)
	Set whether this item has a frame drawn around it or not.
virtual void	addItem (QgsComposerItem *item)
	Composite operations for item groups do nothing per default.
virtual void	removeItems ()
const QgsComposition *	composition () const
void	beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
	Starts new composer undo command.
void	endCommand ()
	Finish current command and push it onto the undo stack.
void	cancelCommand ()
void	drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const
	Draws Text.
void	drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignement=Qt::AlignLeft, Qt::AlignmentFlag valignement=Qt::AlignTop) const
	Like the above, but with a rectangle for multiline text.
double	textWidthMillimeters (const QFont &font, const QString &text) const
	Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double	fontHeightCharacterMM (const QFont &font, const QChar &c) const
	Returns the font height of a character in millimeters.
double	fontAscentMillimeters (const QFont &font) const
	Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double	pixelFontSize (double pointSize) const
	Calculates font to from point size to pixel size.
QFont	scaledFontPixelSize (const QFont &font) const
	Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.
void	setPositionLock (bool lock)
	Locks / unlocks the item position for mouse drags.
bool	positionLock () const
	Returns position lock for mouse drags (true means locked)
void	updateCursor (const QPointF &itemPos)
	Update mouse cursor at (item) position.
double	rotation () const
virtual void	updateItem ()
	Updates item, with the possibility to do custom update for subclasses.
QString	id () const
	Get item identification name.
void	setId (const QString &id)
	Set item identification name.
Protected Member Functions
virtual void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)
virtual void	mousePressEvent (QGraphicsSceneMouseEvent *event)
virtual void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
virtual void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)
Qt::CursorShape	cursorForPosition (const QPointF &itemCoordPos)
	Finds out the appropriate cursor for the current mouse position in the widget (e.g.
QgsComposerItem::MouseMoveAction	mouseMoveActionForPosition (const QPointF &itemCoordPos)
	Finds out which mouse move action to choose depending on the cursor position inside the widget.
void	changeItemRectangle (const QPointF &currentPosition, const QPointF &mouseMoveStartPos, const QGraphicsRectItem originalItem, double dx, double dy, QGraphicsRectItem changeItem)
	Changes the rectangle of an item depending on current mouse action (resize or move)
virtual void	drawSelectionBoxes (QPainter *p)
	Draw selection boxes around item.
virtual void	drawFrame (QPainter *p)
	Draw black frame around item.
virtual void	drawBackground (QPainter *p)
	Draw background.
void	drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
	Draws arrowhead.
double	angle (const QPointF &p1, const QPointF &p2) const
	Returns angle of the line from p1 to p2 (clockwise, starting at N)
double	rectHandlerBorderTolerance () const
	Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing.
double	lockSymbolSize () const
	Returns the size of the lock symbol depending on the composer zoom level and the item size.
double	horizontalViewScaleFactor () const
	Returns the zoom factor of the graphics view.
bool	imageSizeConsideringRotation (double &width, double &height) const
	Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation.
bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
	Calculates corner point after rotation and scaling.
void	sizeChangedByRotation (double &width, double &height)
	Calculates width / height of the bounding box of a rotated rectangle (mRotation)
void	rotate (double angle, double &x, double &y) const
	Rotates a point / vector.
Protected Attributes
QgsComposition *	mComposition
QgsComposerItem::MouseMoveAction	mCurrentMouseMoveAction
QPointF	mMouseMoveStartPos
	Start point of the last mouse move action (in scene coordinates)
QPointF	mLastMouseEventPos
	Position of the last mouse move event (in scene coordinates)
QGraphicsRectItem *	mBoundingResizeRectangle
	Rectangle used during move and resize actions.
bool	mFrame
	True if item fram needs to be painted.
bool	mItemPositionLocked
	True if item position and size cannot be changed with mouse move.
double	mLastValidViewScaleFactor
	Backup to restore item appearance if no view scale factor is available.
double	mRotation
	Item rotation in degrees, clockwise.
Private Member Functions
void	init (bool manageZValue)
Private Attributes
QString	mId

Detailed Description

A item that forms part of a map composition.

Definition at line 33 of file qgscomposeritem.h.

Member Enumeration Documentation

enum QgsComposerItem::ItemPositionMode

Enumerator:

UpperLeft
UpperMiddle
UpperRight
MiddleLeft
Middle
MiddleRight
LowerLeft
LowerMiddle
LowerRight

Definition at line 73 of file qgscomposeritem.h.

enum QgsComposerItem::ItemType

Enumerator:

ComposerItem
ComposerArrow
ComposerItemGroup
ComposerLabel
ComposerLegend
ComposerMap
ComposerPaper
ComposerPicture
ComposerScaleBar
ComposerShape
ComposerTable
ComposerAttributeTable
ComposerTextTable

Definition at line 38 of file qgscomposeritem.h.

enum QgsComposerItem::MouseMoveAction

Describes the action (move or resize in different directon) to be done during mouse move.

Enumerator:

MoveItem
ResizeUp
ResizeDown
ResizeLeft
ResizeRight
ResizeLeftUp
ResizeRightUp
ResizeLeftDown
ResizeRightDown
NoAction

Definition at line 59 of file qgscomposeritem.h.

Constructor & Destructor Documentation

QgsComposerItem::QgsComposerItem	(	QgsComposition *	composition,
		bool	manageZValue = `true`
	)

Constructor.

Parameters:

composition	parent composition
manageZValue	true if the z-Value of this object should be managed by mComposition

Definition at line 39 of file qgscomposeritem.cpp.

References init().

QgsComposerItem::QgsComposerItem	(	qreal	x,
		qreal	y,
		qreal	width,
		qreal	height,
		QgsComposition *	composition,
		bool	manageZValue = `true`
	)

Constructor with box position and composer object.

Parameters:

x	x coordinate of item
y	y coordinate of item
width	width of item
height	height of item
composition	parent composition
manageZValue	true if the z-Value of this object should be managed by mComposition

Definition at line 52 of file qgscomposeritem.cpp.

References init().

QgsComposerItem::~QgsComposerItem ( ) [virtual]

Definition at line 84 of file qgscomposeritem.cpp.

References mBoundingResizeRectangle, mComposition, and QgsComposition::removeItemFromZList().

Member Function Documentation

bool QgsComposerItem::_readXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc
	)

Reads parameter that are not subclass specific in document.

Usually called from readXML methods of subclasses

Definition at line 171 of file qgscomposeritem.cpp.

References frame(), mFrame, mId, mItemPositionLocked, mLastValidViewScaleFactor, mRotation, positionLock(), and setSceneRect().

Referenced by QgsComposerShape::readXML(), QgsComposerPicture::readXML(), QgsComposerArrow::readXML(), QgsComposerLabel::readXML(), QgsComposerLegend::readXML(), QgsComposerScaleBar::readXML(), QgsComposerMap::readXML(), and QgsComposerTable::tableReadXML().

bool QgsComposerItem::_writeXML	(	QDomElement &	itemElem,
		QDomDocument &	doc
	)		const

Writes parameter that are not subclass specific in document.

Usually called from writeXML methods of subclasses

Definition at line 107 of file qgscomposeritem.cpp.

References mFrame, mId, mItemPositionLocked, mLastValidViewScaleFactor, and mRotation.

Referenced by QgsComposerTable::tableWriteXML(), QgsComposerTextTable::writeXML(), QgsComposerShape::writeXML(), QgsComposerPicture::writeXML(), QgsComposerArrow::writeXML(), QgsComposerLabel::writeXML(), QgsComposerLegend::writeXML(), QgsComposerScaleBar::writeXML(), and QgsComposerMap::writeXML().

virtual void QgsComposerItem::addItem ( QgsComposerItem * item ) [inline, virtual]

Composite operations for item groups do nothing per default.

Reimplemented in QgsComposerItemGroup.

Definition at line 187 of file qgscomposeritem.h.

double QgsComposerItem::angle	(	const QPointF &	p1,
		const QPointF &	p2
	)		const `[protected]`

Returns angle of the line from p1 to p2 (clockwise, starting at N)

Definition at line 850 of file qgscomposeritem.cpp.

References M_PI.

Referenced by QgsComposerArrow::drawHardcodedMarker(), and QgsComposerArrow::drawSVGMarker().

void QgsComposerItem::beginCommand	(	const QString &	commandText,
		QgsComposerMergeCommand::Context	c = `QgsComposerMergeCommand::Unknown`
	)

Starts new composer undo command.

Parameters:

commandText	command title
c	context for mergeable commands (unknown for non-mergeable commands

Definition at line 268 of file qgscomposeritem.cpp.

References QgsComposition::beginCommand(), and mComposition.

Referenced by mouseReleaseEvent(), and QgsComposerView::wheelEvent().

void QgsComposerItem::cancelCommand ( )

Definition at line 284 of file qgscomposeritem.cpp.

References QgsComposition::cancelCommand(), and mComposition.

void QgsComposerItem::changeItemRectangle	(	const QPointF &	currentPosition,
		const QPointF &	mouseMoveStartPos,
		const QGraphicsRectItem *	originalItem,
		double	dx,
		double	dy,
		QGraphicsRectItem *	changeItem
	)		`[protected]`

Changes the rectangle of an item depending on current mouse action (resize or move)

Parameters:

currentPosition	current position of mouse cursor
mouseMoveStartPos	cursor position at the start of the current mouse action
originalItem	Item position at the start of the mouse action
dx	x-Change of mouse cursor
dy	y-Change of mouse cursor
changeItem	Item to change size (can be the same as originalItem or a differen one)

Definition at line 487 of file qgscomposeritem.cpp.

References mComposition, mCurrentMouseMoveAction, MoveItem, NoAction, ResizeDown, ResizeLeft, ResizeLeftDown, ResizeLeftUp, ResizeRight, ResizeRightDown, ResizeRightUp, ResizeUp, setSceneRect(), QgsComposition::snapPointToGrid(), and updateItem().

Referenced by mouseMoveEvent(), and mouseReleaseEvent().

const QgsComposition* QgsComposerItem::composition ( ) const [inline]

Definition at line 190 of file qgscomposeritem.h.

Referenced by QgsComposerMap::QgsComposerMap(), and QgsComposerAttributeTable::readXML().

bool QgsComposerItem::cornerPointOnRotatedAndScaledRect	(	double &	x,
		double &	y,
		double	width,
		double	height
	)		const `[protected]`

Calculates corner point after rotation and scaling.

Definition at line 1022 of file qgscomposeritem.cpp.

References M_PI, and mRotation.

Referenced by imageSizeConsideringRotation().

Qt::CursorShape QgsComposerItem::cursorForPosition ( const QPointF & itemCoordPos ) [protected]

Finds out the appropriate cursor for the current mouse position in the widget (e.g.

move in the middle, resize at border)

Definition at line 392 of file qgscomposeritem.cpp.

References mouseMoveActionForPosition(), MoveItem, NoAction, ResizeDown, ResizeLeft, ResizeLeftDown, ResizeLeftUp, ResizeRight, ResizeRightDown, ResizeRightUp, and ResizeUp.

Referenced by hoverMoveEvent(), and updateCursor().

void QgsComposerItem::drawArrowHead	(	QPainter *	p,
		double	x,
		double	y,
		double	angle,
		double	arrowHeadWidth
	)		const `[protected]`

Draws arrowhead.

Definition at line 779 of file qgscomposeritem.cpp.

References M_PI.

Referenced by QgsComposerArrow::drawHardcodedMarker().

void QgsComposerItem::drawBackground ( QPainter * p ) [protected, virtual]

Draw background.

Definition at line 729 of file qgscomposeritem.cpp.

Referenced by QgsComposerLabel::paint(), QgsPaperItem::paint(), QgsComposerTable::paint(), QgsComposerPicture::paint(), QgsComposerArrow::paint(), QgsComposerShape::paint(), QgsComposerScaleBar::paint(), QgsComposerMap::paint(), and QgsComposerLegend::paintAndDetermineSize().

void QgsComposerItem::drawFrame ( QPainter * p ) [protected, virtual]

Draw black frame around item.

Reimplemented in QgsComposerItemGroup.

Definition at line 646 of file qgscomposeritem.cpp.

References mFrame.

Referenced by QgsComposerLabel::paint(), QgsComposerTable::paint(), QgsComposerPicture::paint(), QgsComposerArrow::paint(), QgsComposerShape::paint(), QgsComposerScaleBar::paint(), QgsComposerMap::paint(), and QgsComposerLegend::paintAndDetermineSize().

void QgsComposerItem::drawSelectionBoxes ( QPainter * p ) [protected, virtual]

Draw selection boxes around item.

Definition at line 606 of file qgscomposeritem.cpp.

References QgsApplication::activeThemePath(), QgsApplication::defaultThemePath(), lockSymbolSize(), mComposition, mItemPositionLocked, QgsComposition::plotStyle(), QgsComposition::Preview, and rectHandlerBorderTolerance().

Referenced by QgsComposerLabel::paint(), QgsComposerTable::paint(), QgsComposerPicture::paint(), QgsComposerItemGroup::paint(), QgsComposerArrow::paint(), QgsComposerShape::paint(), QgsComposerScaleBar::paint(), QgsComposerMap::paint(), and QgsComposerLegend::paintAndDetermineSize().

void QgsComposerItem::drawText	(	QPainter *	p,
		double	x,
		double	y,
		const QString &	text,
		const QFont &	font
	)		const

Draws Text.

Takes care about all the composer specific issues (calculation to pixel, scaling of font and painter to work around the Qt font bug)

Definition at line 752 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

Referenced by QgsNumericScaleBarStyle::draw(), QgsComposerMap::drawAnnotation(), QgsComposerLegend::drawGroupItem(), QgsScaleBarStyle::drawLabels(), QgsComposerLegend::drawLayerChildItems(), QgsComposerLegend::drawLayerItem(), QgsComposerLabel::paint(), QgsComposerTable::paint(), and QgsComposerLegend::paintAndDetermineSize().

void QgsComposerItem::drawText	(	QPainter *	p,
		const QRectF &	rect,
		const QString &	text,
		const QFont &	font,
		Qt::AlignmentFlag	halignement = `Qt::AlignLeft`,
		Qt::AlignmentFlag	valignement = `Qt::AlignTop`
	)		const

Like the above, but with a rectangle for multiline text.

Definition at line 765 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

void QgsComposerItem::endCommand ( )

Finish current command and push it onto the undo stack.

Definition at line 276 of file qgscomposeritem.cpp.

References QgsComposition::endCommand(), and mComposition.

Referenced by mouseReleaseEvent().

double QgsComposerItem::fontAscentMillimeters ( const QFont & font ) const

Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.

Definition at line 830 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

Referenced by QgsComposerTable::adaptItemFrame(), QgsComposerLabel::adjustSizeToText(), QgsNumericScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::calculateBoxSize(), QgsDoubleBoxScaleBarStyle::draw(), QgsNumericScaleBarStyle::draw(), QgsSingleBoxScaleBarStyle::draw(), QgsTicksScaleBarStyle::draw(), QgsComposerLegend::drawGroupItem(), QgsComposerTable::drawHorizontalGridLines(), QgsScaleBarStyle::drawLabels(), QgsComposerLegend::drawLayerItem(), QgsComposerMap::maxExtension(), QgsComposerTable::paint(), QgsComposerLegend::paintAndDetermineSize(), and QgsComposerAttributeTable::setSceneRect().

double QgsComposerItem::fontHeightCharacterMM	(	const QFont &	font,
		const QChar &	c
	)		const

Returns the font height of a character in millimeters.

Note:: this method was added in version 1.7

Definition at line 823 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

Referenced by QgsComposerMap::drawCoordinateAnnotation(), and QgsComposerLegend::drawLayerChildItems().

Q_DECL_DEPRECATED bool QgsComposerItem::frame ( ) const [inline]

Whether this item has a frame or not.

Returns:: boolean - true if there is a frame around this item, otherwise false.

Note:: deprecated since 1.8 don't use!

See also:: hasFrame

Definition at line 166 of file qgscomposeritem.h.

Referenced by _readXML().

bool QgsComposerItem::hasFrame ( ) const [inline]

Whether this item has a frame or not.

Returns:: true if there is a frame around this item, otherwise false.

Note:: introduced since 1.8

Definition at line 171 of file qgscomposeritem.h.

double QgsComposerItem::horizontalViewScaleFactor ( ) const [protected]

Returns the zoom factor of the graphics view.

Returns:: the factor or -1 in case of error (e.g. graphic view does not exist)

Note:: : this function was introduced in version 1.2

Definition at line 868 of file qgscomposeritem.cpp.

References mLastValidViewScaleFactor.

Referenced by QgsComposerMap::cache(), QgsComposerArrow::drawSVGMarker(), lockSymbolSize(), QgsComposerMap::paint(), and rectHandlerBorderTolerance().

void QgsComposerItem::hoverMoveEvent ( QGraphicsSceneHoverEvent * event ) [protected, virtual]

Definition at line 740 of file qgscomposeritem.cpp.

References cursorForPosition().

QString QgsComposerItem::id ( ) const [inline]

Get item identification name.

Note:: this method was added in version 1.7

Reimplemented in QgsComposerMap.

Definition at line 245 of file qgscomposeritem.h.

bool QgsComposerItem::imageSizeConsideringRotation	(	double &	width,
		double &	height
	)		const `[protected]`

Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation.

Definition at line 939 of file qgscomposeritem.cpp.

References cornerPointOnRotatedAndScaledRect(), mRotation, and QgsSymbolLayerV2Utils::pointOnLineWithDistance().

Referenced by QgsComposerPicture::setSceneRect(), and QgsComposerShape::setSceneRect().

void QgsComposerItem::init ( bool manageZValue ) [private]

Definition at line 68 of file qgscomposeritem.cpp.

References QgsComposition::addItemToZList(), and mComposition.

Referenced by QgsComposerItem().

void QgsComposerItem::itemChanged ( ) [signal]

Used e.g.

by the item widgets to update the gui elements

double QgsComposerItem::lockSymbolSize ( ) const [protected]

Returns the size of the lock symbol depending on the composer zoom level and the item size.

Note:: : this function was introduced in version 1.2

Definition at line 905 of file qgscomposeritem.cpp.

References horizontalViewScaleFactor().

Referenced by drawSelectionBoxes().

QgsComposerItem::MouseMoveAction QgsComposerItem::mouseMoveActionForPosition ( const QPointF & itemCoordPos ) [protected]

Finds out which mouse move action to choose depending on the cursor position inside the widget.

Definition at line 418 of file qgscomposeritem.cpp.

References mItemPositionLocked, MoveItem, NoAction, rectHandlerBorderTolerance(), ResizeDown, ResizeLeft, ResizeLeftDown, ResizeLeftUp, ResizeRight, ResizeRightDown, ResizeRightUp, and ResizeUp.

Referenced by cursorForPosition(), and mousePressEvent().

void QgsComposerItem::mouseMoveEvent ( QGraphicsSceneMouseEvent * event ) [protected, virtual]

Definition at line 292 of file qgscomposeritem.cpp.

References changeItemRectangle(), mBoundingResizeRectangle, mItemPositionLocked, mLastMouseEventPos, and mMouseMoveStartPos.

void QgsComposerItem::mousePressEvent ( QGraphicsSceneMouseEvent * event ) [protected, virtual]

Definition at line 314 of file qgscomposeritem.cpp.

References mBoundingResizeRectangle, mCurrentMouseMoveAction, mItemPositionLocked, mLastMouseEventPos, mMouseMoveStartPos, and mouseMoveActionForPosition().

void QgsComposerItem::mouseReleaseEvent ( QGraphicsSceneMouseEvent * event ) [protected, virtual]

Definition at line 352 of file qgscomposeritem.cpp.

References beginCommand(), changeItemRectangle(), endCommand(), mBoundingResizeRectangle, mCurrentMouseMoveAction, MathUtils::min(), mItemPositionLocked, mMouseMoveStartPos, and MoveItem.

void QgsComposerItem::move	(	double	dx,
		double	dy
	)

Moves item in canvas coordinates.

Definition at line 657 of file qgscomposeritem.cpp.

References setSceneRect().

Referenced by QgsComposerScaleBar::correctXPositionAlignment().

virtual void QgsComposerItem::moveContent	(	double	dx,
		double	dy
	)		`[inline, virtual]`

Move Content of item.

Does nothing per default (but implemented in composer map)

Parameters:

dx	move in x-direction (canvas coordinates)
dy	move in y-direction(canvas coordinates)

Reimplemented in QgsComposerMap.

Definition at line 124 of file qgscomposeritem.h.

Referenced by QgsComposerView::mouseReleaseEvent().

double QgsComposerItem::pixelFontSize ( double pointSize ) const

Calculates font to from point size to pixel size.

Definition at line 837 of file qgscomposeritem.cpp.

Referenced by scaledFontPixelSize().

bool QgsComposerItem::positionLock ( ) const [inline]

Returns position lock for mouse drags (true means locked)

Note:: this method was added in version 1.2

Definition at line 232 of file qgscomposeritem.h.

Referenced by _readXML(), and QgsComposerView::mousePressEvent().

bool QgsComposerItem::readSettings ( void ) [virtual]

read state from project

Definition at line 103 of file qgscomposeritem.cpp.

virtual bool QgsComposerItem::readXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc
	)		`[pure virtual]`

sets state from Dom document

Parameters:

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

Implemented in QgsComposerMap, QgsComposerScaleBar, QgsComposerLegend, QgsComposerLabel, QgsComposerArrow, QgsComposerItemGroup, QgsComposerPicture, QgsComposerShape, QgsComposerAttributeTable, QgsPaperItem, QgsComposerTable, and QgsComposerTextTable.

Referenced by QgsComposerItemCommand::restoreState().

double QgsComposerItem::rectHandlerBorderTolerance ( ) const [protected]

Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing.

Definition at line 887 of file qgscomposeritem.cpp.

References horizontalViewScaleFactor().

Referenced by drawSelectionBoxes(), and mouseMoveActionForPosition().

virtual void QgsComposerItem::removeItems ( ) [inline, virtual]

Reimplemented in QgsComposerItemGroup.

Definition at line 188 of file qgscomposeritem.h.

bool QgsComposerItem::removeSettings ( void ) [virtual]

delete settings from project file

Definition at line 105 of file qgscomposeritem.cpp.

void QgsComposerItem::repaint ( ) [slot]

Definition at line 1106 of file qgscomposeritem.cpp.

Referenced by QgsComposerItemCommand::restoreState(), and QgsComposerAttributeTable::setComposerMap().

void QgsComposerItem::rotate	(	double	angle,
		double &	x,
		double &	y
	)		const `[protected]`

Rotates a point / vector.

Parameters:

angle	rotation angle in degrees, counterclockwise
x	in/out: x coordinate before / after the rotation
y	in/out: y cooreinate before / after the rotation

Definition at line 1096 of file qgscomposeritem.cpp.

References M_PI.

Referenced by QgsComposerMap::mapPolygon(), QgsComposerMap::mapToItemCoords(), sizeChangedByRotation(), and QgsComposerMap::transformShift().

double QgsComposerItem::rotation ( ) const [inline]

Definition at line 238 of file qgscomposeritem.h.

Referenced by QgsComposerMap::drawCoordinateAnnotation(), and QgsComposerPicture::setRotationMap().

void QgsComposerItem::rotationChanged ( double newRotation ) [signal]

Is emitted on rotation change to notify north arrow pictures.

Referenced by QgsComposerPicture::readXML(), QgsComposerMap::setMapRotation(), setRotation(), and QgsComposerPicture::setRotationMap().

QFont QgsComposerItem::scaledFontPixelSize ( const QFont & font ) const

Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.

Definition at line 842 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and pixelFontSize().

Referenced by drawText(), fontAscentMillimeters(), fontHeightCharacterMM(), and textWidthMillimeters().

virtual bool QgsComposerItem::selected ( void ) [inline, virtual]

Is selected.

Definition at line 107 of file qgscomposeritem.h.

Q_DECL_DEPRECATED void QgsComposerItem::setFrame ( bool drawFrame ) [inline]

Set whether this item has a frame drawn around it or not.

Returns:: void

Note:: deprecated since 1.8 don't use!

See also:: setFrameEnabled

Definition at line 177 of file qgscomposeritem.h.

void QgsComposerItem::setFrameEnabled ( bool drawFrame ) [inline]

Set whether this item has a frame drawn around it or not.

Parameters:

drawFrame draw frame

Returns:: nothing

Note:: introduced in 1.8

See also:: hasFrame

Definition at line 184 of file qgscomposeritem.h.

void QgsComposerItem::setId ( const QString & id ) [inline]

Set item identification name.

Note:: this method was added in version 1.7 This method was moved from qgscomposerlabel so that every object can have a id (NathanW)

Definition at line 251 of file qgscomposeritem.h.

void QgsComposerItem::setItemPosition	(	double	x,
		double	y,
		ItemPositionMode	itemPoint = `UpperLeft`
	)

Moves the item to a new position (in canvas coordinates)

Definition at line 664 of file qgscomposeritem.cpp.

Referenced by QgsComposition::addItemsFromXML().

void QgsComposerItem::setItemPosition	(	double	x,
		double	y,
		double	width,
		double	height,
		ItemPositionMode	itemPoint = `UpperLeft`
	)

Sets item position and width / height in one go.

Note:: : this method was added in version 1.6

Definition at line 671 of file qgscomposeritem.cpp.

References LowerLeft, LowerMiddle, LowerRight, Middle, MiddleLeft, MiddleRight, setSceneRect(), UpperMiddle, and UpperRight.

void QgsComposerItem::setPositionLock ( bool lock ) [inline]

Locks / unlocks the item position for mouse drags.

Note:: this method was added in version 1.2

Definition at line 228 of file qgscomposeritem.h.

Referenced by QgsComposerView::mousePressEvent().

void QgsComposerItem::setRotation ( double r ) [virtual, slot]

Reimplemented in QgsComposerShape, and QgsComposerPicture.

Definition at line 925 of file qgscomposeritem.cpp.

References mRotation, and rotationChanged().

Referenced by QgsComposerMap::setMapRotation().

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

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

Reimplemented in QgsComposerMap, QgsComposerAttributeTable, QgsComposerShape, QgsComposerPicture, QgsComposerArrow, and QgsComposerItemGroup.

Definition at line 699 of file qgscomposeritem.cpp.

Referenced by _readXML(), QgsComposerTable::adaptItemFrame(), QgsComposerLegend::adjustBoxSize(), QgsComposerScaleBar::adjustBoxSize(), QgsComposerLabel::adjustSizeToText(), changeItemRectangle(), QgsComposerView::mousePressEvent(), move(), QgsComposerLegend::paintAndDetermineSize(), and setItemPosition().

void QgsComposerItem::setSelected ( bool s ) [virtual]

Set selected, selected item should be highlighted.

Definition at line 94 of file qgscomposeritem.cpp.

References QgsDebugMsg.

Referenced by QgsComposition::addComposerArrow(), QgsComposition::addComposerLabel(), QgsComposition::addComposerLegend(), QgsComposition::addComposerMap(), QgsComposition::addComposerPicture(), QgsComposition::addComposerScaleBar(), QgsComposition::addComposerShape(), QgsComposition::addComposerTable(), QgsComposerItemGroup::addItem(), QgsComposerView::groupItems(), QgsComposerView::mousePressEvent(), and QgsComposition::sendItemAddedSignal().

void QgsComposerItem::sizeChangedByRotation	(	double &	width,
		double &	height
	)		`[protected]`

Calculates width / height of the bounding box of a rotated rectangle (mRotation)

Definition at line 1059 of file qgscomposeritem.cpp.

References mRotation, and rotate().

Referenced by QgsComposerPicture::setRotation(), and QgsComposerShape::setRotation().

double QgsComposerItem::textWidthMillimeters	(	const QFont &	font,
		const QString &	text
	)		const

Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.

Definition at line 816 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

Referenced by QgsComposerLabel::adjustSizeToText(), QgsNumericScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::calculateBoxSize(), QgsComposerTable::calculateMaxColumnWidths(), QgsComposerMap::drawCoordinateAnnotation(), QgsComposerLegend::drawGroupItem(), QgsScaleBarStyle::drawLabels(), QgsComposerLegend::drawLayerChildItems(), QgsComposerLegend::drawLayerItem(), QgsComposerMap::maxExtension(), QgsComposerScaleBar::paint(), and QgsComposerLegend::paintAndDetermineSize().

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

return correct graphics item type.

Added in v1.7

Reimplemented in QgsComposerMap, QgsComposerAttributeTable, QgsComposerScaleBar, QgsComposerLegend, QgsComposerShape, QgsComposerArrow, QgsComposerPicture, QgsComposerTable, QgsPaperItem, QgsComposerItemGroup, QgsComposerLabel, and QgsComposerTextTable.

Definition at line 101 of file qgscomposeritem.h.

void QgsComposerItem::updateCursor ( const QPointF & itemPos )

Update mouse cursor at (item) position.

Note:: this method was added in version 1.2

Definition at line 920 of file qgscomposeritem.cpp.

References cursorForPosition().

Referenced by QgsComposerView::mousePressEvent().

virtual void QgsComposerItem::updateItem ( ) [inline, virtual]

Updates item, with the possibility to do custom update for subclasses.

Reimplemented in QgsComposerMap.

Definition at line 241 of file qgscomposeritem.h.

Referenced by changeItemRectangle().

bool QgsComposerItem::writeSettings ( void ) [virtual]

stores state in project

Definition at line 101 of file qgscomposeritem.cpp.

virtual bool QgsComposerItem::writeXML	(	QDomElement &	elem,
		QDomDocument &	doc
	)		const `[pure virtual]`

stores state in Dom element

Parameters:

elem	is Dom element corresponding to 'Composer' tag
doc	is the Dom document

Implemented in QgsComposerMap, QgsComposerScaleBar, QgsComposerLegend, QgsComposerLabel, QgsComposerArrow, QgsComposerAttributeTable, QgsComposerPicture, QgsComposerItemGroup, QgsComposerShape, QgsPaperItem, QgsComposerTable, and QgsComposerTextTable.

Referenced by QgsComposerItemCommand::saveState().

virtual void QgsComposerItem::zoomContent	(	int	delta,
		double	x,
		double	y
	)		`[inline, virtual]`

Zoom content of item.

Does nothing per default (but implemented in composer map)

Parameters:

delta	value from wheel event that describes magnitude and direction (positive /negative number)
x	x-position of mouse cursor (in item coordinates)
y	y-position of mouse cursor (in item coordinates)

Reimplemented in QgsComposerMap.

Definition at line 130 of file qgscomposeritem.h.