Quantum GIS API Documentation  1.7.5-Wroclaw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Slots | Public Member Functions | Private Types | Private Member Functions | Private Attributes
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]

List of all members.

Public Slots

virtual void setRotation (double r)
 Sets the rotation and adapts the item rect.
- Public Slots inherited from QgsComposerItem
void repaint ()

Public Member Functions

 QgsComposerPicture (QgsComposition *composition)
 ~QgsComposerPicture ()
virtual int type () const
 return correct graphics item type.
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint.
void setPictureFile (const QString &path)
 Sets the source file of the image (may be svg or a raster format)
QString pictureFile () const
void setSceneRect (const QRectF &rectangle)
 Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit and resizes the svg symbol / image.
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 stores state in Dom element
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document
void setRotationMap (int composerMapId)
 Sets the map object for rotation (by id).
int rotationMap () const
 Returns the id of the rotation map.
bool useRotationMap () const
 True if the rotation is taken from a map item.
- Public Member Functions inherited from QgsComposerItem
 QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
 Constructor.
 QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
 Constructor with box position and composer object.
virtual ~QgsComposerItem ()
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted.
virtual bool selected (void)
 Is selected.
virtual bool writeSettings (void)
 stores state in project
virtual bool readSettings (void)
 read state from project
virtual bool removeSettings (void)
 delete settings from project file
void move (double dx, double dy)
 Moves item in canvas coordinates.
virtual void moveContent (double dx, double dy)
 Move Content of item.
virtual void zoomContent (int delta, double x, double y)
 Zoom content of item.
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft)
 Moves the item to a new position (in canvas coordinates)
void setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft)
 Sets item position and width / height in one go.
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 frame () const
void setFrame (bool drawFrame)
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default.
virtual void removeItems ()
const QgsCompositioncomposition () const
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command.
void endCommand ()
 Finish current command and push it onto the undo stack.
void cancelCommand ()
void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const
 Draws Text.
void drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignement=Qt::AlignLeft, Qt::AlignmentFlag valignement=Qt::AlignTop) const
 Like the above, but with a rectangle for multiline text.
double textWidthMillimeters (const QFont &font, const QString &text) const
 Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters.
double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double pixelFontSize (double pointSize) const
 Calculates font to from point size to pixel size.
QFont scaledFontPixelSize (const QFont &font) const
 Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.
void setPositionLock (bool lock)
 Locks / unlocks the item position for mouse drags.
bool positionLock () const
 Returns position lock for mouse drags (true means locked)
void updateCursor (const QPointF &itemPos)
 Update mouse cursor at (item) position.
double rotation () const

Private Types

enum  Mode { SVG, RASTER, Unknown }

Private Member Functions

 QgsComposerPicture ()
QRectF boundedSVGRect (double deviceWidth, double deviceHeight)
 Calculates bounding rect for svg file (mSourcefile) such that aspect ratio is correct.
QRectF boundedImageRect (double deviceWidth, double deviceHeight)
 Calculates bounding rect for image such that aspect ratio is correct.

Private Attributes

QImage mImage
QSvgRenderer mSVG
QFile mSourceFile
Mode mMode
QSize mDefaultSvgSize
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)

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
}
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
}
- Signals inherited from QgsComposerItem
void rotationChanged (double newRotation)
 Is emitted on rotation change to notify north arrow pictures.
void itemChanged ()
 Used e.g.
- Protected Member Functions inherited from QgsComposerItem
virtual void mouseMoveEvent (QGraphicsSceneMouseEvent *event)
virtual void mousePressEvent (QGraphicsSceneMouseEvent *event)
virtual void mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
virtual void hoverMoveEvent (QGraphicsSceneHoverEvent *event)
Qt::CursorShape cursorForPosition (const QPointF &itemCoordPos)
 Finds out the appropriate cursor for the current mouse position in the widget (e.g.
QgsComposerItem::MouseMoveAction mouseMoveActionForPosition (const QPointF &itemCoordPos)
 Finds out which mouse move action to choose depending on the cursor position inside the widget.
void changeItemRectangle (const QPointF &currentPosition, const QPointF &mouseMoveStartPos, const QGraphicsRectItem *originalItem, double dx, double dy, QGraphicsRectItem *changeItem)
 Changes the rectangle of an item depending on current mouse action (resize or move)
virtual void drawSelectionBoxes (QPainter *p)
 Draw selection boxes around item.
virtual void drawFrame (QPainter *p)
 Draw black frame around item.
virtual void drawBackground (QPainter *p)
 Draw background.
void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead.
double angle (const QPointF &p1, const QPointF &p2) const
 Returns angle of the line from p1 to p2 (clockwise, starting at N)
double rectHandlerBorderTolerance () const
 Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the \ item border for resizing.
double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size.
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view.
bool imageSizeConsideringRotation (double &width, double &height) const
 Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation.
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling.
QPointF pointOnLineWithDistance (const QPointF &startPoint, const QPointF &directionPoint, double distance) const
 Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point.
void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle (mRotation)
void rotate (double angle, double &x, double &y) const
 Rotates a point / vector.
- Protected Attributes inherited from QgsComposerItem
QgsCompositionmComposition
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.
bool mFrame
 True if item fram needs to be painted.
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 mRotation
 Item rotation in degrees, clockwise.

Detailed Description

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

Definition at line 28 of file qgscomposerpicture.h.


Member Enumeration Documentation

Enumerator:
SVG 
RASTER 
Unknown 

Definition at line 74 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 42 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 147 of file qgscomposerpicture.cpp.

References mImage.

Referenced by paint().

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

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

Definition at line 164 of file qgscomposerpicture.cpp.

References mDefaultSvgSize.

Referenced by paint().

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

Definition at line 257 of file qgscomposerpicture.cpp.

References mSourceFile.

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

Returns the id of the rotation map.

Definition at line 329 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 100 of file qgscomposerpicture.cpp.

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

Referenced by readXML().

void QgsComposerPicture::setRotation ( double  r)
virtualslot

Sets the rotation and adapts the item rect.

Reimplemented from QgsComposerItem.

Definition at line 214 of file qgscomposerpicture.cpp.

References mPictureHeight, mPictureWidth, setSceneRect(), and QgsComposerItem::sizeChangedByRotation().

Referenced by readXML(), and setRotationMap().

void QgsComposerPicture::setRotationMap ( int  composerMapId)

Sets the map object for rotation (by id).

A value of -1 disables the map rotation

Definition at line 229 of file qgscomposerpicture.cpp.

References QgsComposition::getComposerMapById(), QgsComposerItem::mComposition, QgsComposerItem::mRotation, mRotationMap, QgsComposerItem::rotation(), QgsComposerItem::rotationChanged(), and setRotation().

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

References QgsComposerItem::imageSizeConsideringRotation(), QgsComposerItem::itemChanged(), mPictureHeight, and mPictureWidth.

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

virtual int QgsComposerPicture::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 36 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 66 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 262 of file qgscomposerpicture.cpp.

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


Member Data Documentation

QSize QgsComposerPicture::mDefaultSvgSize
private

Definition at line 94 of file qgscomposerpicture.h.

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

QImage QgsComposerPicture::mImage
private

Definition at line 89 of file qgscomposerpicture.h.

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

Mode QgsComposerPicture::mMode
private

Definition at line 92 of file qgscomposerpicture.h.

Referenced by paint(), and setPictureFile().

double QgsComposerPicture::mPictureHeight
private

Height of the picture (in mm)

Definition at line 100 of file qgscomposerpicture.h.

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

double QgsComposerPicture::mPictureWidth
private

Width of the picture (in mm)

Definition at line 98 of file qgscomposerpicture.h.

Referenced by paint(), QgsComposerPicture(), readXML(), setRotation(), 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 96 of file qgscomposerpicture.h.

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

QFile QgsComposerPicture::mSourceFile
private

Definition at line 91 of file qgscomposerpicture.h.

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

QSvgRenderer QgsComposerPicture::mSVG
private

Definition at line 90 of file qgscomposerpicture.h.

Referenced by paint(), and setPictureFile().


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