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

#include <qgscomposerpicture.h>

Inheritance diagram for QgsComposerPicture:

Public Types
enum	Mode { SVG, RASTER, Unknown }
enum	ResizeMode { Zoom, Stretch, Clip, ZoomResizeFrame, FrameToImageSize }
Public Types inherited from QgsComposerItem
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...
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
void	recalculateSize ()
	Forces a recalculation of the picture's frame size.
virtual void	refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties) override
void	refreshPicture ()
	Recalculates the source image (if using an expression for picture's source) and reloads and redraws the picture.
virtual void	setPictureExpression (QString expression)
	Sets an expression to use for the picture source.
virtual void	setPictureRotation (double r)
	Sets the picture rotation within the item bounds.
virtual void	setResizeMode (ResizeMode mode)
	Sets the resize mode used for drawing the picture within the item bounds.
virtual void	setRotation (double r) override
	Sets the picture rotation within the item bounds.
virtual void	setUsePictureExpression (bool useExpression)
	Sets whether the picture should use an expression based image source path.
Q_DECL_DEPRECATED void	updatePictureExpression ()
	Prepares the picture's source expression after it is altered or the compositions atlas coverage layer changes.
Public Slots inherited from QgsComposerItem
virtual void	refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties) override
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.
void	repaint () override
virtual void	setItemRotation (const double r, const bool adjustPosition=false)
	Sets the item rotation.
virtual void	setRotation (double r)
	Sets the item rotation.
Public Slots inherited from QgsComposerObject
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.
virtual void	repaint ()
	Triggers a redraw for the item.

Signals
void	pictureRotationChanged (double newRotation)
	Is emitted on picture rotation change.
Signals inherited from QgsComposerItem
void	frameChanged ()
	Emitted if the item's frame style changes.
void	itemRotationChanged (double newRotation)
	Is emitted on item rotation change.
void	lockChanged ()
	Emitted if the item's lock status changes.
void	sizeChanged ()
	Emitted if the rectangle changes.
Signals inherited from QgsComposerObject
void	itemChanged ()
	Emitted when the item changes.

Public Member Functions
	QgsComposerPicture (QgsComposition *composition)
	~QgsComposerPicture ()
Q_DECL_DEPRECATED bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
	Calculates corner point after rotation and scaling.
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.
Mode	mode () const
	Returns the current picture mode (image format).
void	paint (QPainter painter, const QStyleOptionGraphicsItem itemStyle, QWidget *pWidget) override
	Reimplementation of QCanvasItem::paint.
ItemPositionMode	pictureAnchor () const
	Returns the picture's current anchor, which controls how it is placed within the picture item's frame.
Q_DECL_DEPRECATED QString	pictureExpression () const
	Returns the expression the item is using for the picture source.
Q_DECL_DEPRECATED QString	pictureFile () const
	Returns the path of the source image file.
QString	picturePath () const
	Returns the path of the source image.
double	pictureRotation () const
	Returns the rotation used for drawing the picture within the item's frame.
bool	readXML (const QDomElement &itemElem, const QDomDocument &doc) override
	Sets state from Dom document.
ResizeMode	resizeMode () const
	Returns the resize mode used for drawing the picture within the composer item's frame.
Q_DECL_DEPRECATED double	rotation () const
	Returns the rotation used for drawing the picture within the composer item.
int	rotationMap () const
	Returns the id of the rotation map.
void	setPictureAnchor (QgsComposerItem::ItemPositionMode anchor)
	Sets the picture's anchor point, which controls how it is placed within the picture item's frame.
Q_DECL_DEPRECATED void	setPictureFile (const QString &path)
	Sets the source file of the image (may be svg or a raster format).
void	setPicturePath (const QString &path)
	Sets the source path of the image (may be svg or a raster format).
void	setRotationMap (int composerMapId)
	Sets the map object for rotation (by id).
void	setSceneRect (const QRectF &rectangle) override
	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.
Q_DECL_DEPRECATED void	sizeChangedByRotation (double &width, double &height)
	Calculates width / height of the bounding box of a rotated rectangle.
virtual int	type () const override
	return correct graphics item type.
Q_DECL_DEPRECATED bool	usePictureExpression () const
	Returns whether the picture item is using an expression for the image source.
bool	useRotationMap () const
	True if the picture rotation is matched to a map item.
bool	writeXML (QDomElement &elem, QDomDocument &doc) const override
	Stores state in Dom element.
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 ()
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 ()
virtual QString	displayName () const
	Get item display name.
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.
bool	effectsEnabled () const
	Returns whether effects (eg blend modes) are enabled for the item.
void	endCommand ()
	Finish current command and push it onto the undo stack.
virtual void	endItemCommand ()
virtual double	estimatedFrameBleed () const
	Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.
bool	excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue)
	Returns whether the item should be excluded from composer exports and prints.
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	fontHeightCharacterMM (const QFont &font, const QChar &c) const
	Returns the font height of a character in millimeters.
Q_DECL_DEPRECATED double	fontHeightMillimeters (const QFont &font) const
	Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Qt::PenJoinStyle	frameJoinStyle () const
	Returns the join style used for drawing the item's frame.
QColor	frameOutlineColor () const
	Returns the frame's outline color.
double	frameOutlineWidth () const
	Returns the frame's outline width.
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)
bool	isGroupMember () const
	Returns whether this item is part of a group.
virtual bool	isRemoved () const
	Returns whether this item has been removed from the composition.
double	itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
	Returns the current rotation for the composer item.
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.
virtual int	numberExportLayers () const
	Get the number of layers that this item requires for exporting as layers.
int	page () const
	Gets the page the item is currently on.
QPointF	pagePos () const
	Returns the item's position relative to its current page.
Q_DECL_DEPRECATED double	pixelFontSize (double pointSize) const
	Calculates font size in mm from a font point size.
bool	positionLock () const
	Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing.
virtual QRectF	rectWithFrame () const
	Returns the item's rectangular bounds, including any bleed caused by the item's frame.
virtual void	removeItems ()
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.
virtual bool	selected () const
	Is selected.
void	setBackgroundColor (const QColor &backgroundColor)
	Sets the background color for this item.
void	setBackgroundEnabled (const bool drawBackground)
	Set whether this item has a Background drawn around it or not.
void	setBlendMode (const QPainter::CompositionMode blendMode)
	Sets the item's composition blending mode.
virtual void	setCurrentExportLayer (const int layerIdx=-1)
	Sets the current layer to draw for exporting.
void	setEffectsEnabled (const bool effectsEnabled)
	Sets whether effects (eg blend modes) are enabled for the item.
virtual void	setExcludeFromExports (const bool exclude)
	Sets whether the item should be excluded from composer exports and prints.
virtual void	setFrameEnabled (const bool drawFrame)
	Set whether this item has a frame drawn around it or not.
void	setFrameJoinStyle (const Qt::PenJoinStyle style)
	Sets join style used when drawing the item's frame.
virtual void	setFrameOutlineColor (const QColor &color)
	Sets frame outline color.
virtual void	setFrameOutlineWidth (const double outlineWidth)
	Sets frame outline width.
virtual void	setId (const QString &id)
	Set item's id (which is not necessarly unique)
void	setIsGroupMember (const bool isGroupMember)
	Sets whether this item is part of a group.
void	setIsRemoved (const bool removed)
	Sets whether this item has been removed from the composition.
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.
void	setPositionLock (const bool lock)
	Locks / unlocks the item position for mouse drags.
virtual void	setSelected (bool s)
	Set selected, selected item should be highlighted.
void	setTransparency (const int transparency)
	Sets the item's transparency.
virtual void	setVisibility (const bool visible)
	Sets visibility for item.
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.
int	transparency () const
	Returns the item's transparency.
virtual void	updateItem ()
	Updates item, with the possibility to do custom update for subclasses.
void	updatePagePos (double newPageWidth, double newPageHeight)
	Moves the item so that it retains its relative position on the page when the paper size changes.
QString	uuid () const
	Get item identification name.
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.
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 ()
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.

Additional Inherited Members
Protected Member Functions inherited from QgsComposerItem
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)
Q_DECL_DEPRECATED bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
	Calculates corner point after rotation and scaling.
void	deleteAlignItems ()
void	deleteHAlignSnapItem ()
void	deleteVAlignSnapItem ()
Q_DECL_DEPRECATED 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)
	Draws additional graphics on selected items.
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.
QGraphicsLineItem *	hAlignSnapItem ()
	Return horizontal align snap item.
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 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 double	lockSymbolSize () const
	Returns the size of the lock symbol depending on the composer zoom level and the item size.
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 void	rotate (double angle, double &x, double &y) const
	Rotates a point / vector.
bool	shouldDrawItem () const
	Returns whether the item should be drawn in the current context.
Q_DECL_DEPRECATED void	sizeChangedByRotation (double &width, double &height, double rotation)
	Calculates width / height of the bounding box of a rotated rectangle.
QGraphicsLineItem *	vAlignSnapItem ()
	Return vertical align snap item.
Protected Attributes inherited from QgsComposerItem
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.
int	mCurrentExportLayer
	The layer that needs to be exported.
QgsComposerItem::MouseMoveAction	mCurrentMouseMoveAction
QgsComposerEffect *	mEffect
bool	mEffectsEnabled
bool	mEvaluatedExcludeFromExports
	Temporary evaluated item exclusion.
double	mEvaluatedItemRotation
	Temporary evaluated item rotation in degrees, clockwise.
bool	mExcludeFromExports
	Whether item should be excluded in exports.
bool	mFrame
	True if item fram needs to be painted.
Qt::PenJoinStyle	mFrameJoinStyle
	Frame join style.
QGraphicsLineItem *	mHAlignSnapItem
bool	mIsGroupMember
	Whether or not this item is part of a group.
bool	mItemPositionLocked
	True if item position and size cannot be changed with mouse move.
double	mItemRotation
	Item rotation in degrees, clockwise.
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)
bool	mRemovedFromComposition
	True if item has been removed from the composition.
int	mTransparency
	Item transparency.
QGraphicsLineItem *	mVAlignSnapItem

Detailed Description

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

Definition at line 31 of file qgscomposerpicture.h.

Member Enumeration Documentation

enum QgsComposerPicture::Mode

Format of source image

Enumerator:

SVG
RASTER
Unknown

Definition at line 49 of file qgscomposerpicture.h.

enum QgsComposerPicture::ResizeMode

Controls how pictures are scaled within the item's frame

Enumerator:

Zoom	enlarges image to fit frame while maintaining aspect ratio of picture
Stretch	stretches image to fit frame, ignores aspect ratio
Clip	draws image at original size and clips any portion which falls outside frame
ZoomResizeFrame	enlarges image to fit frame, then resizes frame to fit resultant image
FrameToImageSize	sets size of frame to match original size of image without scaling

Definition at line 38 of file qgscomposerpicture.h.

Constructor & Destructor Documentation

QgsComposerPicture::QgsComposerPicture ( QgsComposition * composition )

Definition at line 40 of file qgscomposerpicture.cpp.

QgsComposerPicture::~QgsComposerPicture ( )

Definition at line 87 of file qgscomposerpicture.cpp.

Member Function Documentation

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 845 of file qgscomposerpicture.cpp.

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 837 of file qgscomposerpicture.cpp.

Mode QgsComposerPicture::mode ( ) const

inline

Returns the current picture mode (image format).

Returns: picture mode

Note: added in 2.3

Definition at line 225 of file qgscomposerpicture.h.

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

override

Reimplementation of QCanvasItem::paint.

Definition at line 92 of file qgscomposerpicture.cpp.

ItemPositionMode QgsComposerPicture::pictureAnchor ( ) const

inline

Returns the picture's current anchor, which controls how it is placed within the picture item's frame.

Returns: anchor point for picture

Note: added in 2.3

See Also: setPictureAnchor

Definition at line 180 of file qgscomposerpicture.h.

QString QgsComposerPicture::pictureExpression ( ) const

Returns the expression the item is using for the picture source.

This is only used if usePictureExpression() is true.

Returns: expression for the picture item's image path

Note: added in 2.3

See Also: setPictureExpression; usePictureExpression

Deprecated:: use QgsComposerObject::dataDefinedProperty( QgsComposerObject::PictureSource ) instead

Definition at line 832 of file qgscomposerpicture.cpp.

QString QgsComposerPicture::pictureFile ( ) const

Returns the path of the source image file.

Data defined picture source may override this value.

Returns: path to the source image

See Also: usePictureExpression; setPictureFile

Deprecated:: use picturePath instead

Definition at line 686 of file qgscomposerpicture.cpp.

QString QgsComposerPicture::picturePath ( ) const

Returns the path of the source image.

Data defined picture source may override this value. The path can either be a local path or a remote (http) path.

Returns: path for the source image

See Also: usePictureExpression; setPicturePath

Note: added in QGIS 2.5

Definition at line 697 of file qgscomposerpicture.cpp.

double QgsComposerPicture::pictureRotation ( ) const

inline

Returns the rotation used for drawing the picture within the item's frame.

Returns: picture rotation in degrees

Note: added in 2.2

See Also: setPictureRotation; rotationMap

Definition at line 130 of file qgscomposerpicture.h.

void QgsComposerPicture::pictureRotationChanged ( double newRotation )

signal

Is emitted on picture rotation change.

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

overridevirtual

Sets state from Dom document.

Parameters

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

Reimplemented from QgsComposerObject.

Definition at line 731 of file qgscomposerpicture.cpp.

void QgsComposerPicture::recalculateSize ( )

slot

Forces a recalculation of the picture's frame size.

Note: added in 2.3

Definition at line 657 of file qgscomposerpicture.cpp.

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

overridevirtualslot

Definition at line 664 of file qgscomposerpicture.cpp.

void QgsComposerPicture::refreshPicture ( )

slot

Recalculates the source image (if using an expression for picture's source) and reloads and redraws the picture.

Note: added in 2.3

Definition at line 296 of file qgscomposerpicture.cpp.

ResizeMode QgsComposerPicture::resizeMode ( ) const

inline

Returns the resize mode used for drawing the picture within the composer item's frame.

Returns: resize mode of picture

Note: added in 2.3

See Also: setResizeMode

Definition at line 164 of file qgscomposerpicture.h.

Q_DECL_DEPRECATED 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 122 of file qgscomposerpicture.h.

int QgsComposerPicture::rotationMap ( ) const

Returns the id of the rotation map.

A value of -1 means map rotation is disabled. If this is set then the picture is rotated by the same amount as the specified map object.

Returns: id of map object

See Also: setRotationMap; useRotationMap

Definition at line 809 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setPictureAnchor ( QgsComposerItem::ItemPositionMode anchor )

Sets the picture's anchor point, which controls how it is placed within the picture item's frame.

Parameters

anchor anchor point for picture

Note: added in 2.3

See Also: pictureAnchor

Definition at line 821 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setPictureExpression ( QString expression )

virtualslot

Sets an expression to use for the picture source.

This expression is only used if usePictureExpression() is true.

Parameters

expression to use for picture path

Note: added in 2.3

See Also: setUsePictureExpression; pictureExpression

Deprecated:: use QgsComposerObject::dataDefinedProperty( QgsComposerObject::PictureSource ) instead

Definition at line 680 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setPictureFile ( const QString & path )

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

Data defined picture source may override this value.

Parameters

path	full path to the source image

See Also: usePictureExpression; pictureFile

Deprecated:: use setPicturePath instead

Definition at line 291 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setPicturePath ( const QString & path )

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

Data defined picture source may override this value. The path can either be a local path or a remote (http) path.

Parameters

path	path for the source image

See Also: usePictureExpression; picturePath

Note: added in QGIS 2.5

Definition at line 691 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setPictureRotation ( double r )

virtualslot

Sets the picture rotation within the item bounds.

This does not affect the item's frame, only the way the picture is drawn within the item.

Parameters

r	rotation in degrees clockwise

See Also: pictureRotation

Note: added in 2.2

Definition at line 580 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setResizeMode ( QgsComposerPicture::ResizeMode mode )

virtualslot

Sets the resize mode used for drawing the picture within the item bounds.

Parameters

mode	ResizeMode to use for image file

Note: added in 2.3

See Also: resizeMode

Definition at line 645 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setRotation ( double r )

overridevirtualslot

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 574 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setRotationMap ( int composerMapId )

Sets the map object for rotation (by id).

A value of -1 disables the map rotation. If this is set then the picture will be rotated by the same amount as the specified map object. This is useful especially for syncing north arrows with a map item.

Parameters

composerMapId composer map id to sync rotation with

See Also: setPictureRotation; rotationMap

Definition at line 616 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setSceneRect ( const QRectF & rectangle )

overridevirtual

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 505 of file qgscomposerpicture.cpp.

void QgsComposerPicture::setUsePictureExpression ( bool useExpression )

virtualslot

Sets whether the picture should use an expression based image source path.

Parameters

useExpression set to true to use an expression based image source, set to false to use a single image source path

Note: added in 2.3

See Also: usePictureExpression; setPictureFile; setPictureExpression

Deprecated:: use QgsComposerObject::dataDefinedProperty( QgsComposerObject::PictureSource ) instead

Definition at line 674 of file qgscomposerpicture.cpp.

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 853 of file qgscomposerpicture.cpp.

virtual int QgsComposerPicture::type ( ) const

inlineoverridevirtual

return correct graphics item type.

Reimplemented from QgsComposerItem.

Definition at line 60 of file qgscomposerpicture.h.

Q_DECL_DEPRECATED void QgsComposerPicture::updatePictureExpression ( )

inlineslot

Prepares the picture's source expression after it is altered or the compositions atlas coverage layer changes.

Note: added in 2.3

Deprecated:: no longer required

Definition at line 281 of file qgscomposerpicture.h.

bool QgsComposerPicture::usePictureExpression ( ) const

Returns whether the picture item is using an expression for the image source.

Returns: true if the picture is using an expression for the source, false if it is using a single static file path for the source.

Note: added in 2.3

See Also: setUsePictureExpression; pictureFile; pictureExpression

Deprecated:: use QgsComposerObject::dataDefinedProperty( QgsComposerObject::PictureSource ) instead

Definition at line 827 of file qgscomposerpicture.cpp.

bool QgsComposerPicture::useRotationMap ( ) const

inline

True if the picture rotation is matched to a map item.

Returns: true if rotation map is in use

See Also: rotationMap; setRotationMap

Definition at line 156 of file qgscomposerpicture.h.

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

overridevirtual

Stores state in Dom element.

Parameters

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

Reimplemented from QgsComposerObject.

Definition at line 702 of file qgscomposerpicture.cpp.

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

/tmp/buildd/qgis-2.8.2+12wheezy/src/core/composer/qgscomposerpicture.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/core/composer/qgscomposerpicture.cpp

Public Types

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation