QgsComposerItem Class Reference

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

#include <qgscomposeritem.h>

Inheritance diagram for QgsComposerItem:

Public Types
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...
enum	ItemPositionMode {   UpperLeft, UpperMiddle, UpperRight, MiddleLeft,   Middle, MiddleRight, LowerLeft, LowerMiddle,   LowerRight }
enum	ZoomMode { Zoom = 0, ZoomRecenter, ZoomToPoint, NoZoom }
	Modes for zooming item content. More...
Public Types inherited from QgsComposerObject
enum	DataDefinedProperty {   NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,   PaperWidth, PaperHeight, NumPages, PaperOrientation,   PageNumber, PositionX, PositionY, ItemWidth,   ItemHeight, ItemRotation, Transparency, BlendMode,   ExcludeFromExports, MapRotation, MapScale, MapXMin,   MapYMin, MapXMax, MapYMax, MapAtlasMargin,   PictureSource, SourceUrl }
	Data defined properties for different item types. More...
enum	PropertyValueType { EvaluatedValue = 0, OriginalValue }
	Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...

Public Slots
virtual void	setRotation (double r)
	Sets the item rotation.
virtual void	setItemRotation (const double r, const bool adjustPosition=false)
	Sets the item rotation.
void	repaint ()
virtual void	refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties)
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.
Public Slots inherited from QgsComposerObject
virtual void	repaint ()
	Triggers a redraw for the item.
virtual void	refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties)
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.

Signals
void	itemRotationChanged (double newRotation)
	Is emitted on item rotation change.
void	sizeChanged ()
	Emitted if the rectangle changes.
void	frameChanged ()
	Emitted if the item's frame style changes.
void	lockChanged ()
	Emitted if the item's lock status changes.
Signals inherited from QgsComposerObject
void	itemChanged ()
	Emitted when the item 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 ()
virtual int	type () const
	return correct graphics item type.
virtual bool	isRemoved () const
	Returns whether this item has been removed from the composition.
void	setIsRemoved (const bool removed)
	Sets whether this item has been removed from the composition.
virtual void	setSelected (bool s)
	Set selected, selected item should be highlighted.
virtual bool	selected () const
	Is selected.
void	move (double dx, double dy)
	Moves item in canvas coordinates.
virtual void	moveContent (double dx, double dy)
	Move Content of item.
virtual Q_DECL_DEPRECATED void	zoomContent (int delta, double x, double y)
	Zoom content of item.
virtual void	zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom)
	Zoom content of item.
int	page () const
	Gets the page the item is currently on.
QPointF	pagePos () const
	Returns the item's position relative to its current page.
void	updatePagePos (double newPageWidth, double newPageHeight)
	Moves the item so that it retains its relative position on the page when the paper size changes.
void	setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1)
	Moves the item to a new position (in canvas coordinates)
void	setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft, bool posIncludesFrame=false, int page=-1)
	Sets item position and width / height in one go.
ItemPositionMode	lastUsedPositionMode ()
	Returns item's last used position mode.
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.
bool	_writeXML (QDomElement &itemElem, QDomDocument &doc) const
	Writes parameter that are not subclass specific in document.
bool	_readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Reads parameter that are not subclass specific in document.
bool	hasFrame () const
	Whether this item has a frame or not.
void	setFrameEnabled (const bool drawFrame)
	Set whether this item has a frame drawn around it or not.
virtual void	setFrameOutlineColor (const QColor &color)
	Sets frame outline color.
QColor	frameOutlineColor () const
	Returns the frame's outline color.
virtual void	setFrameOutlineWidth (const double outlineWidth)
	Sets frame outline width.
double	frameOutlineWidth () const
	Returns the frame's outline width.
Qt::PenJoinStyle	frameJoinStyle () const
	Returns the join style used for drawing the item's frame.
void	setFrameJoinStyle (const Qt::PenJoinStyle style)
	Sets join style used when drawing the item's frame.
virtual double	estimatedFrameBleed () const
	Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.
virtual QRectF	rectWithFrame () const
	Returns the item's rectangular bounds, including any bleed caused by the item's frame.
bool	hasBackground () const
	Whether this item has a Background or not.
void	setBackgroundEnabled (const bool drawBackground)
	Set whether this item has a Background drawn around it or not.
QColor	backgroundColor () const
	Gets the background color for this item.
void	setBackgroundColor (const QColor &backgroundColor)
	Sets the background color for this item.
QPainter::CompositionMode	blendMode () const
	Returns the item's composition blending mode.
void	setBlendMode (const QPainter::CompositionMode blendMode)
	Sets the item's composition blending mode.
int	transparency () const
	Returns the item's transparency.
void	setTransparency (const int transparency)
	Sets the item's transparency.
bool	effectsEnabled () const
	Returns whether effects (eg blend modes) are enabled for the item.
void	setEffectsEnabled (const bool effectsEnabled)
	Sets whether effects (eg blend modes) are enabled for the item.
virtual void	addItem (QgsComposerItem *item)
	Composite operations for item groups do nothing per default.
virtual void	removeItems ()
virtual void	beginItemCommand (const QString &text)
void	beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
	Starts new composer undo command.
virtual void	endItemCommand ()
void	endCommand ()
	Finish current command and push it onto the undo stack.
void	cancelCommand ()
Q_DECL_DEPRECATED void	drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const
	Draws Text.
Q_DECL_DEPRECATED void	drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment=Qt::AlignLeft, Qt::AlignmentFlag valignment=Qt::AlignTop, int flags=Qt::TextWordWrap) const
	Like the above, but with a rectangle for multiline text.
Q_DECL_DEPRECATED double	textWidthMillimeters (const QFont &font, const QString &text) const
	Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Q_DECL_DEPRECATED double	fontHeightCharacterMM (const QFont &font, const QChar &c) const
	Returns the font height of a character in millimeters.
Q_DECL_DEPRECATED double	fontAscentMillimeters (const QFont &font) const
	Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Q_DECL_DEPRECATED double	fontDescentMillimeters (const QFont &font) const
	Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Q_DECL_DEPRECATED double	fontHeightMillimeters (const QFont &font) const
	Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Q_DECL_DEPRECATED double	pixelFontSize (double pointSize) const
	Calculates font size in mm from a font point size.
Q_DECL_DEPRECATED 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 (const bool lock)
	Locks / unlocks the item position for mouse drags.
bool	positionLock () const
	Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing.
double	itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
	Returns the current rotation for the composer item.
Q_DECL_DEPRECATED double	rotation () const
	Returns the rotation for the composer item.
virtual void	updateItem ()
	Updates item, with the possibility to do custom update for subclasses.
QString	id () const
	Get item's id (which is not necessarly unique)
virtual void	setId (const QString &id)
	Set item's id (which is not necessarly unique)
QString	uuid () const
	Get item identification name.
virtual QString	displayName () const
	Get item display name.
virtual void	setVisibility (const bool visible)
	Sets visibility for item.
bool	excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue)
	Returns whether the item should be excluded from composer exports and prints.
virtual void	setExcludeFromExports (const bool exclude)
	Sets whether the item should be excluded from composer exports and prints.
bool	isGroupMember () const
	Returns whether this item is part of a group.
void	setIsGroupMember (const bool isGroupMember)
	Sets whether this item is part of a group.
virtual int	numberExportLayers () const
	Get the number of layers that this item requires for exporting as layers.
virtual void	setCurrentExportLayer (const int layerIdx=-1)
	Sets the current layer to draw for exporting.
Public Member Functions inherited from QgsComposerObject
	QgsComposerObject (QgsComposition *composition)
	Constructor.
virtual	~QgsComposerObject ()
const QgsComposition *	composition () const
	Returns the composition the item is attached to.
QgsComposition *	composition ()
virtual bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	Stores item state in DOM element.
virtual bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Sets item state from DOM element.
QgsDataDefined *	dataDefinedProperty (const DataDefinedProperty property) const
	Returns a reference to the data defined settings for one of the item's data defined properties.
void	setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field)
	Sets parameters for a data defined property for the item.

Protected Member Functions
virtual void	drawSelectionBoxes (QPainter *p)
	Draws additional graphics on selected items.
virtual void	drawFrame (QPainter *p)
	Draw black frame around item.
virtual void	drawBackground (QPainter *p)
	Draw background.
Q_DECL_DEPRECATED void	drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
	Draws arrowhead.
Q_DECL_DEPRECATED 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.
Q_DECL_DEPRECATED 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.
Q_DECL_DEPRECATED bool	imageSizeConsideringRotation (double &width, double &height, double rotation) const
	Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation.
Q_DECL_DEPRECATED 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.
Q_DECL_DEPRECATED QRectF	largestRotatedRectWithinBounds (QRectF originalRect, QRectF boundsRect, double rotation) const
	Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by a specified amount.
Q_DECL_DEPRECATED bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
	Calculates corner point after rotation and scaling.
Q_DECL_DEPRECATED bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
	Calculates corner point after rotation and scaling.
Q_DECL_DEPRECATED void	sizeChangedByRotation (double &width, double &height, double rotation)
	Calculates width / height of the bounding box of a rotated rectangle.
Q_DECL_DEPRECATED void	sizeChangedByRotation (double &width, double &height)
	Calculates width / height of the bounding box of a rotated rectangle.
Q_DECL_DEPRECATED void	rotate (double angle, double &x, double &y) const
	Rotates a point / vector.
QGraphicsLineItem *	hAlignSnapItem ()
	Return horizontal align snap item.
void	deleteHAlignSnapItem ()
QGraphicsLineItem *	vAlignSnapItem ()
	Return vertical align snap item.
void	deleteVAlignSnapItem ()
void	deleteAlignItems ()
QRectF	evalItemRect (const QRectF &newRect, const bool resizeOnly=false)
	Evaluates an item's bounding rect to consider data defined position and size of item and reference point.
bool	shouldDrawItem () const
	Returns whether the item should be drawn in the current context.
Protected Member Functions inherited from QgsComposerObject
bool	dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
	Evaluate a data defined property and return the calculated value.

Protected Attributes
bool	mRemovedFromComposition
	True if item has been removed from the composition.
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.
QGraphicsLineItem *	mHAlignSnapItem
QGraphicsLineItem *	mVAlignSnapItem
bool	mFrame
	True if item fram needs to be painted.
bool	mBackground
	True if item background needs to be painted.
QColor	mBackgroundColor
	Background color.
Qt::PenJoinStyle	mFrameJoinStyle
	Frame join style.
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	mItemRotation
	Item rotation in degrees, clockwise.
double	mEvaluatedItemRotation
	Temporary evaluated item rotation in degrees, clockwise.
QPainter::CompositionMode	mBlendMode
	Composition blend mode for item.
bool	mEffectsEnabled
QgsComposerEffect *	mEffect
int	mTransparency
	Item transparency.
bool	mExcludeFromExports
	Whether item should be excluded in exports.
bool	mEvaluatedExcludeFromExports
	Temporary evaluated item exclusion.
ItemPositionMode	mLastUsedPositionMode
	The item's position mode.
bool	mIsGroupMember
	Whether or not this item is part of a group.
int	mCurrentExportLayer
	The layer that needs to be exported.
Protected Attributes inherited from QgsComposerObject
QgsComposition *	mComposition
QMap < QgsComposerObject::DataDefinedProperty, QString >	mDataDefinedNames
	Map of data defined properties for the item to string name to use when exporting item to xml.

Friends
class	QgsComposerItemGroup

Detailed Description

A item that forms part of a map composition.

Member Enumeration Documentation

enum QgsComposerItem::ItemPositionMode

Enumerator:

UpperLeft
UpperMiddle
UpperRight
MiddleLeft
Middle
MiddleRight
LowerLeft
LowerMiddle
LowerRight

enum QgsComposerItem::ItemType

Enumerator:

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

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

enum QgsComposerItem::ZoomMode

Modes for zooming item content.

Enumerator:

Zoom
ZoomRecenter
ZoomToPoint
NoZoom

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

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

QgsComposerItem::~QgsComposerItem ( )

virtual

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

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

Writes parameter that are not subclass specific in document.

Usually called from writeXML methods of subclasses

virtual void QgsComposerItem::addItem ( QgsComposerItem *  item )

inlinevirtual

Composite operations for item groups do nothing per default.

Reimplemented in QgsComposerItemGroup.

double QgsComposerItem::angle ( const QPointF &  p1, const QPointF &  p2  ) const

protected

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

Deprecated:

use QgsComposerUtils::angle instead

QColor QgsComposerItem::backgroundColor ( ) const

inline

Gets the background color for this item.

Returns

background color

Note

introduced in 2.0

See Also

setBackgroundColor

hasBackground

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

virtual void QgsComposerItem::beginItemCommand ( const QString &  text )

inlinevirtual

Reimplemented in QgsComposerFrame.

QPainter::CompositionMode QgsComposerItem::blendMode ( ) const

inline

Returns the item's composition blending mode.

Returns

item blending mode

See Also

setBlendMode

void QgsComposerItem::cancelCommand

(

)

bool QgsComposerItem::cornerPointOnRotatedAndScaledRect ( double &  x, double &  y, double  width, double  height, double  rotation  ) const

protected

Calculates corner point after rotation and scaling.

Deprecated:

will be removed in QGIS 3.0

bool QgsComposerItem::cornerPointOnRotatedAndScaledRect ( double &  x, double &  y, double  width, double  height  ) const

protected

Calculates corner point after rotation and scaling.

Deprecated:

will be removed in QGIS 3.0

Reimplemented in QgsComposerMap, and QgsComposerPicture.

void QgsComposerItem::deleteAlignItems ( )

protected

void QgsComposerItem::deleteHAlignSnapItem ( )

protected

void QgsComposerItem::deleteVAlignSnapItem ( )

protected

QString QgsComposerItem::displayName ( ) const

virtual

Get item display name.

This is the item's id if set, and if not, a user-friendly string identifying item type.

Returns

display name for item

See Also

id

setId

Note

added in version 2.5

Reimplemented in QgsComposerMap, QgsComposerLegend, QgsComposerLabel, QgsComposerShape, and QgsComposerFrame.

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

protected

Draws arrowhead.

Deprecated:

use QgsComposerUtils::drawArrowHead instead

void QgsComposerItem::drawBackground ( QPainter *  p )

protectedvirtual

Draw background.

Reimplemented in QgsComposerShape.

void QgsComposerItem::drawFrame ( QPainter *  p )

protectedvirtual

Draw black frame around item.

Reimplemented in QgsComposerShape, and QgsComposerItemGroup.

void QgsComposerItem::drawSelectionBoxes ( QPainter *  p )

protectedvirtual

Draws additional graphics on selected items.

The base implementation has no effect.

void QgsComposerItem::drawText	(	QPainter *	p,
		double	x,
		double	y,
		const QString &	text,
		const QFont &	font,
		const QColor &	c = QColor()
	)		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)

Deprecated:

use QgsComposerUtils::drawText instead

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

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

Parameters

p	painter to use
rect	rectangle to draw into
text	text to draw
font	font to use
halignment	optional horizontal alignment
valignment	optional vertical alignment
flags	allows for passing Qt::TextFlags to control appearance of rendered text

Deprecated:

use QgsComposerUtils::drawText instead

bool QgsComposerItem::effectsEnabled ( ) const

inline

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

Returns

true if effects are enabled

Note

introduced in 2.0

See Also

setEffectsEnabled

transparency

blendMode

void QgsComposerItem::endCommand

(

)

Finish current command and push it onto the undo stack.

virtual void QgsComposerItem::endItemCommand ( )

inlinevirtual

Reimplemented in QgsComposerFrame.

double QgsComposerItem::estimatedFrameBleed ( ) const

virtual

Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.

For instance, if the item has a 2mm frame outline, then 1mm of this frame is drawn outside the item's rect. In this case the return value will be 1.0

Note

introduced in 2.2

See Also

rectWithFrame

Reimplemented in QgsComposerShape.

QRectF QgsComposerItem::evalItemRect ( const QRectF &  newRect, const bool  resizeOnly = false  )

protected

Evaluates an item's bounding rect to consider data defined position and size of item and reference point.

Parameters

newRect	target bouding rect for item
resizeOnly	set to true if the item is only being resized. If true then the position of the returned rect will be adjusted to account for the item's position mode

Returns

bounding box rectangle for item after data defined size and position have been set and position mode has been accounted for

Note

added in QGIS 2.5

bool QgsComposerItem::excludeFromExports

(

const QgsComposerObject::PropertyValueType

valueType = QgsComposerObject::EvaluatedValue

)

Returns whether the item should be excluded from composer exports and prints.

Parameters

valueType

controls whether the returned value is the user specified vaule, or the current evaluated value (which may be affected by data driven settings).

Returns

true if item should be excluded

Note

added in version 2.5

See Also

setExcludeFromExports

double QgsComposerItem::fontAscentMillimeters

(

const QFont &

font

)

const

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

Deprecated:

use QgsComposerUtils::fontAscentMM instead

double QgsComposerItem::fontDescentMillimeters

(

const QFont &

font

)

const

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

Deprecated:

use QgsComposerUtils::fontDescentMM instead

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

Returns the font height of a character in millimeters.

Deprecated:

use QgsComposerUtils::fontHeightCharacterMM instead

double QgsComposerItem::fontHeightMillimeters

(

const QFont &

font

)

const

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

Font height equals the font ascent+descent+1 (for baseline).

Note

Added in version 2.4

Deprecated:

use QgsComposerUtils::fontHeightMM instead

void QgsComposerItem::frameChanged ( )

signal

Emitted if the item's frame style changes.

Note

: this function was introduced in version 2.2

Qt::PenJoinStyle QgsComposerItem::frameJoinStyle ( ) const

inline

Returns the join style used for drawing the item's frame.

Returns

Join style for outline frame

Note

introduced in 2.3

See Also

hasFrame

setFrameJoinStyle

frameOutlineWidth

frameOutlineColor

QColor QgsComposerItem::frameOutlineColor ( ) const

inline

Returns the frame's outline color.

Only used if hasFrame is true.

Returns

frame outline color

Note

introduced in 2.6

See Also

hasFrame

setFrameOutlineColor

frameJoinStyle

setFrameOutlineColor

double QgsComposerItem::frameOutlineWidth ( ) const

inline

Returns the frame's outline width.

Only used if hasFrame is true.

Returns

Frame outline width

Note

introduced in 2.3

See Also

hasFrame

setFrameOutlineWidth

frameJoinStyle

frameOutlineColor

QGraphicsLineItem * QgsComposerItem::hAlignSnapItem ( )

protected

Return horizontal align snap item.

Creates a new graphics line if 0

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

setBackgroundEnabled

backgroundColor

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

setFrameEnabled

frameOutlineWidth

frameJoinStyle

frameOutlineColor

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)

QString QgsComposerItem::id ( ) const

inline

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

Returns

item id

See Also

setId

Reimplemented in QgsComposerMap.

bool QgsComposerItem::imageSizeConsideringRotation ( double &  width, double &  height, double  rotation  ) const

protected

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

Deprecated:

will be removed in QGIS 3.0

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.

Deprecated:

will be removed in QGIS 3.0

Reimplemented in QgsComposerMap, and QgsComposerPicture.

bool QgsComposerItem::isGroupMember ( ) const

inline

Returns whether this item is part of a group.

Returns

true if item is in a group

Note

added in version 2.5

See Also

setIsGroupMember

virtual bool QgsComposerItem::isRemoved ( ) const

inlinevirtual

Returns whether this item has been removed from the composition.

Items removed from the composition are not deleted so that they can be restored via an undo command.

Returns

true if the item has been removed from the composition

Note

added in QGIS 2.5

See Also

setIsRemoved

double QgsComposerItem::itemRotation

(

const QgsComposerObject::PropertyValueType

valueType = QgsComposerObject::EvaluatedValue

)

const

Returns the current rotation for the composer item.

Returns

rotation for composer item

Parameters

valueType

controls whether the returned value is the user specified rotation, or the current evaluated rotation (which may be affected by data driven rotation settings).

Note

this method was added in version 2.1

See Also

setItemRotation

void QgsComposerItem::itemRotationChanged ( double  newRotation )

signal

Is emitted on item rotation change.

QRectF QgsComposerItem::largestRotatedRectWithinBounds ( QRectF  originalRect, QRectF  boundsRect, double  rotation  ) const

protected

Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by a specified amount.

Parameters

originalRect	QRectF to be rotated and scaled
boundsRect	QRectF specifying the bounds which the rotated and scaled rectangle must fit within
rotation	the rotation in degrees to be applied to the rectangle

Deprecated:

use QgsComposerUtils::largestRotatedRectWithinBounds instead

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.

void QgsComposerItem::lockChanged ( )

signal

Emitted if the item's lock status changes.

Note

: this function was introduced in version 2.5

double QgsComposerItem::lockSymbolSize ( ) const

protected

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

Deprecated:

will be removed in QGIS 3.0

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

Moves item in canvas coordinates.

virtual void QgsComposerItem::moveContent ( double  dx, double  dy  )

inlinevirtual

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.

virtual int QgsComposerItem::numberExportLayers ( ) const

inlinevirtual

Get the number of layers that this item requires for exporting as layers.

Returns

0 if this item is to be placed on the same layer as the previous item, 1 if it should be placed on its own layer, and >1 if it requires multiple export layers

Note

this method was added in version 2.4

See Also

setCurrentExportLayer

Reimplemented in QgsComposerMap.

int QgsComposerItem::page

(

)

const

Gets the page the item is currently on.

Returns

page number for item, beginning on page 1

See Also

pagePos

updatePagePos

Note

this method was added in version 2.4

QPointF QgsComposerItem::pagePos

(

)

const

Returns the item's position relative to its current page.

Returns

position relative to the page's top left corner.

See Also

page

updatePagePos

Note

this method was added in version 2.4

double QgsComposerItem::pixelFontSize

(

double

pointSize

)

const

Calculates font size in mm from a font point size.

Deprecated:

use QgsComposerUtils::mmFontSize instead

bool QgsComposerItem::positionLock ( ) const

inline

Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing.

See Also

setPositionLock

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.

QRectF QgsComposerItem::rectWithFrame ( ) const

virtual

Returns the item's rectangular bounds, including any bleed caused by the item's frame.

The bounds are returned in the item's coordinate system (see Qt's QGraphicsItem docs for more details about QGraphicsItem coordinate systems). The results differ from Qt's rect() function, as rect() makes no allowances for the portion of outlines which are drawn outside of the item.

Note

introduced in 2.2

See Also

estimatedFrameBleed

void QgsComposerItem::refreshDataDefinedProperty ( const QgsComposerObject::DataDefinedProperty  property = QgsComposerObject::AllProperties )

virtualslot

Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.

Parameters

property

data defined property to refresh. If property is set to QgsComposerItem::AllProperties then all data defined properties for the item will be refreshed.

Note

this method was added in version 2.5

virtual void QgsComposerItem::removeItems ( )

inlinevirtual

Reimplemented in QgsComposerItemGroup.

void QgsComposerItem::repaint ( )

slot

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

Deprecated:

use QgsComposerUtils:rotate instead

Q_DECL_DEPRECATED double QgsComposerItem::rotation ( ) const

inline

Returns the rotation for the composer item.

Deprecated:

Use itemRotation() instead

Reimplemented in QgsComposerMap, and QgsComposerPicture.

QFont QgsComposerItem::scaledFontPixelSize

(

const QFont &

font

)

const

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

Deprecated:

use QgsComposerUtils::scaledFontPixelSize instead

virtual bool QgsComposerItem::selected ( ) const

inlinevirtual

Is selected.

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

See Also

backgroundColor

setBackgroundEnabled

void QgsComposerItem::setBackgroundEnabled ( const 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

setBackgroundColor

void QgsComposerItem::setBlendMode

(

const QPainter::CompositionMode

blendMode

)

Sets the item's composition blending mode.

Parameters

blendMode

blending mode for item

See Also

blendMode

virtual void QgsComposerItem::setCurrentExportLayer ( const int  layerIdx = -1 )

inlinevirtual

Sets the current layer to draw for exporting.

Parameters

layerIdx

can be set to -1 to draw all item layers, and must be less than numberExportLayers()

Note

this method was added in version 2.4

See Also

numberExportLayers

void QgsComposerItem::setEffectsEnabled

(

const bool

effectsEnabled

)

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

Parameters

effectsEnabled

set to true to enable effects

Note

introduced in 2.0

See Also

effectsEnabled

setTransparency

setBlendMode

void QgsComposerItem::setExcludeFromExports ( const bool  exclude )

virtual

Sets whether the item should be excluded from composer exports and prints.

Parameters

exclude

set to true to exclude the item from exports

Note

added in version 2.5

See Also

excludeFromExports

void QgsComposerItem::setFrameEnabled

(

const bool

drawFrame

)

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

Parameters

drawFrame

draw frame

Note

introduced in 1.8

See Also

hasFrame

setFrameOutlineWidth

setFrameJoinStyle

setFrameOutlineColor

void QgsComposerItem::setFrameJoinStyle

(

const Qt::PenJoinStyle

style

)

Sets join style used when drawing the item's frame.

Parameters

style

Join style for outline frame

Note

introduced in 2.3

See Also

setFrameEnabled

frameJoinStyle

setFrameOutlineWidth

setFrameOutlineColor

void QgsComposerItem::setFrameOutlineColor ( const QColor &  color )

virtual

Sets frame outline color.

Parameters

color

new color for outline frame

Note

introduced in 2.6

See Also

frameOutlineColor

setFrameEnabled

setFrameJoinStyle

setFrameOutlineWidth

void QgsComposerItem::setFrameOutlineWidth ( const double  outlineWidth )

virtual

Sets frame outline width.

Parameters

outlineWidth

new width for outline frame

Note

introduced in 2.2

See Also

frameOutlineWidth

setFrameEnabled

setFrameJoinStyle

setFrameOutlineColor

Reimplemented in QgsComposerMap.

void QgsComposerItem::setId ( const QString &  id )

virtual

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

Parameters

id	new id for item

See Also

id

void QgsComposerItem::setIsGroupMember

(

const bool

isGroupMember

)

Sets whether this item is part of a group.

Parameters

isGroupMember

set to true if item is in a group

Note

added in version 2.5

See Also

isGroupMember

void QgsComposerItem::setIsRemoved ( const bool  removed )

inline

Sets whether this item has been removed from the composition.

Items removed from the composition are not deleted so that they can be restored via an undo command.

Parameters

removed

set to true if the item has been removed from the composition

Note

added in QGIS 2.5

See Also

isRemoved

void QgsComposerItem::setItemPosition	(	double	x,
		double	y,
		ItemPositionMode	itemPoint = UpperLeft,
		int	page = -1
	)

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

void QgsComposerItem::setItemPosition	(	double	x,
		double	y,
		double	width,
		double	height,
		ItemPositionMode	itemPoint = UpperLeft,
		bool	posIncludesFrame = false,
		int	page = -1
	)

Sets item position and width / height in one go.

Parameters

x	item position x
y	item position y
width	item width
height	item height
itemPoint	item position mode
posIncludesFrame	set to true if the position and size arguments include the item's frame border
page	if page > 0, y is interpreted as relative to the origin of the specified page, if page <= 0, y is in absolute canvas coordinates

void QgsComposerItem::setItemRotation ( const double  r, const bool  adjustPosition = false  )

virtualslot

Sets the item rotation.

Parameters

r	item rotation in degrees
adjustPosition	set to true if item should be shifted so that rotation occurs around item center. If false, rotation occurs around item origin

Note

this method was added in version 2.1

See Also

itemRotation

void QgsComposerItem::setPositionLock

(

const bool

lock

)

Locks / unlocks the item position for mouse drags.

Parameters

lock	set to true to prevent item movement and resizing via the mouse

See Also

positionLock

void QgsComposerItem::setRotation ( double  r )

virtualslot

Sets the item rotation.

Deprecated:

Use setItemRotation( double rotation ) instead

Reimplemented in QgsComposerMap.

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 QgsComposerScaleBar, QgsComposerAttributeTable, QgsComposerMap, QgsComposerPicture, QgsComposerShape, QgsPaperItem, QgsComposerArrow, QgsComposerFrame, and QgsComposerItemGroup.

void QgsComposerItem::setSelected ( bool  s )

virtual

Set selected, selected item should be highlighted.

void QgsComposerItem::setTransparency

(

const int

transparency

)

Sets the item's transparency.

Parameters

transparency

integer between 0 (transparent) and 255 (opaque)

See Also

transparency

void QgsComposerItem::setVisibility ( const bool  visible )

virtual

Sets visibility for item.

Parameters

visible

set to true to show item, false to hide item

Note

QGraphicsItem::setVisible should not be called directly on a QgsComposerItem, as some item types (eg groups) need to override the visibility toggle.

added in version 2.5

Reimplemented in QgsComposerItemGroup.

bool QgsComposerItem::shouldDrawItem ( ) const

protected

Returns whether the item should be drawn in the current context.

Returns

true if item should be drawn

Note

added in QGIS 2.5

void QgsComposerItem::sizeChanged ( )

signal

Emitted if the rectangle changes.

void QgsComposerItem::sizeChangedByRotation ( double &  width, double &  height, double  rotation  )

protected

Calculates width / height of the bounding box of a rotated rectangle.

Deprecated:

will be removed in QGIS 3.0

void QgsComposerItem::sizeChangedByRotation ( double &  width, double &  height  )

protected

Calculates width / height of the bounding box of a rotated rectangle.

Deprecated:

will be removed in QGIS 3.0

Reimplemented in QgsComposerMap, and QgsComposerPicture.

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

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

Deprecated:

use QgsComposerUtils::textWidthMM instead

int QgsComposerItem::transparency ( ) const

inline

Returns the item's transparency.

Returns

transparency as integer between 0 (transparent) and 255 (opaque)

See Also

setTransparency

virtual int QgsComposerItem::type ( ) const

inlinevirtual

return correct graphics item type.

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

virtual void QgsComposerItem::updateItem ( )

inlinevirtual

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

Reimplemented in QgsComposerMap.

void QgsComposerItem::updatePagePos	(	double	newPageWidth,
		double	newPageHeight
	)

Moves the item so that it retains its relative position on the page when the paper size changes.

Parameters

newPageWidth	new width of the page in mm
newPageHeight	new height of the page in mm

See Also

page

pagePos

Note

this method was added in version 2.4

QString QgsComposerItem::uuid ( ) const

inline

Get item identification name.

Returns

unique item identification string

Note

there is not setter since one can't manually set the id

See Also

id

setId

QGraphicsLineItem * QgsComposerItem::vAlignSnapItem ( )

protected

Return vertical align snap item.

Creates a new graphics line if 0

virtual Q_DECL_DEPRECATED void QgsComposerItem::zoomContent ( int  delta, double  x, double  y  )

inlinevirtual

Zoom content of item.

Does nothing per default (but implemented in composer map)

Parameters

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

Deprecated:

use zoomContent( double, QPointF, ZoomMode ) instead

Reimplemented in QgsComposerMap.

virtual void QgsComposerItem::zoomContent ( const double  factor, const QPointF  point, const ZoomMode  mode = QgsComposerItem::Zoom  )

inlinevirtual

Zoom content of item.

Does nothing per default (but implemented in composer map)

Parameters

factor	zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out
point	item point for zoom center
mode	zoom mode

Note

added in QGIS 2.5

Reimplemented in QgsComposerMap.

Friends And Related Function Documentation

friend class QgsComposerItemGroup

friend

Member Data Documentation

bool QgsComposerItem::mBackground

protected

True if item background needs to be painted.

QColor QgsComposerItem::mBackgroundColor

protected

Background color.

QPainter::CompositionMode QgsComposerItem::mBlendMode

protected

Composition blend mode for item.

QGraphicsRectItem* QgsComposerItem::mBoundingResizeRectangle

protected

Rectangle used during move and resize actions.

int QgsComposerItem::mCurrentExportLayer

protected

The layer that needs to be exported.

Note

: if -1, all layers are to be exported

: this member was added in version 2.4

QgsComposerItem::MouseMoveAction QgsComposerItem::mCurrentMouseMoveAction

protected

QgsComposerEffect* QgsComposerItem::mEffect

protected

bool QgsComposerItem::mEffectsEnabled

protected

bool QgsComposerItem::mEvaluatedExcludeFromExports

protected

Temporary evaluated item exclusion.

Data defined properties may mean this value differs from mExcludeFromExports.

double QgsComposerItem::mEvaluatedItemRotation

protected

Temporary evaluated item rotation in degrees, clockwise.

Data defined rotation may mean this value differs from mItemRotation.

bool QgsComposerItem::mExcludeFromExports

protected

Whether item should be excluded in exports.

bool QgsComposerItem::mFrame

protected

True if item fram needs to be painted.

Qt::PenJoinStyle QgsComposerItem::mFrameJoinStyle

protected

Frame join style.

QGraphicsLineItem* QgsComposerItem::mHAlignSnapItem

protected

bool QgsComposerItem::mIsGroupMember

protected

Whether or not this item is part of a group.

bool QgsComposerItem::mItemPositionLocked

protected

True if item position and size cannot be changed with mouse move.

double QgsComposerItem::mItemRotation

protected

Item rotation in degrees, clockwise.

QPointF QgsComposerItem::mLastMouseEventPos

protected

Position of the last mouse move event (in scene coordinates)

ItemPositionMode QgsComposerItem::mLastUsedPositionMode

protected

The item's position mode.

double QgsComposerItem::mLastValidViewScaleFactor

mutableprotected

Backup to restore item appearance if no view scale factor is available.

QPointF QgsComposerItem::mMouseMoveStartPos

protected

Start point of the last mouse move action (in scene coordinates)

bool QgsComposerItem::mRemovedFromComposition

protected

True if item has been removed from the composition.

int QgsComposerItem::mTransparency

protected

Item transparency.

QGraphicsLineItem* QgsComposerItem::mVAlignSnapItem

protected

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/composer/qgscomposeritem.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/composer/qgscomposeritem.cpp