QGIS API Documentation  2.5.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 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 Member Functions

 QgsComposerArrow (QgsComposition *c)
 Constructor. More...
 
 QgsComposerArrow (const QPointF &startPoint, const QPointF &stopPoint, QgsComposition *c)
 Constructor. More...
 
 ~QgsComposerArrow ()
 
virtual int type () const
 Return composer 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
 Returns the width of the arrow head in mm. More...
 
Q_DECL_DEPRECATED void setOutlineWidth (double width)
 Sets the pen width for drawing the line and arrow head. More...
 
Q_DECL_DEPRECATED double outlineWidth () const
 Returns the pen width for drawing the line and arrow head. More...
 
void setStartMarker (const QString &svgPath)
 Sets the marker to draw at the start of the line. More...
 
QString startMarker () const
 Returns the marker drawn at the start of the line. More...
 
void setEndMarker (const QString &svgPath)
 Sets the marker to draw at the end of the line. More...
 
QString endMarker () const
 Returns the marker drawn at the end of the line. More...
 
Q_DECL_DEPRECATED QColor arrowColor () const
 Returns the color for the line and arrow head. More...
 
Q_DECL_DEPRECATED void setArrowColor (const QColor &c)
 Sets the color for the line and arrow head. More...
 
QColor arrowHeadOutlineColor () const
 Returns the color used to draw outline around the the arrow head. More...
 
void setArrowHeadOutlineColor (const QColor &color)
 Sets the color used to draw the outline around the arrow head. More...
 
QColor arrowHeadFillColor () const
 Returns the color used to fill the arrow head. More...
 
void setArrowHeadFillColor (const QColor &color)
 Sets the color used to fill the arrow head. More...
 
void setArrowHeadOutlineWidth (const double width)
 Sets the pen width for the outline of the arrow head. More...
 
double arrowHeadOutlineWidth () const
 Returns the pen width for the outline of the arrow head. More...
 
void setLineSymbol (QgsLineSymbolV2 *symbol)
 Sets the line symbol used for drawing the line portion of the arrow. More...
 
QgsLineSymbolV2lineSymbol ()
 Returns the line symbol used for drawing the line portion of the arrow. More...
 
MarkerMode markerMode () const
 Returns marker mode, which controls how the arrow endpoints are drawn. More...
 
void setMarkerMode (MarkerMode mode)
 Sets the marker mode, which controls how the arrow endpoints are drawn. 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...
 
- 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 bool isRemoved () const
 Returns whether this item has been removed from the composition. More...
 
void setIsRemoved (const bool removed)
 Sets whether this item has been removed from the composition. More...
 
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
virtual bool selected () const
 Is selected. 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...
 
int page () const
 Gets the page the item is currently on. More...
 
QPointF pagePos () const
 Returns the item's position relative to its current page. More...
 
void updatePagePos (double newPageWidth, double newPageHeight)
 Moves the item so that it retains its relative position on the page when the paper size changes. More...
 
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1)
 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, int page=-1)
 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 (const bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
virtual void setFrameOutlineWidth (const double outlineWidth)
 Sets frame outline width. More...
 
double frameOutlineWidth () const
 Returns the frame's outline width. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
void setFrameJoinStyle (const 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 (const 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 (const QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
int transparency () const
 Returns the item's transparency. More...
 
void setTransparency (const int transparency)
 Sets the item's transparency. More...
 
bool effectsEnabled () const
 Returns whether effects (eg blend modes) are enabled for the item. More...
 
void setEffectsEnabled (const 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 ()
 
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 ()
 
Q_DECL_DEPRECATED void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const
 Draws Text. More...
 
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. More...
 
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. More...
 
Q_DECL_DEPRECATED double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters. More...
 
Q_DECL_DEPRECATED double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontDescentMillimeters (const QFont &font) const
 Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontHeightMillimeters (const QFont &font) const
 Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double pixelFontSize (double pointSize) const
 Calculates font size in mm from a font point size. More...
 
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. More...
 
void setPositionLock (const bool lock)
 Locks / unlocks the item position for mouse drags. More...
 
bool positionLock () const
 Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. More...
 
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current rotation for the composer item. More...
 
Q_DECL_DEPRECATED 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 QString displayName () const
 Get item display name. More...
 
virtual void setVisibility (const bool visible)
 Sets visibility for item. More...
 
bool isGroupMember () const
 Returns whether this item is part of a group. More...
 
void setIsGroupMember (const bool isGroupMember)
 Sets whether this item is part of a group. More...
 
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
virtual void setCurrentExportLayer (const int layerIdx=-1)
 Sets the current layer to draw for exporting. More...
 
- Public Member Functions inherited from QgsComposerObject
 QgsComposerObject (QgsComposition *composition)
 Constructor. More...
 
virtual ~QgsComposerObject ()
 
const QgsCompositioncomposition () const
 Returns the composition the item is attached to. More...
 
QgsCompositioncomposition ()
 
QgsDataDefineddataDefinedProperty (const DataDefinedProperty property) const
 Returns a reference to the data defined settings for one of the item's data defined properties. More...
 
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. 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 init ()
 Apply default graphics settings. More...
 
void createDefaultLineSymbol ()
 Creates the default line symbol. More...
 
void drawLine (QPainter *painter)
 Draws the arrow line. 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...
 
double mArrowHeadOutlineWidth
 
QColor mArrowHeadOutlineColor
 
QColor mArrowHeadFillColor
 
int mBoundsBehaviour
 Indicates QGIS version to mimic bounding box behaviour for. More...
 
QgsLineSymbolV2mLineSymbol
 

Additional Inherited Members

- Public Slots inherited from QgsComposerItem
virtual void setRotation (double r)
 Sets the item rotation. More...
 
virtual void setItemRotation (const double r, const bool adjustPosition=false)
 Sets the item rotation. More...
 
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. More...
 
- Public Slots inherited from QgsComposerObject
virtual void repaint ()
 Triggers a redraw for the item. More...
 
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. More...
 
- Signals inherited from QgsComposerItem
void itemRotationChanged (double newRotation)
 Is emitted on item rotation change. More...
 
void sizeChanged ()
 Emitted if the rectangle changes. More...
 
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
- Signals inherited from QgsComposerObject
void itemChanged ()
 Emitted when the item changes. More...
 
- Protected Member Functions inherited from QgsComposerItem
virtual void drawSelectionBoxes (QPainter *p)
 Draws additional graphics on selected items. More...
 
virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
Q_DECL_DEPRECATED void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead. More...
 
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) 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...
 
Q_DECL_DEPRECATED 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...
 
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. More...
 
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. More...
 
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. More...
 
Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
 Calculates corner point after rotation and scaling. More...
 
Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling. More...
 
Q_DECL_DEPRECATED void sizeChangedByRotation (double &width, double &height, double rotation)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
Q_DECL_DEPRECATED void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
Q_DECL_DEPRECATED 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 ()
 
QRectF evalItemRect (const QRectF &newRect)
 Update an item rect to consider data defined position and size of item. More...
 
- Protected Member Functions inherited from QgsComposerObject
bool dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
 Evaluate a data defined property and return the calculated value. More...
 
- Protected Attributes inherited from QgsComposerItem
bool mRemovedFromComposition
 True if item has been removed from the composition. More...
 
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...
 
double mEvaluatedItemRotation
 Temporary evaluated 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...
 
bool mIsGroupMember
 Whether or not this item is part of a group. More...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 
- Protected Attributes inherited from QgsComposerObject
QgsCompositionmComposition
 
QMap
< QgsComposerObject::DataDefinedProperty,
QString > 
mDataDefinedNames
 Map of data defined properties for the item to string name to use when exporting item to xml. More...
 

Detailed Description

An item that draws an arrow between to points.

Definition at line 28 of file qgscomposerarrow.h.

Member Enumeration Documentation

Enumerator
DefaultMarker 
NoMarker 
SVGMarker 

Definition at line 32 of file qgscomposerarrow.h.

Enumerator
StartMarker 
EndMarker 

Definition at line 213 of file qgscomposerarrow.h.

Constructor & Destructor Documentation

QgsComposerArrow::QgsComposerArrow ( QgsComposition c)

Constructor.

Parameters
cparent composition

Definition at line 28 of file qgscomposerarrow.cpp.

References init().

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

Constructor.

Parameters
startPointstart point for line
stopPointend point for line
cparent composition

Definition at line 44 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), init(), mStartPoint, mStartXIdx, mStartYIdx, and mStopPoint.

QgsComposerArrow::~QgsComposerArrow ( )

Definition at line 61 of file qgscomposerarrow.cpp.

References mLineSymbol.

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 465 of file qgscomposerarrow.cpp.

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

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

QColor QgsComposerArrow::arrowColor ( ) const

Returns the color for the line and arrow head.

Deprecated:
use arrowHeadOutlineColor, arrowHeadFillColor or lineStyle instead

Definition at line 345 of file qgscomposerarrow.cpp.

References QgsSymbolV2::color(), and mLineSymbol.

QColor QgsComposerArrow::arrowHeadFillColor ( ) const
inline

Returns the color used to fill the arrow head.

Returns
arrow head fill color
See also
arrowHeadOutlineColor
setArrowHeadFillColor
Note
added in 2.5

Definition at line 147 of file qgscomposerarrow.h.

QColor QgsComposerArrow::arrowHeadOutlineColor ( ) const
inline

Returns the color used to draw outline around the the arrow head.

Returns
arrow head outline color
See also
arrowHeadFillColor
setArrowHeadOutlineColor
Note
added in 2.5

Definition at line 131 of file qgscomposerarrow.h.

double QgsComposerArrow::arrowHeadOutlineWidth ( ) const
inline

Returns the pen width for the outline of the arrow head.

Returns
pen width for arrow head outline
See also
setArrowHeadOutlineWidth
arrowHeadOutlineColor
Note
added in 2.5

Definition at line 171 of file qgscomposerarrow.h.

double QgsComposerArrow::arrowHeadWidth ( ) const
inline

Returns the width of the arrow head in mm.

Returns
width of arrow head
See also
setArrowHeadWidth

Definition at line 75 of file qgscomposerarrow.h.

double QgsComposerArrow::computeMarkerMargin ( ) const
private

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

Definition at line 423 of file qgscomposerarrow.cpp.

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

Referenced by adaptItemSceneRect(), and setSceneRect().

void QgsComposerArrow::createDefaultLineSymbol ( )
private

Creates the default line symbol.

Note
added in QGIS 2.5

Definition at line 79 of file qgscomposerarrow.cpp.

References QgsLineSymbolV2::createSimple(), and mLineSymbol.

Referenced by init().

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

Draws the default marker at the line end.

Definition at line 198 of file qgscomposerarrow.cpp.

References QgsComposerUtils::angle(), QgsComposerUtils::drawArrowHead(), mArrowHeadWidth, mBoundsBehaviour, mStartPoint, and mStopPoint.

Referenced by paint().

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

Returns the marker drawn at the end of the line.

Returns
file path for svg marker graphic
See also
setEndMarker
startMarker

Definition at line 113 of file qgscomposerarrow.h.

void QgsComposerArrow::init ( )
private
QgsLineSymbolV2* QgsComposerArrow::lineSymbol ( )
inline

Returns the line symbol used for drawing the line portion of the arrow.

Returns
line symbol
See also
setLineSymbol
Note
added in 2.5

Definition at line 185 of file qgscomposerarrow.h.

MarkerMode QgsComposerArrow::markerMode ( ) const
inline

Returns marker mode, which controls how the arrow endpoints are drawn.

Returns
marker mode
See also
setMarkerMode

Definition at line 191 of file qgscomposerarrow.h.

double QgsComposerArrow::outlineWidth ( ) const

Returns the pen width for drawing the line and arrow head.

Deprecated:
use arrowHeadOutlineWidth or lineSymbol instead

Definition at line 391 of file qgscomposerarrow.cpp.

References mLineSymbol, and QgsLineSymbolV2::width().

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

Sets the color for the line and arrow head.

Deprecated:
use setArrowHeadOutlineColor, setArrowHeadFillColor or setLineStyle instead

Definition at line 355 of file qgscomposerarrow.cpp.

References mArrowHeadFillColor, mArrowHeadOutlineColor, mBrush, mLineSymbol, mPen, and QgsSymbolV2::setColor().

void QgsComposerArrow::setArrowHeadFillColor ( const QColor &  color)

Sets the color used to fill the arrow head.

Parameters
colorarrow head fill color
See also
arrowHeadFillColor
setArrowHeadOutlineColor
Note
added in 2.5

Definition at line 373 of file qgscomposerarrow.cpp.

References mArrowHeadFillColor, and mBrush.

void QgsComposerArrow::setArrowHeadOutlineColor ( const QColor &  color)

Sets the color used to draw the outline around the arrow head.

Parameters
colorarrow head outline color
See also
setArrowHeadFillColor
arrowHeadOutlineColor
Note
added in 2.5

Definition at line 367 of file qgscomposerarrow.cpp.

References mArrowHeadOutlineColor, and mPen.

void QgsComposerArrow::setArrowHeadOutlineWidth ( const double  width)

Sets the pen width for the outline of the arrow head.

Parameters
widthpen width for arrow head outline
See also
arrowHeadOutlineWidth
setArrowHeadOutlineColor
Note
added in 2.5

Definition at line 401 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mArrowHeadOutlineWidth, and mPen.

void QgsComposerArrow::setArrowHeadWidth ( double  width)

Sets the width of the arrow head in mm.

Parameters
widthwidth of arrow head
See also
arrowHeadWidth

Definition at line 415 of file qgscomposerarrow.cpp.

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

Referenced by init().

void QgsComposerArrow::setEndMarker ( const QString &  svgPath)

Sets the marker to draw at the end of the line.

Parameters
svgPathfile path for svg marker graphic to draw
See also
endMarker
setStartMarker

Definition at line 329 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mArrowHeadWidth, mEndMarkerFile, and mStopArrowHeadHeight.

Referenced by readXML(), and setArrowHeadWidth().

void QgsComposerArrow::setLineSymbol ( QgsLineSymbolV2 symbol)

Sets the line symbol used for drawing the line portion of the arrow.

Parameters
symbolline symbol
See also
lineSymbol
Note
added in 2.5

Definition at line 409 of file qgscomposerarrow.cpp.

References mLineSymbol.

void QgsComposerArrow::setMarkerMode ( MarkerMode  mode)

Sets the marker mode, which controls how the arrow endpoints are drawn.

Parameters
modemarker mode
See also
setMarkerMode

Definition at line 475 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), and mMarkerMode.

void QgsComposerArrow::setOutlineWidth ( double  width)

Sets the pen width for drawing the line and arrow head.

Deprecated:
use setArrowHeadOutlineWidth or setLineSymbol instead

Definition at line 379 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mArrowHeadOutlineWidth, mLineSymbol, mPen, and QgsLineSymbolV2::setWidth().

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

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

Reimplemented from QgsComposerItem.

Definition at line 133 of file qgscomposerarrow.cpp.

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

void QgsComposerArrow::setStartMarker ( const QString &  svgPath)

Sets the marker to draw at the start of the line.

Parameters
svgPathfile path for svg marker graphic to draw
See also
startMarker
setEndMarker

Definition at line 313 of file qgscomposerarrow.cpp.

References adaptItemSceneRect(), mArrowHeadWidth, mStartArrowHeadHeight, and mStartMarkerFile.

Referenced by readXML(), and setArrowHeadWidth().

QString QgsComposerArrow::startMarker ( ) const
inline

Returns the marker drawn at the start of the line.

Returns
file path for svg marker graphic
See also
setStartMarker
endMarker

Definition at line 99 of file qgscomposerarrow.h.

virtual int QgsComposerArrow::type ( ) const
inlinevirtual

Return composer item type.

Note
added in QGIS 1.7

Reimplemented from QgsComposerItem.

Definition at line 56 of file qgscomposerarrow.h.

References QgsComposerItem::ComposerArrow.

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

Member Data Documentation

QColor QgsComposerArrow::mArrowHeadFillColor
private

Definition at line 246 of file qgscomposerarrow.h.

Referenced by init(), readXML(), setArrowColor(), setArrowHeadFillColor(), and writeXML().

QColor QgsComposerArrow::mArrowHeadOutlineColor
private

Definition at line 245 of file qgscomposerarrow.h.

Referenced by init(), readXML(), setArrowColor(), setArrowHeadOutlineColor(), and writeXML().

double QgsComposerArrow::mArrowHeadOutlineWidth
private

Definition at line 244 of file qgscomposerarrow.h.

Referenced by readXML(), setArrowHeadOutlineWidth(), setOutlineWidth(), 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 232 of file qgscomposerarrow.h.

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

int QgsComposerArrow::mBoundsBehaviour
private

Indicates QGIS version to mimic bounding box behaviour for.

The line placement changed in version 2.4, so a value of 22 is used to indicate that the line should be drawn using the older placement routine.

Definition at line 250 of file qgscomposerarrow.h.

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

QBrush QgsComposerArrow::mBrush
private

Definition at line 229 of file qgscomposerarrow.h.

Referenced by init(), paint(), readXML(), setArrowColor(), and setArrowHeadFillColor().

QString QgsComposerArrow::mEndMarkerFile
private

Path to the end marker file.

Definition at line 240 of file qgscomposerarrow.h.

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

QgsLineSymbolV2* QgsComposerArrow::mLineSymbol
private
MarkerMode QgsComposerArrow::mMarkerMode
private

Default marker, no marker or svg marker.

Definition at line 242 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 234 of file qgscomposerarrow.h.

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

QString QgsComposerArrow::mStartMarkerFile
private

Path to the start marker file.

Definition at line 238 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 225 of file qgscomposerarrow.h.

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

int QgsComposerArrow::mStartYIdx
private

Definition at line 226 of file qgscomposerarrow.h.

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

double QgsComposerArrow::mStopArrowHeadHeight
private

Definition at line 235 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: