QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Slots | Signals | Public Member Functions | Private Slots | Private Member Functions | Private Attributes | List of all members
QgsComposerPicture Class Reference

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

#include <qgscomposerpicture.h>

Inheritance diagram for QgsComposerPicture:
Inheritance graph
[legend]
Collaboration diagram for QgsComposerPicture:
Collaboration graph
[legend]

Public Types

enum  ResizeMode {
  Zoom, Stretch, Clip, ZoomResizeFrame,
  FrameToImageSize
}
enum  Mode { SVG, RASTER, Unknown }
- 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
}
- Public Types inherited from QgsComposerObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, BlendMode,
  MapRotation, MapScale, MapXMin, MapYMin,
  MapXMax, MapYMax, 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 picture rotation within the item bounds.
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 setUsePictureExpression (bool useExpression)
 Sets whether the picture should use an expression based image source path.
virtual void setPictureExpression (QString expression)
 Sets an expression to use for the picture source.
void refreshPicture ()
 Recalculates the source image (if using an expression for picture's source) and reloads and redraws the picture.
Q_DECL_DEPRECATED void updatePictureExpression ()
 Prepares the picture's source expression after it is altered or the compositions atlas coverage layer changes.
void recalculateSize ()
 Forces a recalculation of the picture's frame size.
virtual void refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties)
- Public Slots inherited from QgsComposerItem
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 pictureRotationChanged (double newRotation)
 Is emitted on picture rotation change.
- Signals inherited from QgsComposerItem
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

 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.
Q_DECL_DEPRECATED void setPictureFile (const QString &path)
 Sets the source file of the image (may be svg or a raster format).
Q_DECL_DEPRECATED QString pictureFile () const
 Returns the path of the source image file.
void setPicturePath (const QString &path)
 Sets the source path of the image (may be svg or a raster format).
QString picturePath () const
 Returns the path of the source image.
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.
Q_DECL_DEPRECATED 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's frame.
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 picture rotation is matched to a map item.
ResizeMode resizeMode () const
 Returns the resize mode used for drawing the picture within the composer item's frame.
void setPictureAnchor (QgsComposerItem::ItemPositionMode anchor)
 Sets the picture's anchor point, which controls how it is placed within the picture item's frame.
ItemPositionMode pictureAnchor () const
 Returns the picture's current anchor, which controls how it is placed within the picture item's frame.
Q_DECL_DEPRECATED bool usePictureExpression () const
 Returns whether the picture item is using an expression for the image source.
Q_DECL_DEPRECATED QString pictureExpression () const
 Returns the expression the item is using for the picture source.
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 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)
 Calculates width / height of the bounding box of a rotated rectangle.
Mode mode () const
 Returns the current picture mode (image format).
- 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 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 void zoomContent (int delta, double x, double y)
 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.
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 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.
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 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 QgsCompositioncomposition () const
 Returns the composition the item is attached to.
QgsCompositioncomposition ()
QgsDataDefineddataDefinedProperty (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.

Private Slots

void remotePictureLoaded ()

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.
void loadPicture (const QString &path)
 loads an image file into the picture item and redraws the item
void init ()
 sets up the picture item and connects to relevant signals
QRect clippedImageRect (double &boundRectWidthMM, double &boundRectHeightMM, QSize imageRectPixels)
 Returns part of a raster image which will be shown, given current picture anchor settings.
void loadRemotePicture (const QString &url)
 Loads a remote picture for the item.
void loadLocalPicture (const QString &path)
 Loads a local picture for the item.

Private Attributes

QImage mImage
QSvgRenderer mSVG
QString mSourcePath
Mode mMode
QSize mDefaultSvgSize
double mPictureRotation
 Image rotation.
const QgsComposerMapmRotationMap
 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)
ResizeMode mResizeMode
QgsComposerItem::ItemPositionMode mPictureAnchor
bool mHasExpressionError
bool mLoaded

Additional Inherited Members

- Protected Member Functions inherited from QgsComposerItem
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 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 void sizeChangedByRotation (double &width, double &height, double rotation)
 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)
 Update an item rect to consider data defined position and size of item.
- Protected Attributes inherited from QgsComposerItem
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
QgsComposerEffectmEffect
int mTransparency
 Item transparency.
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.

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

Format of source image

Enumerator:
SVG 
RASTER 
Unknown 

Definition at line 49 of file qgscomposerpicture.h.

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.

References init(), and mPictureWidth.

QgsComposerPicture::~QgsComposerPicture ( )

Definition at line 87 of file qgscomposerpicture.cpp.

QgsComposerPicture::QgsComposerPicture ( )
private

Definition at line 53 of file qgscomposerpicture.cpp.

References init(), and 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 423 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 440 of file qgscomposerpicture.cpp.

References mDefaultSvgSize.

QRect QgsComposerPicture::clippedImageRect ( double &  boundRectWidthMM,
double &  boundRectHeightMM,
QSize  imageRectPixels 
)
private
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 799 of file qgscomposerpicture.cpp.

References mPictureRotation, Q_NOWARN_DEPRECATED_POP, and Q_NOWARN_DEPRECATED_PUSH.

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

References mPictureRotation, Q_NOWARN_DEPRECATED_POP, and Q_NOWARN_DEPRECATED_PUSH.

void QgsComposerPicture::init ( )
private
void QgsComposerPicture::loadLocalPicture ( const QString &  path)
private

Loads a local picture for the item.

Definition at line 337 of file qgscomposerpicture.cpp.

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

Referenced by loadPicture().

void QgsComposerPicture::loadPicture ( const QString &  path)
private

loads an image file into the picture item and redraws the item

Definition at line 388 of file qgscomposerpicture.cpp.

References QgsComposerObject::itemChanged(), loadLocalPicture(), loadRemotePicture(), mDefaultSvgSize, mHasExpressionError, mMode, mSVG, recalculateSize(), SVG, and Unknown.

Referenced by refreshPicture().

void QgsComposerPicture::loadRemotePicture ( const QString &  url)
private

Loads a remote picture for the item.

Definition at line 308 of file qgscomposerpicture.cpp.

References QgsNetworkContentFetcher::fetchContent(), mImage, mLoaded, mMode, RASTER, remotePictureLoaded(), QgsNetworkContentFetcher::reply(), and Unknown.

Referenced by loadPicture().

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.

Referenced by setResizeMode().

void QgsComposerPicture::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
)
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 786 of file qgscomposerpicture.cpp.

References QgsComposerObject::dataDefinedProperty(), QgsDataDefined::expressionString(), and QgsComposerObject::PictureSource.

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

References picturePath().

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

References mSourcePath.

Referenced by pictureFile().

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.

Referenced by setPictureRotation(), and setRotationMap().

QSizeF QgsComposerPicture::pictureSize ( )
private

Returns size of current raster or svg picture.

Definition at line 457 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
void QgsComposerPicture::recalculateSize ( )
slot

Forces a recalculation of the picture's frame size.

Note
added in 2.3

Definition at line 611 of file qgscomposerpicture.cpp.

References setSceneRect().

Referenced by init(), loadPicture(), and setResizeMode().

void QgsComposerPicture::refreshDataDefinedProperty ( const QgsComposerObject::DataDefinedProperty  property = QgsComposerObject::AllProperties)
virtualslot
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 283 of file qgscomposerpicture.cpp.

References QgsComposerObject::dataDefinedEvaluate(), QgsComposerObject::dataDefinedProperty(), loadPicture(), QgsMessageLog::logMessage(), mHasExpressionError, mSourcePath, QgsComposerObject::PictureSource, QgsDebugMsg, and tr.

Referenced by init(), readXML(), refreshDataDefinedProperty(), setPictureExpression(), setPicturePath(), and setUsePictureExpression().

void QgsComposerPicture::remotePictureLoaded ( )
privateslot

Definition at line 383 of file qgscomposerpicture.cpp.

References mLoaded.

Referenced by loadRemotePicture().

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

References QgsComposerMap::id(), and mRotationMap.

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
anchoranchor point for picture
Note
added in 2.3
See Also
pictureAnchor

Definition at line 775 of file qgscomposerpicture.cpp.

References mPictureAnchor.

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
expressionto use for picture path
Note
added in 2.3
See Also
setUsePictureExpression
pictureExpression
Deprecated:
use QgsComposerObject::dataDefinedProperty( QgsComposerObject::PictureSource ) instead

Definition at line 634 of file qgscomposerpicture.cpp.

References QgsComposerObject::dataDefinedProperty(), QgsComposerObject::PictureSource, refreshPicture(), and QgsDataDefined::setExpressionString().

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
pathfull path to the source image
See Also
usePictureExpression
pictureFile
Deprecated:
use setPicturePath instead

Definition at line 278 of file qgscomposerpicture.cpp.

References setPicturePath().

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
pathpath for the source image
See Also
usePictureExpression
picturePath
Note
added in QGIS 2.5

Definition at line 645 of file qgscomposerpicture.cpp.

References mSourcePath, and refreshPicture().

Referenced by setPictureFile().

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
rrotation in degrees clockwise
See Also
pictureRotation
Note
added in 2.2

Definition at line 553 of file qgscomposerpicture.cpp.

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

Referenced by setRotation(), and setRotationMap().

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

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

Parameters
modeResizeMode to use for image file
Note
added in 2.3
See Also
resizeMode

Definition at line 599 of file qgscomposerpicture.cpp.

References FrameToImageSize, mode(), mPictureRotation, mResizeMode, recalculateSize(), Zoom, and ZoomResizeFrame.

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 547 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. 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
composerMapIdcomposer map id to sync rotation with
See Also
setPictureRotation
rotationMap

Definition at line 570 of file qgscomposerpicture.cpp.

References QgsComposition::getComposerMapById(), QgsComposerMap::mapRotation(), QgsComposerObject::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 492 of file qgscomposerpicture.cpp.

References Clip, FrameToImageSize, QgsComposerObject::itemChanged(), QgsComposerItem::largestRotatedRectWithinBounds(), QgsComposerObject::mComposition, mPictureHeight, mPictureRotation, mPictureWidth, mResizeMode, pictureSize(), QgsComposition::printResolution(), Zoom, and ZoomResizeFrame.

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

void QgsComposerPicture::setUsePictureExpression ( bool  useExpression)
virtualslot

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

Parameters
useExpressionset 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 628 of file qgscomposerpicture.cpp.

References QgsComposerObject::dataDefinedProperty(), QgsComposerObject::PictureSource, refreshPicture(), and QgsDataDefined::setActive().

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

References mPictureRotation, Q_NOWARN_DEPRECATED_POP, and Q_NOWARN_DEPRECATED_PUSH.

virtual int QgsComposerPicture::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 60 of file qgscomposerpicture.h.

References QgsComposerItem::ComposerPicture.

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

References QgsComposerObject::dataDefinedProperty(), QgsDataDefined::isActive(), and QgsComposerObject::PictureSource.

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
virtual

Stores state in Dom element.

Parameters
elemis Dom element corresponding to 'Composer' tag
docis Dom document

Reimplemented from QgsComposerObject.

Definition at line 656 of file qgscomposerpicture.cpp.

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

Member Data Documentation

QSize QgsComposerPicture::mDefaultSvgSize
private
bool QgsComposerPicture::mHasExpressionError
private

Definition at line 325 of file qgscomposerpicture.h.

Referenced by loadPicture(), and refreshPicture().

QImage QgsComposerPicture::mImage
private
bool QgsComposerPicture::mLoaded
private

Definition at line 326 of file qgscomposerpicture.h.

Referenced by loadRemotePicture(), and remotePictureLoaded().

Mode QgsComposerPicture::mMode
private
QgsComposerItem::ItemPositionMode QgsComposerPicture::mPictureAnchor
private

Definition at line 323 of file qgscomposerpicture.h.

Referenced by clippedImageRect(), paint(), readXML(), setPictureAnchor(), and writeXML().

double QgsComposerPicture::mPictureHeight
private

Height of the picture (in mm)

Definition at line 320 of file qgscomposerpicture.h.

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

double QgsComposerPicture::mPictureRotation
private
double QgsComposerPicture::mPictureWidth
private

Width of the picture (in mm)

Definition at line 318 of file qgscomposerpicture.h.

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

ResizeMode QgsComposerPicture::mResizeMode
private
const QgsComposerMap* QgsComposerPicture::mRotationMap
private

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

Definition at line 316 of file qgscomposerpicture.h.

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

QString QgsComposerPicture::mSourcePath
private

Definition at line 308 of file qgscomposerpicture.h.

Referenced by picturePath(), readXML(), refreshPicture(), setPicturePath(), and writeXML().

QSvgRenderer QgsComposerPicture::mSVG
private

Definition at line 307 of file qgscomposerpicture.h.

Referenced by loadLocalPicture(), loadPicture(), and paint().


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