QgsComposerPicture Class Reference

A composer class that displays svg files or raster format (jpg, png, ...) More...

#include <qgscomposerpicture.h>

Inheritance diagram for QgsComposerPicture:

Collaboration diagram for QgsComposerPicture:

Public Slots
virtual void	setRotation (double r)
	Sets the picture rotation within the item bounds.
virtual void	setPictureRotation (double r)
	Sets the picture rotation within the item bounds.
Public Slots inherited from QgsComposerItem
virtual void	setRotation (double r)
	Sets the item rotation.
virtual void	setItemRotation (double r, bool adjustPosition=false)
	Sets the item rotation.
void	repaint ()

Signals
void	pictureRotationChanged (double newRotation)
	Is emitted on picture rotation change.
Signals inherited from QgsComposerItem
void	itemRotationChanged (double newRotation)
	Is emitted on item rotation change.
void	itemChanged ()
	Used e.g.
void	sizeChanged ()
	Emitted if the rectangle changes.
void	frameChanged ()
	Emitted if the item's frame style changes.

Public Member Functions
	QgsComposerPicture (QgsComposition *composition)
	~QgsComposerPicture ()
virtual int	type () const
	return correct graphics item type.
void	paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
	Reimplementation of QCanvasItem::paint.
void	setPictureFile (const QString &path)
	Sets the source file of the image (may be svg or a raster format)
QString	pictureFile () const
void	setSceneRect (const QRectF &rectangle)
	Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit and resizes the svg symbol / image.
bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	stores state in Dom element
bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	sets state from Dom document
double	rotation () const
	Returns the rotation used for drawing the picture within the composer item.
double	pictureRotation () const
	Returns the rotation used for drawing the picture within the item.
void	setRotationMap (int composerMapId)
	Sets the map object for rotation (by id).
int	rotationMap () const
	Returns the id of the rotation map.
bool	useRotationMap () const
	True if the rotation is taken from a map item.
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.
Public Member Functions inherited from QgsComposerItem
	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 void	setSelected (bool s)
	Set selected, selected item should be highlighted.
virtual bool	selected () const
	Is selected.
virtual bool	writeSettings ()
	stores state in project
virtual bool	readSettings ()
	read state from project
virtual bool	removeSettings ()
	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, bool posIncludesFrame=false)
	Sets item position and width / height in one go.
ItemPositionMode	lastUsedPositionMode ()
	Returns item's last used position mode.
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 (bool drawFrame)
	Set whether this item has a frame drawn around it or not.
virtual void	setFrameOutlineWidth (double outlineWidth)
	Sets frame outline width.
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 (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 (QPainter::CompositionMode blendMode)
	Sets the item's composition blending mode.
int	transparency () const
	Returns the item's transparency.
void	setTransparency (int transparency)
	Sets the item's transparency.
bool	effectsEnabled () const
	Returns true if effects (eg blend modes) are enabled for the item.
void	setEffectsEnabled (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 ()
const QgsComposition *	composition () const
QgsComposition *	composition ()
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 ()
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.
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	fontDescentMillimeters (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)
double	itemRotation () 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.

Private Types
enum	Mode { SVG, RASTER, Unknown }

Private Member Functions
	QgsComposerPicture ()
QRectF	boundedSVGRect (double deviceWidth, double deviceHeight)
	Calculates bounding rect for svg file (mSourcefile) such that aspect ratio is correct.
QRectF	boundedImageRect (double deviceWidth, double deviceHeight)
	Calculates bounding rect for image such that aspect ratio is correct.
QSizeF	pictureSize ()
	Returns size of current raster or svg picture.

Private Attributes
QImage	mImage
QSvgRenderer	mSVG
QFile	mSourceFile
Mode	mMode
QSize	mDefaultSvgSize
double	mPictureRotation
	Image rotation.
const QgsComposerMap *	mRotationMap
	Map that sets the rotation (or 0 if this picture uses map independent rotation)
double	mPictureWidth
	Width of the picture (in mm)
double	mPictureHeight
	Height of the picture (in mm)

Additional Inherited Members
Public Types inherited from QgsComposerItem
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 }
Protected Member Functions inherited from QgsComposerItem
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, double rotation) const
	Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation.
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.
bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
	Calculates corner point after rotation and scaling.
void	sizeChangedByRotation (double &width, double &height, double rotation)
	Calculates width / height of the bounding box of a rotated rectangle.
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 ()
Protected Attributes inherited from QgsComposerItem
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.
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.
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.
QPainter::CompositionMode	mBlendMode
	Composition blend mode for item.
bool	mEffectsEnabled
QgsComposerEffect *	mEffect
int	mTransparency
	Item transparency.
ItemPositionMode	mLastUsedPositionMode
	The item's position mode.

Detailed Description

A composer class that displays svg files or raster format (jpg, png, ...)

Definition at line 30 of file qgscomposerpicture.h.

Member Enumeration Documentation

enum QgsComposerPicture::Mode

private

Enumerator:

SVG
RASTER
Unknown

Definition at line 113 of file qgscomposerpicture.h.

Constructor & Destructor Documentation

QgsComposerPicture::QgsComposerPicture

(

QgsComposition *

composition

)

Definition at line 30 of file qgscomposerpicture.cpp.

References mPictureWidth.

QgsComposerPicture::~QgsComposerPicture

(

)

Definition at line 41 of file qgscomposerpicture.cpp.

QgsComposerPicture::QgsComposerPicture ( )

private

Definition at line 36 of file qgscomposerpicture.cpp.

References mPictureHeight.

Member Function Documentation

QRectF QgsComposerPicture::boundedImageRect ( double  deviceWidth, double  deviceHeight  )

private

Calculates bounding rect for image such that aspect ratio is correct.

Definition at line 136 of file qgscomposerpicture.cpp.

References mImage.

QRectF QgsComposerPicture::boundedSVGRect ( double  deviceWidth, double  deviceHeight  )

private

Calculates bounding rect for svg file (mSourcefile) such that aspect ratio is correct.

Definition at line 153 of file qgscomposerpicture.cpp.

References mDefaultSvgSize.

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

Calculates corner point after rotation and scaling.

Deprecated:

Use QgsComposerItem::cornerPointOnRotatedAndScaledRect( double& x, double& y, double width, double height, double rotation ) instead

Reimplemented from QgsComposerItem.

Definition at line 373 of file qgscomposerpicture.cpp.

References mPictureRotation.

bool QgsComposerPicture::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.

Deprecated:

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

Reimplemented from QgsComposerItem.

Definition at line 367 of file qgscomposerpicture.cpp.

References mPictureRotation.

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

Reimplementation of QCanvasItem::paint.

Definition at line 46 of file qgscomposerpicture.cpp.

References QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), QgsComposerItem::drawSelectionBoxes(), mImage, mMode, mPictureHeight, mPictureRotation, mPictureWidth, mSVG, RASTER, SVG, and Unknown.

QString QgsComposerPicture::pictureFile

(

)

const

Definition at line 267 of file qgscomposerpicture.cpp.

References mSourceFile.

double QgsComposerPicture::pictureRotation ( ) const

inline

Returns the rotation used for drawing the picture within the item.

Note

this function was added in version 2.1

Definition at line 70 of file qgscomposerpicture.h.

void QgsComposerPicture::pictureRotationChanged ( double  newRotation )

signal

Is emitted on picture rotation change.

Referenced by setPictureRotation(), and setRotationMap().

QSizeF QgsComposerPicture::pictureSize ( )

private

Returns size of current raster or svg picture.

Definition at line 170 of file qgscomposerpicture.cpp.

References mDefaultSvgSize, mImage, mMode, RASTER, and SVG.

Referenced by setPictureRotation(), and setSceneRect().

bool QgsComposerPicture::readXML ( const QDomElement &  itemElem, const QDomDocument &  doc  )

virtual

sets state from Dom document

Parameters

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

Implements QgsComposerItem.

Definition at line 299 of file qgscomposerpicture.cpp.

References QgsComposerItem::_readXML(), QgsComposition::getComposerMapById(), QgsProject::instance(), QgsComposerItem::itemChanged(), QgsComposerItem::mComposition, mDefaultSvgSize, mPictureHeight, mPictureRotation, mPictureWidth, mRotationMap, QgsProject::readPath(), setPictureFile(), and setRotation().

Referenced by QgsComposition::addItemsFromXML().

double QgsComposerPicture::rotation ( ) const

inline

Returns the rotation used for drawing the picture within the composer item.

Deprecated:

Use pictureRotation() instead

Reimplemented from QgsComposerItem.

Definition at line 66 of file qgscomposerpicture.h.

int QgsComposerPicture::rotationMap

(

)

const

Returns the id of the rotation map.

Definition at line 355 of file qgscomposerpicture.cpp.

References QgsComposerMap::id(), and mRotationMap.

void QgsComposerPicture::setPictureFile

(

const QString &

path

)

Sets the source file of the image (may be svg or a raster format)

Definition at line 89 of file qgscomposerpicture.cpp.

References QgsComposerItem::itemChanged(), mDefaultSvgSize, mImage, mMode, mSourceFile, mSVG, RASTER, setSceneRect(), SVG, and Unknown.

Referenced by readXML().

void QgsComposerPicture::setPictureRotation ( double  r )

virtualslot

Sets the picture rotation within the item bounds.

This does not affect the item rectangle, only the way the picture is drawn within the item.

Note

this function was added in version 2.1

Definition at line 224 of file qgscomposerpicture.cpp.

References QgsComposerItem::largestRotatedRectWithinBounds(), mPictureHeight, mPictureRotation, mPictureWidth, pictureRotationChanged(), and pictureSize().

Referenced by setRotation(), and setRotationMap().

void QgsComposerPicture::setRotation ( double  r )

virtualslot

Sets the picture rotation within the item bounds.

This does not affect the item rectangle, only the way the picture is drawn within the item.

Deprecated:

Use setPictureRotation( double rotation ) instead

Definition at line 218 of file qgscomposerpicture.cpp.

References setPictureRotation().

Referenced by readXML().

void QgsComposerPicture::setRotationMap

(

int

composerMapId

)

Sets the map object for rotation (by id).

A value of -1 disables the map rotation

Definition at line 238 of file qgscomposerpicture.cpp.

References QgsComposition::getComposerMapById(), QgsComposerMap::mapRotation(), QgsComposerItem::mComposition, mPictureRotation, mRotationMap, pictureRotationChanged(), and setPictureRotation().

void QgsComposerPicture::setSceneRect ( const QRectF &  rectangle )

virtual

Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit and resizes the svg symbol / image.

Reimplemented from QgsComposerItem.

Definition at line 205 of file qgscomposerpicture.cpp.

References QgsComposerItem::itemChanged(), QgsComposerItem::largestRotatedRectWithinBounds(), mPictureHeight, mPictureRotation, mPictureWidth, and pictureSize().

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

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

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

Deprecated:

Use QgsComposerItem::sizeChangedByRotation( double& width, double& height, double rotation ) instead

Reimplemented from QgsComposerItem.

Definition at line 379 of file qgscomposerpicture.cpp.

References mPictureRotation.

virtual int QgsComposerPicture::type ( ) const

inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 38 of file qgscomposerpicture.h.

References QgsComposerItem::ComposerPicture.

bool QgsComposerPicture::useRotationMap ( ) const

inline

True if the rotation is taken from a map item.

Definition at line 77 of file qgscomposerpicture.h.

bool QgsComposerPicture::writeXML ( QDomElement &  elem, QDomDocument &  doc  ) const

virtual

stores state in Dom element

Parameters

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

Implements QgsComposerItem.

Definition at line 272 of file qgscomposerpicture.cpp.

References QgsComposerItem::_writeXML(), QgsComposerMap::id(), QgsProject::instance(), mPictureHeight, mPictureRotation, mPictureWidth, mRotationMap, and mSourceFile.

Member Data Documentation

QSize QgsComposerPicture::mDefaultSvgSize

private

Definition at line 135 of file qgscomposerpicture.h.

Referenced by boundedSVGRect(), pictureSize(), readXML(), and setPictureFile().

QImage QgsComposerPicture::mImage

private

Definition at line 130 of file qgscomposerpicture.h.

Referenced by boundedImageRect(), paint(), pictureSize(), and setPictureFile().

Mode QgsComposerPicture::mMode

private

Definition at line 133 of file qgscomposerpicture.h.

Referenced by paint(), pictureSize(), and setPictureFile().

double QgsComposerPicture::mPictureHeight

private

Height of the picture (in mm)

Definition at line 144 of file qgscomposerpicture.h.

Referenced by paint(), QgsComposerPicture(), readXML(), setPictureRotation(), setSceneRect(), and writeXML().

double QgsComposerPicture::mPictureRotation

private

Image rotation.

Definition at line 138 of file qgscomposerpicture.h.

Referenced by cornerPointOnRotatedAndScaledRect(), imageSizeConsideringRotation(), paint(), readXML(), setPictureRotation(), setRotationMap(), setSceneRect(), sizeChangedByRotation(), and writeXML().

double QgsComposerPicture::mPictureWidth

private

Width of the picture (in mm)

Definition at line 142 of file qgscomposerpicture.h.

Referenced by paint(), QgsComposerPicture(), readXML(), setPictureRotation(), setSceneRect(), and writeXML().

const QgsComposerMap* QgsComposerPicture::mRotationMap

private

Map that sets the rotation (or 0 if this picture uses map independent rotation)

Definition at line 140 of file qgscomposerpicture.h.

Referenced by readXML(), rotationMap(), setRotationMap(), and writeXML().

QFile QgsComposerPicture::mSourceFile

private

Definition at line 132 of file qgscomposerpicture.h.

Referenced by pictureFile(), setPictureFile(), and writeXML().

QSvgRenderer QgsComposerPicture::mSVG

private

Definition at line 131 of file qgscomposerpicture.h.

Referenced by paint(), and setPictureFile().

---

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

• /tmp/buildd/qgis-2.2.0+wheezy1/src/core/composer/qgscomposerpicture.h
• /tmp/buildd/qgis-2.2.0+wheezy1/src/core/composer/qgscomposerpicture.cpp