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

An item that draws an arrow between to points. More...

#include <qgscomposerarrow.h>

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

Public Types

enum  MarkerMode { DefaultMarker, NoMarker, SVGMarker }
 
- 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 Member Functions

 QgsComposerArrow (QgsComposition *c)
 
 QgsComposerArrow (const QPointF &startPoint, const QPointF &stopPoint, QgsComposition *c)
 
 ~QgsComposerArrow ()
 
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...
 
void setSceneRect (const QRectF &rectangle)
 Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect. More...
 
void setArrowHeadWidth (double width)
 Sets the width of the arrow head in mm. More...
 
double arrowHeadWidth () const
 
void setOutlineWidth (double width)
 
double outlineWidth () const
 
void setStartMarker (const QString &svgPath)
 
QString startMarker () const
 
void setEndMarker (const QString &svgPath)
 
QString endMarker () const
 
QColor arrowColor () const
 
void setArrowColor (const QColor &c)
 
MarkerMode markerMode () const
 
void setMarkerMode (MarkerMode mode)
 
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...
 
- 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...
 

Private Types

enum  MarkerType { StartMarker, EndMarker }
 

Private Member Functions

void adaptItemSceneRect ()
 Adapts the item scene rect to contain the start point, the stop point including the arrow marker and the outline. More...
 
double computeMarkerMargin () const
 Computes the margin around the line necessary to include the markers. More...
 
void drawHardcodedMarker (QPainter *p, MarkerType type)
 Draws the default marker at the line end. More...
 
void drawSVGMarker (QPainter *p, MarkerType type, const QString &markerPath)
 Draws a user-defined marker (must be an svg file) More...
 
void initGraphicsSettings ()
 Apply default graphics settings. More...
 

Private Attributes

QPointF mStartPoint
 
QPointF mStopPoint
 
int mStartXIdx
 Considering the rectangle as spanning [x[0], x[1]] x [y[0], y[1]], these indices specify which index {0, 1} corresponds to the start point coordinate of the respective dimension. More...
 
int mStartYIdx
 
QPen mPen
 
QBrush mBrush
 
double mArrowHeadWidth
 Width of the arrow marker in mm. More...
 
double mStartArrowHeadHeight
 Height of the arrow marker in mm. More...
 
double mStopArrowHeadHeight
 
QString mStartMarkerFile
 Path to the start marker file. More...
 
QString mEndMarkerFile
 Path to the end marker file. More...
 
MarkerMode mMarkerMode
 Default marker, no marker or svg marker. More...
 
QColor mArrowColor
 

Additional Inherited Members

- 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 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 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...
 

Detailed Description

An item that draws an arrow between to points.

Definition at line 26 of file qgscomposerarrow.h.

Member Enumeration Documentation

Enumerator
DefaultMarker 
NoMarker 
SVGMarker 

Definition at line 30 of file qgscomposerarrow.h.

Enumerator
StartMarker 
EndMarker 

Definition at line 82 of file qgscomposerarrow.h.

Constructor & Destructor Documentation

QgsComposerArrow::QgsComposerArrow ( QgsComposition c)

Definition at line 25 of file qgscomposerarrow.cpp.

References initGraphicsSettings().

QgsComposerArrow::QgsComposerArrow ( const QPointF &  startPoint,
const QPointF &  stopPoint,
QgsComposition c 
)
QgsComposerArrow::~QgsComposerArrow ( )

Definition at line 50 of file qgscomposerarrow.cpp.

Member Function Documentation

void QgsComposerArrow::adaptItemSceneRect ( )
private

Adapts the item scene rect to contain the start point, the stop point including the arrow marker and the outline.

Needs to be called whenever the arrow width/height, the outline with or the endpoints are changed

Definition at line 297 of file qgscomposerarrow.cpp.

References computeMarkerMargin(), mStartPoint, mStopPoint, and QgsComposerItem::setSceneRect().

Referenced by QgsComposerArrow(), readXML(), setArrowHeadWidth(), setEndMarker(), setMarkerMode(), setOutlineWidth(), and setStartMarker().

QColor QgsComposerArrow::arrowColor ( ) const
inline

Definition at line 62 of file qgscomposerarrow.h.

double QgsComposerArrow::arrowHeadWidth ( ) const
inline

Definition at line 52 of file qgscomposerarrow.h.

double QgsComposerArrow::computeMarkerMargin ( ) const
private

Computes the margin around the line necessary to include the markers.

Definition at line 278 of file qgscomposerarrow.cpp.

References DefaultMarker, mArrowHeadWidth, mMarkerMode, mPen, mStartArrowHeadHeight, mStopArrowHeadHeight, NoMarker, and SVGMarker.

Referenced by adaptItemSceneRect(), and setSceneRect().

void QgsComposerArrow::drawHardcodedMarker ( QPainter *  p,
MarkerType  type 
)
private

Draws the default marker at the line end.

Definition at line 131 of file qgscomposerarrow.cpp.

References QgsComposerItem::angle(), QgsComposerItem::drawArrowHead(), mArrowColor, mArrowHeadWidth, mStartPoint, and mStopPoint.

Referenced by paint().

void QgsComposerArrow::drawSVGMarker ( QPainter *  p,
MarkerType  type,
const QString &  markerPath 
)
private
QString QgsComposerArrow::endMarker ( ) const
inline

Definition at line 60 of file qgscomposerarrow.h.

void QgsComposerArrow::initGraphicsSettings ( )
private

Apply default graphics settings.

Definition at line 55 of file qgscomposerarrow.cpp.

References mPen, and setArrowHeadWidth().

Referenced by QgsComposerArrow().

MarkerMode QgsComposerArrow::markerMode ( ) const
inline

Definition at line 65 of file qgscomposerarrow.h.

double QgsComposerArrow::outlineWidth ( ) const
inline

Definition at line 55 of file qgscomposerarrow.h.

Referenced by writeXML().

void QgsComposerArrow::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
)
bool QgsComposerArrow::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
virtual

sets state from Dom document

Parameters
itemElemis Dom node corresponding to item tag
docis the document to read

Implements QgsComposerItem.

Definition at line 346 of file qgscomposerarrow.cpp.

References QgsComposerItem::_readXML(), adaptItemSceneRect(), QgsComposerItem::itemChanged(), mArrowColor, mArrowHeadWidth, mMarkerMode, mPen, mStartPoint, mStartXIdx, mStartYIdx, mStopPoint, setEndMarker(), and setStartMarker().

Referenced by QgsComposition::addItemsFromXML().

void QgsComposerArrow::setArrowColor ( const QColor &  c)
inline

Definition at line 63 of file qgscomposerarrow.h.

void QgsComposerArrow::setArrowHeadWidth ( double  width)

Sets the width of the arrow head in mm.

Definition at line 270 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mArrowHeadWidth, mEndMarkerFile, mStartMarkerFile, setEndMarker(), and setStartMarker().

Referenced by initGraphicsSettings().

void QgsComposerArrow::setEndMarker ( const QString &  svgPath)
void QgsComposerArrow::setMarkerMode ( MarkerMode  mode)

Definition at line 307 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), and mMarkerMode.

void QgsComposerArrow::setOutlineWidth ( double  width)

Definition at line 264 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), and mPen.

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

Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect.

Reimplemented from QgsComposerItem.

Definition at line 102 of file qgscomposerarrow.cpp.

References computeMarkerMargin(), mStartPoint, mStartXIdx, mStartYIdx, mStopPoint, and QgsComposerItem::setSceneRect().

void QgsComposerArrow::setStartMarker ( const QString &  svgPath)
QString QgsComposerArrow::startMarker ( ) const
inline

Definition at line 58 of file qgscomposerarrow.h.

virtual int QgsComposerArrow::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 42 of file qgscomposerarrow.h.

References QgsComposerItem::ComposerArrow.

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

stores state in Dom element

Parameters
elemis Dom element corresponding to 'Composer' tag
docdocument

Implements QgsComposerItem.

Definition at line 313 of file qgscomposerarrow.cpp.

References QgsComposerItem::_writeXML(), mArrowColor, mArrowHeadWidth, mEndMarkerFile, mMarkerMode, mStartMarkerFile, mStartPoint, mStopPoint, and outlineWidth().

Member Data Documentation

QColor QgsComposerArrow::mArrowColor
private

Definition at line 112 of file qgscomposerarrow.h.

Referenced by drawHardcodedMarker(), paint(), readXML(), and writeXML().

double QgsComposerArrow::mArrowHeadWidth
private

Width of the arrow marker in mm.

May be specified by the user. The height is automatically adapted

Definition at line 101 of file qgscomposerarrow.h.

Referenced by computeMarkerMargin(), drawHardcodedMarker(), drawSVGMarker(), readXML(), setArrowHeadWidth(), setEndMarker(), setStartMarker(), and writeXML().

QBrush QgsComposerArrow::mBrush
private

Definition at line 98 of file qgscomposerarrow.h.

QString QgsComposerArrow::mEndMarkerFile
private

Path to the end marker file.

Definition at line 109 of file qgscomposerarrow.h.

Referenced by drawSVGMarker(), paint(), setArrowHeadWidth(), setEndMarker(), and writeXML().

MarkerMode QgsComposerArrow::mMarkerMode
private

Default marker, no marker or svg marker.

Definition at line 111 of file qgscomposerarrow.h.

Referenced by computeMarkerMargin(), paint(), readXML(), setMarkerMode(), and writeXML().

QPen QgsComposerArrow::mPen
private
double QgsComposerArrow::mStartArrowHeadHeight
private

Height of the arrow marker in mm.

Is calculated from arrow marker width and apsect ratio of svg

Definition at line 103 of file qgscomposerarrow.h.

Referenced by computeMarkerMargin(), drawSVGMarker(), and setStartMarker().

QString QgsComposerArrow::mStartMarkerFile
private

Path to the start marker file.

Definition at line 107 of file qgscomposerarrow.h.

Referenced by drawSVGMarker(), paint(), setArrowHeadWidth(), setStartMarker(), and writeXML().

QPointF QgsComposerArrow::mStartPoint
private
int QgsComposerArrow::mStartXIdx
private

Considering the rectangle as spanning [x[0], x[1]] x [y[0], y[1]], these indices specify which index {0, 1} corresponds to the start point coordinate of the respective dimension.

Definition at line 94 of file qgscomposerarrow.h.

Referenced by QgsComposerArrow(), readXML(), and setSceneRect().

int QgsComposerArrow::mStartYIdx
private

Definition at line 95 of file qgscomposerarrow.h.

Referenced by QgsComposerArrow(), readXML(), and setSceneRect().

double QgsComposerArrow::mStopArrowHeadHeight
private

Definition at line 104 of file qgscomposerarrow.h.

Referenced by computeMarkerMargin(), drawSVGMarker(), and setEndMarker().

QPointF QgsComposerArrow::mStopPoint
private

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