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

#include <qgscomposeritem.h>

Inheritance diagram for QgsComposerItem:

Collaboration diagram for QgsComposerItem:

Public Types
enum	ItemPositionMode { UpperLeft, UpperMiddle, UpperRight, MiddleLeft, Middle, MiddleRight, LowerLeft, LowerMiddle, LowerRight }
enum	ItemType { ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel, ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture, ComposerScaleBar, ComposerShape, ComposerTable, ComposerAttributeTable, ComposerTextTable, ComposerFrame }
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...
Public Slots
void	repaint ()
virtual void	setRotation (double r)
Signals
void	itemChanged ()
	Used e.g.
void	rotationChanged (double newRotation)
	Is emitted on rotation change to notify north arrow pictures.
void	sizeChanged ()
	Emitted if the rectangle changes.
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 ()
bool	_readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Reads parameter that are not subclass specific in document.
bool	_writeXML (QDomElement &itemElem, QDomDocument &doc) const
	Writes parameter that are not subclass specific in document.
virtual void	addItem (QgsComposerItem *item)
	Composite operations for item groups do nothing per default.
QColor	backgroundColor () const
	Gets the background color for this item.
void	beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
	Starts new composer undo command.
virtual void	beginItemCommand (const QString &text)
QPainter::CompositionMode	blendMode () const
	Returns the item's composition blending mode.
void	cancelCommand ()
const QgsComposition *	composition () const
QgsComposition *	composition ()
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 halignment=Qt::AlignLeft, Qt::AlignmentFlag valignment=Qt::AlignTop) const
	Like the above, but with a rectangle for multiline text.
bool	effectsEnabled () const
	Returns true if effects (eg blend modes) are enabled for the item.
void	endCommand ()
	Finish current command and push it onto the undo stack.
virtual void	endItemCommand ()
double	fontAscentMillimeters (const QFont &font) const
	Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double	fontDescentMillimeters (const QFont &font) const
	Returns the font ascent 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.
bool	hasBackground () const
	Whether this item has a Background or not.
bool	hasFrame () const
	Whether this item has a frame or not.
QString	id () const
	Get item's id (which is not necessarly unique)
ItemPositionMode	lastUsedPositionMode ()
	Returns item's last used position mode.
void	move (double dx, double dy)
	Moves item in canvas coordinates.
virtual void	moveContent (double dx, double dy)
	Move Content of item.
double	pixelFontSize (double pointSize) const
	Calculates font to from point size to pixel size.
bool	positionLock () const
	Returns position lock for mouse drags (true means locked)
virtual bool	readSettings ()
	read state from project
virtual bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)=0
	sets state from Dom document
virtual void	removeItems ()
virtual bool	removeSettings ()
	delete settings from project file
double	rotation () const
QFont	scaledFontPixelSize (const QFont &font) const
	Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.
virtual bool	selected ()
	Is selected.
void	setBackgroundColor (const QColor &backgroundColor)
	Sets the background color for this item.
void	setBackgroundEnabled (bool drawBackground)
	Set whether this item has a Background drawn around it or not.
void	setBlendMode (QPainter::CompositionMode blendMode)
	Sets the item's composition blending mode.
void	setEffectsEnabled (bool effectsEnabled)
	Sets whether effects (eg blend modes) are enabled for the item.
void	setFrameEnabled (bool drawFrame)
	Set whether this item has a frame drawn around it or not.
virtual void	setId (const QString &id)
	Set item's id (which is not necessarly unique)
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.
void	setPositionLock (bool lock)
	Locks / unlocks the item position for mouse drags.
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 void	setSelected (bool s)
	Set selected, selected item should be highlighted.
void	setTransparency (int transparency)
	Sets the item's transparency.
double	textWidthMillimeters (const QFont &font, const QString &text) const
	Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
int	transparency () const
	Returns the item's transparency.
virtual int	type () const
	return correct graphics item type.
void	updateCursor (const QPointF &itemPos)
	Update mouse cursor at (item) position.
virtual void	updateItem ()
	Updates item, with the possibility to do custom update for subclasses.
QString	uuid () const
	Get item identification name.
virtual bool	writeSettings ()
	stores state in project
virtual bool	writeXML (QDomElement &elem, QDomDocument &doc) const =0
	stores state in Dom element
virtual void	zoomContent (int delta, double x, double y)
	Zoom content of item.
Protected Member Functions
double	angle (const QPointF &p1, const QPointF &p2) const
	Returns angle of the line from p1 to p2 (clockwise, starting at N)
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)
bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
	Calculates corner point after rotation and scaling.
Qt::CursorShape	cursorForPosition (const QPointF &itemCoordPos)
	Finds out the appropriate cursor for the current mouse position in the widget (e.g.
void	deleteAlignItems ()
void	deleteHAlignSnapItem ()
void	deleteVAlignSnapItem ()
void	drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
	Draws arrowhead.
virtual void	drawBackground (QPainter *p)
	Draw background.
virtual void	drawFrame (QPainter *p)
	Draw black frame around item.
virtual void	drawSelectionBoxes (QPainter *p)
	Draw selection boxes around item.
QGraphicsLineItem *	hAlignSnapItem ()
	Return horizontal align snap item.
double	horizontalViewScaleFactor () const
	Returns the zoom factor of the graphics view.
virtual void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)
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.
double	lockSymbolSize () const
	Returns the size of the lock symbol depending on the composer zoom level and the item size.
QgsComposerItem::MouseMoveAction	mouseMoveActionForPosition (const QPointF &itemCoordPos)
	Finds out which mouse move action to choose depending on the cursor position inside the widget.
virtual void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)
virtual void	mousePressEvent (QGraphicsSceneMouseEvent *event)
virtual void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
double	rectHandlerBorderTolerance () const
	Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing.
void	rotate (double angle, double &x, double &y) const
	Rotates a point / vector.
void	sizeChangedByRotation (double &width, double &height)
	Calculates width / height of the bounding box of a rotated rectangle (mRotation)
QGraphicsLineItem *	vAlignSnapItem ()
	Return vertical align snap item.
Protected Attributes
bool	mBackground
	True if item background needs to be painted.
QColor	mBackgroundColor
	Background color.
QPainter::CompositionMode	mBlendMode
	Composition blend mode for item.
QGraphicsRectItem *	mBoundingResizeRectangle
	Rectangle used during move and resize actions.
QgsComposition *	mComposition
QgsComposerItem::MouseMoveAction	mCurrentMouseMoveAction
QgsComposerEffect *	mEffect
bool	mEffectsEnabled
bool	mFrame
	True if item fram needs to be painted.
QGraphicsLineItem *	mHAlignSnapItem
bool	mItemPositionLocked
	True if item position and size cannot be changed with mouse move.
QPointF	mLastMouseEventPos
	Position of the last mouse move event (in scene coordinates)
ItemPositionMode	mLastUsedPositionMode
	The item's position mode.
double	mLastValidViewScaleFactor
	Backup to restore item appearance if no view scale factor is available.
QPointF	mMouseMoveStartPos
	Start point of the last mouse move action (in scene coordinates)
double	mRotation
	Item rotation in degrees, clockwise.
int	mTransparency
	Item transparency.
QGraphicsLineItem *	mVAlignSnapItem
Private Member Functions
void	init (bool manageZValue)
Private Attributes
QString	mId
QString	mUuid

Detailed Description

A item that forms part of a map composition.

Definition at line 35 of file qgscomposeritem.h.

Member Enumeration Documentation

enum QgsComposerItem::ItemPositionMode

Enumerator:

UpperLeft
UpperMiddle
UpperRight
MiddleLeft
Middle
MiddleRight
LowerLeft
LowerMiddle
LowerRight

Definition at line 76 of file qgscomposeritem.h.

enum QgsComposerItem::ItemType

Enumerator:

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

Definition at line 40 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 62 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 45 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 68 of file qgscomposeritem.cpp.

References init().

QgsComposerItem::~QgsComposerItem ( ) [virtual]

Definition at line 114 of file qgscomposeritem.cpp.

References deleteAlignItems(), mBoundingResizeRectangle, mComposition, mEffect, 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 221 of file qgscomposeritem.cpp.

References QgsMapRenderer::getCompositionMode(), mBackground, mFrame, mItemPositionLocked, mLastUsedPositionMode, mLastValidViewScaleFactor, mRotation, mUuid, positionLock(), setBackgroundColor(), setBlendMode(), setId(), setSceneRect(), setTransparency(), and UpperLeft.

Referenced by QgsComposerFrame::readXML(), 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 139 of file qgscomposeritem.cpp.

References QgsMapRenderer::getBlendModeEnum(), mBackground, mBlendMode, mFrame, mId, mItemPositionLocked, mLastUsedPositionMode, mLastValidViewScaleFactor, mRotation, mTransparency, and mUuid.

Referenced by QgsComposerTable::tableWriteXML(), QgsComposerTextTable::writeXML(), QgsComposerFrame::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 234 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 1033 of file qgscomposeritem.cpp.

References M_PI.

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

QColor QgsComposerItem::backgroundColor ( ) const [inline]

Gets the background color for this item.

Returns:: background color

Note:: introduced in 2.0

Definition at line 204 of file qgscomposeritem.h.

Referenced by QgsComposerMap::cache(), and setBackgroundColor().

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 345 of file qgscomposeritem.cpp.

References QgsComposition::beginCommand(), and mComposition.

Referenced by QgsComposerView::wheelEvent().

virtual void QgsComposerItem::beginItemCommand ( const QString & text ) [inline, virtual]

Reimplemented in QgsComposerFrame.

Definition at line 240 of file qgscomposeritem.h.

Referenced by mouseReleaseEvent(), and QgsComposition::removeComposerItem().

QPainter::CompositionMode QgsComposerItem::blendMode ( ) const [inline]

Returns the item's composition blending mode.

Definition at line 214 of file qgscomposeritem.h.

Referenced by setBlendMode(), QgsComposerMap::setGridBlendMode(), and QgsComposerMap::setOverviewBlendMode().

void QgsComposerItem::cancelCommand ( )

Definition at line 361 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 568 of file qgscomposeritem.cpp.

References QgsComposition::alignItem(), QgsComposition::alignmentSnap(), QgsComposition::alignPos(), deleteAlignItems(), deleteHAlignSnapItem(), deleteVAlignSnapItem(), hAlignSnapItem(), mComposition, mCurrentMouseMoveAction, MoveItem, NoAction, QgsComposition::numPages(), QgsComposition::paperHeight(), QgsComposition::paperWidth(), ResizeDown, ResizeLeft, ResizeLeftDown, ResizeLeftUp, ResizeRight, ResizeRightDown, ResizeRightUp, ResizeUp, setSceneRect(), QgsComposition::snapPointToGrid(), QgsComposition::spaceBetweenPages(), updateItem(), and vAlignSnapItem().

Referenced by mouseMoveEvent(), and mouseReleaseEvent().

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

Definition at line 237 of file qgscomposeritem.h.

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

QgsComposition* QgsComposerItem::composition ( ) [inline]

Definition at line 238 of file qgscomposeritem.h.

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

Calculates corner point after rotation and scaling.

Definition at line 1186 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 473 of file qgscomposeritem.cpp.

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

Referenced by hoverMoveEvent(), and updateCursor().

void QgsComposerItem::deleteAlignItems ( ) [protected]

Definition at line 1314 of file qgscomposeritem.cpp.

References deleteHAlignSnapItem(), and deleteVAlignSnapItem().

Referenced by changeItemRectangle(), mousePressEvent(), mouseReleaseEvent(), and ~QgsComposerItem().

void QgsComposerItem::deleteHAlignSnapItem ( ) [protected]

Definition at line 1294 of file qgscomposeritem.cpp.

References mHAlignSnapItem.

Referenced by changeItemRectangle(), and deleteAlignItems().

void QgsComposerItem::deleteVAlignSnapItem ( ) [protected]

Definition at line 1304 of file qgscomposeritem.cpp.

References mVAlignSnapItem.

Referenced by changeItemRectangle(), and deleteAlignItems().

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

Draws arrowhead.

Definition at line 955 of file qgscomposeritem.cpp.

References M_PI.

Referenced by QgsComposerArrow::drawHardcodedMarker().

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

Draw background.

Reimplemented in QgsComposerShape.

Definition at line 879 of file qgscomposeritem.cpp.

References mBackground.

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

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

Draw black frame around item.

Reimplemented in QgsComposerShape, and QgsComposerItemGroup.

Definition at line 791 of file qgscomposeritem.cpp.

References mFrame.

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

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

Draw selection boxes around item.

Definition at line 751 of file qgscomposeritem.cpp.

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

Referenced by QgsComposerFrame::paint(), QgsComposerTable::paint(), QgsComposerLabel::paint(), QgsComposerItemGroup::paint(), QgsComposerPicture::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 929 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

Referenced by QgsNumericScaleBarStyle::draw(), QgsComposerMap::drawAnnotation(), QgsComposerLegend::drawGroupItemTitle(), QgsScaleBarStyle::drawLabels(), QgsComposerLegend::drawLayerItemTitle(), QgsComposerLegend::drawSymbolItem(), QgsComposerLegend::drawTitle(), QgsComposerTable::paint(), and QgsComposerLabel::paint().

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

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

Definition at line 941 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

bool QgsComposerItem::effectsEnabled ( ) const [inline]

Returns true if effects (eg blend modes) are enabled for the item.

Note:: introduced in 2.0

Definition at line 227 of file qgscomposeritem.h.

Referenced by setEffectsEnabled().

void QgsComposerItem::endCommand ( )

Finish current command and push it onto the undo stack.

Definition at line 353 of file qgscomposeritem.cpp.

References QgsComposition::endCommand(), and mComposition.

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

Reimplemented in QgsComposerFrame.

Definition at line 247 of file qgscomposeritem.h.

Referenced by mouseReleaseEvent(), and QgsComposition::removeComposerItem().

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

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

Definition at line 1006 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::drawGroupItemTitle(), QgsComposerTable::drawHorizontalGridLines(), QgsScaleBarStyle::drawLabels(), QgsComposerLegend::drawLayerItemTitle(), QgsComposerLegend::drawTitle(), QgsComposerMap::maxExtension(), QgsComposerTable::paint(), and QgsComposerAttributeTable::setSceneRect().

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

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

Definition at line 1013 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

Referenced by QgsComposerLegend::drawTitle().

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 999 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

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

QGraphicsLineItem * QgsComposerItem::hAlignSnapItem ( ) [protected]

Return horizontal align snap item.

Creates a new graphics line if 0

Definition at line 1270 of file qgscomposeritem.cpp.

References mHAlignSnapItem.

Referenced by changeItemRectangle().

bool QgsComposerItem::hasBackground ( ) const [inline]

Whether this item has a Background or not.

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

Note:: introduced since 2.0

See also:: hasBackground

Definition at line 190 of file qgscomposeritem.h.

Referenced by QgsComposerMap::cache().

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

See also:: hasFrame

Definition at line 174 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 1051 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 917 of file qgscomposeritem.cpp.

References cursorForPosition().

QString QgsComposerItem::id ( ) const [inline]

Get item's id (which is not necessarly unique)

Note:: this method was added in version 1.7

Reimplemented in QgsComposerMap.

Definition at line 300 of file qgscomposeritem.h.

Referenced by QgsComposition::getComposerItemById(), and setId().

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 1122 of file qgscomposeritem.cpp.

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

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

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

Definition at line 94 of file qgscomposeritem.cpp.

References QgsComposition::addItemToZList(), mComposition, and mEffect.

Referenced by QgsComposerItem().

void QgsComposerItem::itemChanged ( ) [signal]

Used e.g.

by the item widgets to update the gui elements

ItemPositionMode QgsComposerItem::lastUsedPositionMode ( ) [inline]

Returns item's last used position mode.

Note:: : This property has no effect on actual's item position, which is always the top-left corner.; : this method was added in version 2.0

Definition at line 145 of file qgscomposeritem.h.

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 1088 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 499 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 369 of file qgscomposeritem.cpp.

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

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

Definition at line 391 of file qgscomposeritem.cpp.

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

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

Definition at line 431 of file qgscomposeritem.cpp.

References beginItemCommand(), changeItemRectangle(), deleteAlignItems(), endItemCommand(), mBoundingResizeRectangle, mCurrentMouseMoveAction, MathUtils::min(), mItemPositionLocked, mMouseMoveStartPos, MoveItem, and tr.

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

Moves item in canvas coordinates.

Definition at line 802 of file qgscomposeritem.cpp.

References setSceneRect().

Referenced by QgsComposition::addItemsFromXML(), and 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 127 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 1020 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 287 of file qgscomposeritem.h.

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

bool QgsComposerItem::readSettings ( void ) [virtual]

read state from project

Definition at line 135 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, QgsComposerPicture, QgsComposerShape, QgsComposerItemGroup, QgsComposerAttributeTable, QgsPaperItem, QgsComposerTable, QgsComposerFrame, 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 1070 of file qgscomposeritem.cpp.

References horizontalViewScaleFactor().

Referenced by drawSelectionBoxes(), and mouseMoveActionForPosition().

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

Reimplemented in QgsComposerItemGroup.

Definition at line 235 of file qgscomposeritem.h.

bool QgsComposerItem::removeSettings ( void ) [virtual]

delete settings from project file

Definition at line 137 of file qgscomposeritem.cpp.

void QgsComposerItem::repaint ( ) [slot]

Definition at line 1320 of file qgscomposeritem.cpp.

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

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 1260 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 293 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 1025 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and pixelFontSize().

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

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

Is selected.

Definition at line 110 of file qgscomposeritem.h.

void QgsComposerItem::setBackgroundColor ( const QColor & backgroundColor )

Sets the background color for this item.

Parameters:

backgroundColor new background color

Returns:: nothing

Note:: introduced in 2.0

Definition at line 890 of file qgscomposeritem.cpp.

References backgroundColor(), and mBackgroundColor.

Referenced by _readXML().

void QgsComposerItem::setBackgroundEnabled ( bool drawBackground ) [inline]

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

Parameters:

drawBackground draw Background

Returns:: nothing

Note:: introduced in 2.0

See also:: hasBackground

Definition at line 198 of file qgscomposeritem.h.

void QgsComposerItem::setBlendMode ( QPainter::CompositionMode blendMode )

Sets the item's composition blending mode.

Definition at line 896 of file qgscomposeritem.cpp.

References blendMode(), mBlendMode, mEffect, and QgsComposerEffect::setCompositionMode().

Referenced by _readXML().

void QgsComposerItem::setEffectsEnabled ( bool effectsEnabled )

Sets whether effects (eg blend modes) are enabled for the item.

Note:: introduced in 2.0

Definition at line 910 of file qgscomposeritem.cpp.

References effectsEnabled(), mEffect, and mEffectsEnabled.

Referenced by QgsComposition::setUseAdvancedEffects().

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 182 of file qgscomposeritem.h.

Referenced by QgsComposerShape::QgsComposerShape().

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

Set item's id (which is not necessarly unique)

Note:: this method was added in version 1.7

Definition at line 1325 of file qgscomposeritem.cpp.

References id(), and mId.

Referenced by _readXML().

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

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

Definition at line 809 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 816 of file qgscomposeritem.cpp.

References LowerLeft, LowerMiddle, LowerRight, Middle, MiddleLeft, MiddleRight, mLastUsedPositionMode, 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 283 of file qgscomposeritem.h.

Referenced by QgsComposerView::mousePressEvent().

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

Reimplemented in QgsComposerLabel, QgsComposerPicture, and QgsComposerShape.

Definition at line 1108 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, QgsComposerLabel, QgsComposerAttributeTable, QgsComposerShape, QgsComposerPicture, QgsComposerArrow, and QgsComposerItemGroup.

Definition at line 847 of file qgscomposeritem.cpp.

References sizeChanged().

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

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

Set selected, selected item should be highlighted.

Definition at line 126 of file qgscomposeritem.cpp.

References QgsDebugMsg.

Referenced by QgsComposition::addComposerArrow(), QgsComposition::addComposerHtmlFrame(), 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::setTransparency ( int transparency )

Sets the item's transparency.

Definition at line 903 of file qgscomposeritem.cpp.

References mTransparency, and transparency().

Referenced by _readXML().

void QgsComposerItem::sizeChanged ( ) [signal]

Emitted if the rectangle changes.

Referenced by setSceneRect().

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

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

Definition at line 1223 of file qgscomposeritem.cpp.

References mRotation, and rotate().

Referenced by QgsComposerLabel::adjustSizeToText(), QgsComposerShape::setRotation(), QgsComposerPicture::setRotation(), and QgsComposerLabel::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 992 of file qgscomposeritem.cpp.

References FONT_WORKAROUND_SCALE, and scaledFontPixelSize().

Referenced by QgsComposerLabel::adjustSizeToText(), QgsNumericScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::calculateBoxSize(), QgsComposerTable::calculateMaxColumnWidths(), QgsComposerMap::drawCoordinateAnnotation(), QgsComposerLegend::drawGroupItemTitle(), QgsScaleBarStyle::drawLabels(), QgsComposerLegend::drawLayerItemTitle(), QgsComposerLegend::drawSymbolItem(), QgsComposerLegend::drawTitle(), QgsComposerMap::maxExtension(), and QgsComposerScaleBar::paint().

int QgsComposerItem::transparency ( ) const [inline]

Returns the item's transparency.

Definition at line 220 of file qgscomposeritem.h.

Referenced by setTransparency().

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

return correct graphics item type.

Added in v1.7

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

Definition at line 104 of file qgscomposeritem.h.

Referenced by QgsComposition::nearestSnapLine(), QgsComposition::removeComposerItem(), and QgsComposition::writeXML().

void QgsComposerItem::updateCursor ( const QPointF & itemPos )

Update mouse cursor at (item) position.

Note:: this method was added in version 1.2

Definition at line 1103 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 296 of file qgscomposeritem.h.

Referenced by changeItemRectangle().

QString QgsComposerItem::uuid ( ) const [inline]

Get item identification name.

Note:: this method was added in version 2.0; there is not setter since one can't manually set the id

Definition at line 309 of file qgscomposeritem.h.

Referenced by QgsComposition::getComposerItemByUuid().

QGraphicsLineItem * QgsComposerItem::vAlignSnapItem ( ) [protected]

Return vertical align snap item.

Creates a new graphics line if 0

Definition at line 1282 of file qgscomposeritem.cpp.

References mVAlignSnapItem.

Referenced by changeItemRectangle().

bool QgsComposerItem::writeSettings ( void ) [virtual]

stores state in project

Definition at line 133 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, QgsComposerPicture, QgsComposerAttributeTable, QgsComposerShape, QgsComposerItemGroup, QgsPaperItem, QgsComposerTable, QgsComposerFrame, and QgsComposerTextTable.

Referenced by QgsComposerItemCommand::saveState(), and QgsComposition::writeXML().

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 133 of file qgscomposeritem.h.