Quantum GIS API Documentation
1.7.5-Wroclaw
|
An item that draws an arrow between to points. More...
#include <qgscomposerarrow.h>
Public Types | |
enum | MarkerMode { DefaultMarker, NoMarker, SVGMarker } |
![]() | |
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 } |
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. | |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) |
Reimplementation of QCanvasItem::paint - draw on canvas. | |
void | setSceneRect (const QRectF &rectangle) |
Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect. | |
void | setArrowHeadWidth (double width) |
Sets the width of the arrow head in mm. | |
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 | |
bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) |
sets state from Dom document | |
![]() | |
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 QgsComposition * | composition () 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 | 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. | |
void | drawHardcodedMarker (QPainter *p, MarkerType type) |
Draws the default marker at the line end. | |
void | drawSVGMarker (QPainter *p, MarkerType type, const QString &markerPath) |
Draws a user-defined marker (must be an svg file) | |
void | initGraphicsSettings () |
Apply default graphics settings. |
Private Attributes | |
QPointF | mStartPoint |
QPointF | mStopPoint |
QPen | mPen |
QBrush | mBrush |
double | mArrowHeadWidth |
Width of the arrow marker in mm. | |
double | mStartArrowHeadHeight |
Height of the arrow marker in mm. | |
double | mStopArrowHeadHeight |
QString | mStartMarkerFile |
Path to the start marker file. | |
QString | mEndMarkerFile |
Path to the end marker file. | |
MarkerMode | mMarkerMode |
Default marker, no marker or svg marker. | |
QColor | mArrowColor |
Additional Inherited Members | |
![]() | |
virtual void | setRotation (double r) |
void | repaint () |
![]() | |
void | rotationChanged (double newRotation) |
Is emitted on rotation change to notify north arrow pictures. | |
void | itemChanged () |
Used e.g. | |
![]() | |
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 ¤tPosition, 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. | |
![]() | |
QgsComposition * | mComposition |
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. |
An item that draws an arrow between to points.
Definition at line 24 of file qgscomposerarrow.h.
Definition at line 28 of file qgscomposerarrow.h.
|
private |
Definition at line 80 of file qgscomposerarrow.h.
QgsComposerArrow::QgsComposerArrow | ( | QgsComposition * | c | ) |
Definition at line 24 of file qgscomposerarrow.cpp.
References initGraphicsSettings().
QgsComposerArrow::QgsComposerArrow | ( | const QPointF & | startPoint, |
const QPointF & | stopPoint, | ||
QgsComposition * | c | ||
) |
Definition at line 34 of file qgscomposerarrow.cpp.
References adaptItemSceneRect(), and initGraphicsSettings().
QgsComposerArrow::~QgsComposerArrow | ( | ) |
Definition at line 45 of file qgscomposerarrow.cpp.
|
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 256 of file qgscomposerarrow.cpp.
References DefaultMarker, mArrowHeadWidth, mMarkerMode, mPen, mStartArrowHeadHeight, mStartPoint, mStopArrowHeadHeight, mStopPoint, NoMarker, setSceneRect(), and SVGMarker.
Referenced by QgsComposerArrow(), readXML(), setArrowHeadWidth(), setEndMarker(), setOutlineWidth(), setSceneRect(), and setStartMarker().
|
inline |
Definition at line 60 of file qgscomposerarrow.h.
|
inline |
Definition at line 50 of file qgscomposerarrow.h.
|
private |
Draws the default marker at the line end.
Definition at line 111 of file qgscomposerarrow.cpp.
References QgsComposerItem::angle(), QgsComposerItem::drawArrowHead(), mArrowColor, mArrowHeadWidth, mStartPoint, and mStopPoint.
Referenced by paint().
|
private |
Draws a user-defined marker (must be an svg file)
Definition at line 119 of file qgscomposerarrow.cpp.
References QgsComposerItem::angle(), QgsComposerItem::horizontalViewScaleFactor(), M_PI, mArrowHeadWidth, QgsComposerItem::mComposition, mEndMarkerFile, mStartArrowHeadHeight, mStartMarkerFile, mStartPoint, mStopArrowHeadHeight, mStopPoint, QgsComposition::plotStyle(), QgsComposition::Preview, and StartMarker.
Referenced by paint().
|
inline |
Definition at line 58 of file qgscomposerarrow.h.
|
private |
Apply default graphics settings.
Definition at line 50 of file qgscomposerarrow.cpp.
References mPen, and setArrowHeadWidth().
Referenced by QgsComposerArrow().
|
inline |
Definition at line 63 of file qgscomposerarrow.h.
|
inline |
Definition at line 53 of file qgscomposerarrow.h.
Referenced by writeXML().
void QgsComposerArrow::paint | ( | QPainter * | painter, |
const QStyleOptionGraphicsItem * | itemStyle, | ||
QWidget * | pWidget | ||
) |
Reimplementation of QCanvasItem::paint - draw on canvas.
Definition at line 61 of file qgscomposerarrow.cpp.
References DefaultMarker, QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), drawHardcodedMarker(), QgsComposerItem::drawSelectionBoxes(), drawSVGMarker(), EndMarker, mArrowColor, mEndMarkerFile, mMarkerMode, mPen, mStartMarkerFile, mStartPoint, mStopPoint, StartMarker, and SVGMarker.
|
virtual |
sets state from Dom document
itemElem | is Dom node corresponding to item tag |
doc | is the document to read |
Implements QgsComposerItem.
Definition at line 313 of file qgscomposerarrow.cpp.
References QgsComposerItem::_readXML(), adaptItemSceneRect(), QgsComposerItem::itemChanged(), mArrowColor, mArrowHeadWidth, mMarkerMode, mPen, mStartPoint, mStopPoint, setEndMarker(), and setStartMarker().
|
inline |
Definition at line 61 of file qgscomposerarrow.h.
void QgsComposerArrow::setArrowHeadWidth | ( | double | width | ) |
Sets the width of the arrow head in mm.
Definition at line 248 of file qgscomposerarrow.cpp.
References adaptItemSceneRect(), mArrowHeadWidth, mEndMarkerFile, mStartMarkerFile, setEndMarker(), and setStartMarker().
Referenced by initGraphicsSettings().
void QgsComposerArrow::setEndMarker | ( | const QString & | svgPath | ) |
Definition at line 226 of file qgscomposerarrow.cpp.
References adaptItemSceneRect(), mArrowHeadWidth, mEndMarkerFile, and mStopArrowHeadHeight.
Referenced by readXML(), and setArrowHeadWidth().
|
inline |
Definition at line 64 of file qgscomposerarrow.h.
void QgsComposerArrow::setOutlineWidth | ( | double | width | ) |
Definition at line 242 of file qgscomposerarrow.cpp.
References adaptItemSceneRect(), and mPen.
|
virtual |
Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect.
Reimplemented from QgsComposerItem.
Definition at line 95 of file qgscomposerarrow.cpp.
References adaptItemSceneRect(), mStartPoint, and mStopPoint.
Referenced by adaptItemSceneRect().
void QgsComposerArrow::setStartMarker | ( | const QString & | svgPath | ) |
Definition at line 210 of file qgscomposerarrow.cpp.
References adaptItemSceneRect(), mArrowHeadWidth, mStartArrowHeadHeight, and mStartMarkerFile.
Referenced by readXML(), and setArrowHeadWidth().
|
inline |
Definition at line 56 of file qgscomposerarrow.h.
|
inlinevirtual |
return correct graphics item type.
Added in v1.7
Reimplemented from QgsComposerItem.
Definition at line 40 of file qgscomposerarrow.h.
References QgsComposerItem::ComposerArrow.
|
virtual |
stores state in Dom element
elem | is Dom element corresponding to 'Composer' tag |
doc | document |
Implements QgsComposerItem.
Definition at line 280 of file qgscomposerarrow.cpp.
References QgsComposerItem::_writeXML(), mArrowColor, mArrowHeadWidth, mEndMarkerFile, mMarkerMode, mStartMarkerFile, mStartPoint, mStopPoint, and outlineWidth().
|
private |
Definition at line 104 of file qgscomposerarrow.h.
Referenced by drawHardcodedMarker(), paint(), readXML(), and writeXML().
|
private |
Width of the arrow marker in mm.
May be specified by the user. The height is automatically adapted
Definition at line 93 of file qgscomposerarrow.h.
Referenced by adaptItemSceneRect(), drawHardcodedMarker(), drawSVGMarker(), readXML(), setArrowHeadWidth(), setEndMarker(), setStartMarker(), and writeXML().
|
private |
Definition at line 90 of file qgscomposerarrow.h.
|
private |
Path to the end marker file.
Definition at line 101 of file qgscomposerarrow.h.
Referenced by drawSVGMarker(), paint(), setArrowHeadWidth(), setEndMarker(), and writeXML().
|
private |
Default marker, no marker or svg marker.
Definition at line 103 of file qgscomposerarrow.h.
Referenced by adaptItemSceneRect(), paint(), readXML(), and writeXML().
|
private |
Definition at line 89 of file qgscomposerarrow.h.
Referenced by adaptItemSceneRect(), initGraphicsSettings(), paint(), readXML(), and setOutlineWidth().
|
private |
Height of the arrow marker in mm.
Is calculated from arrow marker width and apsect ratio of svg
Definition at line 95 of file qgscomposerarrow.h.
Referenced by adaptItemSceneRect(), drawSVGMarker(), and setStartMarker().
|
private |
Path to the start marker file.
Definition at line 99 of file qgscomposerarrow.h.
Referenced by drawSVGMarker(), paint(), setArrowHeadWidth(), setStartMarker(), and writeXML().
|
private |
Definition at line 86 of file qgscomposerarrow.h.
Referenced by adaptItemSceneRect(), drawHardcodedMarker(), drawSVGMarker(), paint(), readXML(), setSceneRect(), and writeXML().
|
private |
Definition at line 96 of file qgscomposerarrow.h.
Referenced by adaptItemSceneRect(), drawSVGMarker(), and setEndMarker().
|
private |
Definition at line 87 of file qgscomposerarrow.h.
Referenced by adaptItemSceneRect(), drawHardcodedMarker(), drawSVGMarker(), paint(), readXML(), setSceneRect(), and writeXML().