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

A composer items that draws common shapes (ellipse, triangle, rectangle) More...

#include <qgscomposershape.h>

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

Public Types

enum  Shape { Ellipse, Rectangle, Triangle }
 
- 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 Slots

void refreshSymbol ()
 Should be called after the shape's symbol is changed. 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 ()
 

Public Member Functions

 QgsComposerShape (QgsComposition *composition)
 
 QgsComposerShape (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition)
 
 ~QgsComposerShape ()
 
virtual int type () const
 return correct graphics item type. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint - draw on canvas. 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...
 
QgsComposerShape::Shape shapeType () const
 
void setShapeType (QgsComposerShape::Shape s)
 
void setCornerRadius (double radius)
 Sets radius for rounded rectangle corners. More...
 
double cornerRadius () const
 Returns the radius for rounded rectangle corners. More...
 
void setShapeStyleSymbol (QgsFillSymbolV2 *symbol)
 Sets the QgsFillSymbolV2 used to draw the shape. More...
 
QgsFillSymbolV2shapeStyleSymbol ()
 Returns the QgsFillSymbolV2 used to draw the shape. More...
 
void setUseSymbolV2 (bool useSymbolV2)
 Controls whether the shape should be drawn using a QgsFillSymbolV2. More...
 
QRectF boundingRect () const
 Depending on the symbol style, the bounding rectangle can be larger than the shape. More...
 
void setSceneRect (const QRectF &rectangle)
 Sets new scene rectangle bounds and recalculates hight and extent. 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 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...
 

Protected Member Functions

virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
virtual double estimatedFrameBleed () const
 reimplement estimatedFrameBleed, since frames on shapes are drawn using symbology rather than the item's pen More...
 
- Protected Member Functions inherited from QgsComposerItem
virtual void drawSelectionBoxes (QPainter *p)
 Draw selection boxes around item. 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 ()
 

Private Member Functions

void drawShape (QPainter *p)
 
void drawShapeUsingSymbol (QPainter *p)
 
void createDefaultShapeStyleSymbol ()
 
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. More...
 
void updateBoundingRect ()
 Updates the bounding rect of this item. More...
 

Private Attributes

Shape mShape
 Ellipse, rectangle or triangle. More...
 
double mCornerRadius
 
bool mUseSymbolV2
 
QgsFillSymbolV2mShapeStyleSymbol
 
double mMaxSymbolBleed
 
QRectF mCurrentRectangle
 Current bounding rectangle of shape. More...
 

Additional Inherited Members

- 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...
 
- 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 items that draws common shapes (ellipse, triangle, rectangle)

Definition at line 28 of file qgscomposershape.h.

Member Enumeration Documentation

Enumerator
Ellipse 
Rectangle 
Triangle 

Definition at line 33 of file qgscomposershape.h.

Constructor & Destructor Documentation

QgsComposerShape::QgsComposerShape ( QgsComposition composition)
QgsComposerShape::QgsComposerShape ( qreal  x,
qreal  y,
qreal  width,
qreal  height,
QgsComposition composition 
)
QgsComposerShape::~QgsComposerShape ( )

Definition at line 48 of file qgscomposershape.cpp.

References mShapeStyleSymbol.

Member Function Documentation

QRectF QgsComposerShape::boundingRect ( ) const

Depending on the symbol style, the bounding rectangle can be larger than the shape.

Note
this function was added in version 2.3

Definition at line 337 of file qgscomposershape.cpp.

References mCurrentRectangle.

double QgsComposerShape::cornerRadius ( ) const
inline

Returns the radius for rounded rectangle corners.

Definition at line 69 of file qgscomposershape.h.

void QgsComposerShape::createDefaultShapeStyleSymbol ( )
private
void QgsComposerShape::drawBackground ( QPainter *  p)
protectedvirtual

Draw background.

Reimplemented from QgsComposerItem.

Definition at line 246 of file qgscomposershape.cpp.

References drawShape(), QgsComposerItem::mBackground, and mUseSymbolV2.

Referenced by paint().

void QgsComposerShape::drawFrame ( QPainter *  p)
protectedvirtual

Draw black frame around item.

Reimplemented from QgsComposerItem.

Definition at line 235 of file qgscomposershape.cpp.

References drawShape(), QgsComposerItem::mFrame, and mUseSymbolV2.

Referenced by paint().

void QgsComposerShape::drawShape ( QPainter *  p)
private
void QgsComposerShape::drawShapeUsingSymbol ( QPainter *  p)
private
double QgsComposerShape::estimatedFrameBleed ( ) const
protectedvirtual

reimplement estimatedFrameBleed, since frames on shapes are drawn using symbology rather than the item's pen

Reimplemented from QgsComposerItem.

Definition at line 257 of file qgscomposershape.cpp.

References mMaxSymbolBleed.

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

Reimplementation of QCanvasItem::paint - draw on canvas.

Definition at line 93 of file qgscomposershape.cpp.

References drawBackground(), drawFrame(), and QgsComposerItem::drawSelectionBoxes().

QPointF QgsComposerShape::pointOnLineWithDistance ( const QPointF &  startPoint,
const QPointF &  directionPoint,
double  distance 
) const
private

Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point.

bool QgsComposerShape::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
virtual
void QgsComposerShape::refreshSymbol ( )
slot

Should be called after the shape's symbol is changed.

Redraws the shape and recalculates its selection bounds. Note: added in version 2.1

Definition at line 66 of file qgscomposershape.cpp.

References QgsSymbolLayerV2Utils::estimateMaxSymbolBleed(), QgsComposerItem::frameChanged(), mMaxSymbolBleed, mShapeStyleSymbol, and updateBoundingRect().

Referenced by setShapeStyleSymbol().

void QgsComposerShape::setCornerRadius ( double  radius)

Sets radius for rounded rectangle corners.

Added in v2.1

Definition at line 332 of file qgscomposershape.cpp.

References mCornerRadius.

void QgsComposerShape::setSceneRect ( const QRectF &  rectangle)
virtual

Sets new scene rectangle bounds and recalculates hight and extent.

Reimplemented from QgsComposerItem as it needs to call updateBoundingRect after the shape's size changes

Reimplemented from QgsComposerItem.

Definition at line 353 of file qgscomposershape.cpp.

References QgsComposerItem::setSceneRect(), and updateBoundingRect().

Referenced by QgsComposerShape().

void QgsComposerShape::setShapeStyleSymbol ( QgsFillSymbolV2 symbol)

Sets the QgsFillSymbolV2 used to draw the shape.

Must also call setUseSymbolV2( true ) to enable drawing with a symbol. Note: added in version 2.1

Definition at line 59 of file qgscomposershape.cpp.

References mShapeStyleSymbol, and refreshSymbol().

void QgsComposerShape::setShapeType ( QgsComposerShape::Shape  s)
inline

Definition at line 64 of file qgscomposershape.h.

Referenced by QgsComposerView::addShape().

void QgsComposerShape::setUseSymbolV2 ( bool  useSymbolV2)

Controls whether the shape should be drawn using a QgsFillSymbolV2.

Note: Added in v2.1

Definition at line 53 of file qgscomposershape.cpp.

References mUseSymbolV2, and QgsComposerItem::setFrameEnabled().

Referenced by QgsComposition::addItemsFromXML(), and QgsComposerView::addShape().

QgsFillSymbolV2* QgsComposerShape::shapeStyleSymbol ( )
inline

Returns the QgsFillSymbolV2 used to draw the shape.

Note: added in version 2.1

Definition at line 77 of file qgscomposershape.h.

QgsComposerShape::Shape QgsComposerShape::shapeType ( ) const
inline

Definition at line 63 of file qgscomposershape.h.

virtual int QgsComposerShape::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 45 of file qgscomposershape.h.

References QgsComposerItem::ComposerShape.

void QgsComposerShape::updateBoundingRect ( )
private

Updates the bounding rect of this item.

Definition at line 342 of file qgscomposershape.cpp.

References mCurrentRectangle, and mMaxSymbolBleed.

Referenced by createDefaultShapeStyleSymbol(), refreshSymbol(), and setSceneRect().

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

stores state in Dom element

Parameters
elemis Dom element corresponding to 'Composer' tag
docwrite template file

Implements QgsComposerItem.

Definition at line 262 of file qgscomposershape.cpp.

References QgsComposerItem::_writeXML(), mCornerRadius, mShape, mShapeStyleSymbol, and QgsSymbolLayerV2Utils::saveSymbol().

Member Data Documentation

double QgsComposerShape::mCornerRadius
private
QRectF QgsComposerShape::mCurrentRectangle
private

Current bounding rectangle of shape.

Definition at line 118 of file qgscomposershape.h.

Referenced by boundingRect(), and updateBoundingRect().

double QgsComposerShape::mMaxSymbolBleed
private
Shape QgsComposerShape::mShape
private

Ellipse, rectangle or triangle.

Definition at line 109 of file qgscomposershape.h.

Referenced by drawShape(), drawShapeUsingSymbol(), readXML(), and writeXML().

QgsFillSymbolV2* QgsComposerShape::mShapeStyleSymbol
private
bool QgsComposerShape::mUseSymbolV2
private

Definition at line 113 of file qgscomposershape.h.

Referenced by drawBackground(), drawFrame(), drawShape(), and setUseSymbolV2().


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