QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Slots | Signals | Public Member Functions | Private Types | 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 Slots

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

Signals

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

Public Member Functions

 QgsComposerPicture (QgsComposition *composition)
 
 ~QgsComposerPicture ()
 
virtual int type () const
 return correct graphics item type. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint. More...
 
void setPictureFile (const QString &path)
 Sets the source file of the image (may be svg or a raster format) More...
 
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. More...
 
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 stores state in Dom element More...
 
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document More...
 
double rotation () const
 Returns the rotation used for drawing the picture within the composer item. More...
 
double pictureRotation () const
 Returns the rotation used for drawing the picture within the item. More...
 
void setRotationMap (int composerMapId)
 Sets the map object for rotation (by id). More...
 
int rotationMap () const
 Returns the id of the rotation map. More...
 
bool useRotationMap () const
 True if the rotation is taken from a map item. More...
 
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. More...
 
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling. More...
 
void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
- Public Member Functions inherited from QgsComposerItem
 QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
 Constructor. More...
 
 QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
 Constructor with box position and composer object. More...
 
virtual ~QgsComposerItem ()
 
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
virtual bool selected () const
 Is selected. More...
 
virtual bool writeSettings ()
 stores state in project More...
 
virtual bool readSettings ()
 read state from project More...
 
virtual bool removeSettings ()
 delete settings from project file More...
 
void move (double dx, double dy)
 Moves item in canvas coordinates. More...
 
virtual void moveContent (double dx, double dy)
 Move Content of item. More...
 
virtual void zoomContent (int delta, double x, double y)
 Zoom content of item. More...
 
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft)
 Moves the item to a new position (in canvas coordinates) More...
 
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. More...
 
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode. More...
 
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document. More...
 
bool _readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document. More...
 
bool hasFrame () const
 Whether this item has a frame or not. More...
 
void setFrameEnabled (bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
virtual void setFrameOutlineWidth (double outlineWidth)
 Sets frame outline width. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
void setFrameJoinStyle (Qt::PenJoinStyle style)
 Sets join style used when drawing the item's frame. More...
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
bool hasBackground () const
 Whether this item has a Background or not. More...
 
void setBackgroundEnabled (bool drawBackground)
 Set whether this item has a Background drawn around it or not. More...
 
QColor backgroundColor () const
 Gets the background color for this item. More...
 
void setBackgroundColor (const QColor &backgroundColor)
 Sets the background color for this item. More...
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void setBlendMode (QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
int transparency () const
 Returns the item's transparency. More...
 
void setTransparency (int transparency)
 Sets the item's transparency. More...
 
bool effectsEnabled () const
 Returns true if effects (eg blend modes) are enabled for the item. More...
 
void setEffectsEnabled (bool effectsEnabled)
 Sets whether effects (eg blend modes) are enabled for the item. More...
 
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default. More...
 
virtual void removeItems ()
 
const QgsCompositioncomposition () const
 
QgsCompositioncomposition ()
 
virtual void beginItemCommand (const QString &text)
 
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command. More...
 
virtual void endItemCommand ()
 
void endCommand ()
 Finish current command and push it onto the undo stack. More...
 
void cancelCommand ()
 
void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const
 Draws Text. More...
 
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. More...
 
double textWidthMillimeters (const QFont &font, const QString &text) const
 Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters. More...
 
double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
double fontDescentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
double pixelFontSize (double pointSize) const
 Calculates font to from point size to pixel size. More...
 
QFont scaledFontPixelSize (const QFont &font) const
 Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE. More...
 
void setPositionLock (bool lock)
 Locks / unlocks the item position for mouse drags. More...
 
bool positionLock () const
 Returns position lock for mouse drags (true means locked) More...
 
double itemRotation () const
 Returns the rotation for the composer item. More...
 
double rotation () const
 Returns the rotation for the composer item. More...
 
virtual void updateItem ()
 Updates item, with the possibility to do custom update for subclasses. More...
 
QString id () const
 Get item's id (which is not necessarly unique) More...
 
virtual void setId (const QString &id)
 Set item's id (which is not necessarly unique) More...
 
QString uuid () const
 Get item identification name. More...
 
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
virtual void setCurrentExportLayer (int layerIdx=-1)
 Sets the current layer to draw for exporting. More...
 

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. More...
 
QRectF boundedImageRect (double deviceWidth, double deviceHeight)
 Calculates bounding rect for image such that aspect ratio is correct. More...
 
QSizeF pictureSize ()
 Returns size of current raster or svg picture. More...
 

Private Attributes

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

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. More...
 
virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead. More...
 
double angle (const QPointF &p1, const QPointF &p2) const
 Returns angle of the line from p1 to p2 (clockwise, starting at N) More...
 
double rectHandlerBorderTolerance () const
 Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing. More...
 
double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size. More...
 
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view. More...
 
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. More...
 
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. More...
 
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. More...
 
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
 Calculates corner point after rotation and scaling. More...
 
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling. More...
 
void sizeChangedByRotation (double &width, double &height, double rotation)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
void rotate (double angle, double &x, double &y) const
 Rotates a point / vector. More...
 
QGraphicsLineItem * hAlignSnapItem ()
 Return horizontal align snap item. More...
 
void deleteHAlignSnapItem ()
 
QGraphicsLineItem * vAlignSnapItem ()
 Return vertical align snap item. More...
 
void deleteVAlignSnapItem ()
 
void deleteAlignItems ()
 
- Protected Attributes inherited from QgsComposerItem
QgsCompositionmComposition
 
QgsComposerItem::MouseMoveAction mCurrentMouseMoveAction
 
QPointF mMouseMoveStartPos
 Start point of the last mouse move action (in scene coordinates) More...
 
QPointF mLastMouseEventPos
 Position of the last mouse move event (in scene coordinates) More...
 
QGraphicsRectItem * mBoundingResizeRectangle
 Rectangle used during move and resize actions. More...
 
QGraphicsLineItem * mHAlignSnapItem
 
QGraphicsLineItem * mVAlignSnapItem
 
bool mFrame
 True if item fram needs to be painted. More...
 
bool mBackground
 True if item background needs to be painted. More...
 
QColor mBackgroundColor
 Background color. More...
 
Qt::PenJoinStyle mFrameJoinStyle
 Frame join style. More...
 
bool mItemPositionLocked
 True if item position and size cannot be changed with mouse move. More...
 
double mLastValidViewScaleFactor
 Backup to restore item appearance if no view scale factor is available. More...
 
double mItemRotation
 Item rotation in degrees, clockwise. More...
 
QPainter::CompositionMode mBlendMode
 Composition blend mode for item. More...
 
bool mEffectsEnabled
 
QgsComposerEffectmEffect
 
int mTransparency
 Item transparency. More...
 
ItemPositionMode mLastUsedPositionMode
 The item's position mode. More...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 

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

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

Definition at line 373 of file qgscomposerpicture.cpp.

References QgsComposerItem::cornerPointOnRotatedAndScaledRect(), and 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

Definition at line 367 of file qgscomposerpicture.cpp.

References QgsComposerItem::imageSizeConsideringRotation(), and mPictureRotation.

void QgsComposerPicture::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
)
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
double QgsComposerPicture::rotation ( ) const
inline

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

Deprecated:
Use pictureRotation() instead

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, pictureSize(), and QgsComposerItem::setSceneRect().

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

Definition at line 379 of file qgscomposerpicture.cpp.

References mPictureRotation, and QgsComposerItem::sizeChangedByRotation().

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
elemis Dom element corresponding to 'Composer' tag
docis 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
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: