QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsAnnotationItem Class Referenceabstract

An annotation item can be either placed either on screen corrdinates or on map coordinates. More...

#include <qgsannotationitem.h>

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

Public Types

enum  MouseMoveAction {
  NoAction, MoveMapPosition, MoveFramePosition, ResizeFrameUp,
  ResizeFrameDown, ResizeFrameLeft, ResizeFrameRight, ResizeFrameLeftUp,
  ResizeFrameRightUp, ResizeFrameLeftDown, ResizeFrameRightDown
}
 

Public Member Functions

 QgsAnnotationItem (QgsMapCanvas *mapCanvas)
 
virtual ~QgsAnnotationItem ()
 
void updatePosition ()
 called on changed extent or resize event to update position of the item More...
 
QRectF boundingRect () const
 default implementation for canvas items More...
 
virtual QSizeF minimumFrameSize () const
 
QgsAnnotationItem::MouseMoveAction moveActionForPosition (const QPointF &pos) const
 Returns the mouse move behaviour for a given position. More...
 
Qt::CursorShape cursorShapeForAction (MouseMoveAction moveAction) const
 Returns suitable cursor shape for mouse move action. More...
 
void setMapPositionFixed (bool fixed)
 
bool mapPositionFixed () const
 
virtual void setMapPosition (const QgsPoint &pos)
 
QgsPoint mapPosition () const
 
void setFrameSize (const QSizeF &size)
 
QSizeF frameSize () const
 
void setOffsetFromReferencePoint (const QPointF &offset)
 
QPointF offsetFromReferencePoint () const
 
void setMarkerSymbol (QgsMarkerSymbolV2 *symbol)
 Set symbol that is drawn on map position. More...
 
const QgsMarkerSymbolV2markerSymbol () const
 
void setFrameBorderWidth (double w)
 
double frameBorderWidth () const
 
void setFrameColor (const QColor &c)
 
QColor frameColor () const
 
void setFrameBackgroundColor (const QColor &c)
 
QColor frameBackgroundColor () const
 
virtual void writeXML (QDomDocument &doc) const =0
 
virtual void readXML (const QDomDocument &doc, const QDomElement &itemElem)=0
 
void _writeXML (QDomDocument &doc, QDomElement &itemElem) const
 
void _readXML (const QDomDocument &doc, const QDomElement &annotationElem)
 
- Public Member Functions inherited from QgsMapCanvasItem
Q_DECL_DEPRECATED void setPanningOffset (const QPoint &point)
 sets current offset, to be called from QgsMapCanvas More...
 
QgsRectangle rect () const
 returns canvas item rectangle More...
 
void setRect (const QgsRectangle &r)
 sets canvas item rectangle More...
 
QgsPoint toMapCoordinates (const QPoint &point)
 transformation from screen coordinates to map coordinates More...
 
QPointF toCanvasCoordinates (const QgsPoint &point)
 transformation from map coordinates to screen coordinates More...
 

Protected Member Functions

void updateBoundingRect ()
 
void updateBalloon ()
 Check where to attach the balloon connection between frame and map point. More...
 
void drawFrame (QPainter *p)
 
void drawMarkerSymbol (QPainter *p)
 
void drawSelectionBoxes (QPainter *p)
 
QLineF segment (int index)
 Returns frame width in painter units. More...
 
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...
 
double scaledSymbolSize () const
 Returns the symbol size scaled in (mapcanvas) pixels. More...
 
- Protected Member Functions inherited from QgsMapCanvasItem
 QgsMapCanvasItem (QgsMapCanvas *mapCanvas)
 protected constructor: cannot be constructed directly More...
 
virtual ~QgsMapCanvasItem ()
 
virtual void paint (QPainter *painter)=0
 function to be implemented by derived classes More...
 
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=0)
 paint function called by map canvas More...
 
void updateCanvas ()
 schedules map canvas for repaint More...
 
bool setRenderContextVariables (QPainter *p, QgsRenderContext &context) const
 Sets render context parameters. More...
 

Protected Attributes

bool mMapPositionFixed
 True: the item stays at the same map position, False: the item stays on same screen position. More...
 
QgsPoint mMapPosition
 Map position (in case mMapPositionFixed is true) More...
 
QPointF mOffsetFromReferencePoint
 Describes the shift of the item content box to the reference point. More...
 
QSizeF mFrameSize
 Size of the frame (without balloon) More...
 
QRectF mBoundingRect
 Bounding rect (including item frame and balloon) More...
 
QgsMarkerSymbolV2mMarkerSymbol
 Point symbol that is to be drawn at the map reference location. More...
 
double mFrameBorderWidth
 Width of the frame. More...
 
QColor mFrameColor
 Frame / balloon color. More...
 
QColor mFrameBackgroundColor
 
int mBalloonSegment
 Segment number where the connection to the map point is attached. More...
 
QPointF mBalloonSegmentPoint1
 First segment point for drawing the connection (ccw direction) More...
 
QPointF mBalloonSegmentPoint2
 Second segment point for drawing the balloon connection (ccw direction) More...
 
- Protected Attributes inherited from QgsMapCanvasItem
QgsMapCanvasmMapCanvas
 pointer to map canvas More...
 
QgsRectangle mRect
 canvas item rectangle (in map coordinates) More...
 
QPoint mPanningOffset
 offset from normal position due current panning operation, used when converting map coordinates to move map canvas items More...
 
QSizeF mItemSize
 cached size of the item (to return in boundingRect()) More...
 

Detailed Description

An annotation item can be either placed either on screen corrdinates or on map coordinates.

It may reference a feature and displays that associatiation with a balloon like appearance

Definition at line 31 of file qgsannotationitem.h.

Member Enumeration Documentation

Enumerator
NoAction 
MoveMapPosition 
MoveFramePosition 
ResizeFrameUp 
ResizeFrameDown 
ResizeFrameLeft 
ResizeFrameRight 
ResizeFrameLeftUp 
ResizeFrameRightUp 
ResizeFrameLeftDown 
ResizeFrameRightDown 

Definition at line 34 of file qgsannotationitem.h.

Constructor & Destructor Documentation

QgsAnnotationItem::QgsAnnotationItem ( QgsMapCanvas mapCanvas)
QgsAnnotationItem::~QgsAnnotationItem ( )
virtual

Definition at line 36 of file qgsannotationitem.cpp.

References mMarkerSymbol.

Member Function Documentation

void QgsAnnotationItem::_readXML ( const QDomDocument &  doc,
const QDomElement &  annotationElem 
)
void QgsAnnotationItem::_writeXML ( QDomDocument &  doc,
QDomElement &  itemElem 
) const
QRectF QgsAnnotationItem::boundingRect ( ) const
virtual

default implementation for canvas items

Reimplemented from QgsMapCanvasItem.

Definition at line 92 of file qgsannotationitem.cpp.

References mBoundingRect.

Qt::CursorShape QgsAnnotationItem::cursorShapeForAction ( MouseMoveAction  moveAction) const
void QgsAnnotationItem::drawFrame ( QPainter *  p)
protected
void QgsAnnotationItem::drawMarkerSymbol ( QPainter *  p)
protected
void QgsAnnotationItem::drawSelectionBoxes ( QPainter *  p)
protected
QColor QgsAnnotationItem::frameBackgroundColor ( ) const
inline

Definition at line 88 of file qgsannotationitem.h.

double QgsAnnotationItem::frameBorderWidth ( ) const
inline

Definition at line 82 of file qgsannotationitem.h.

QColor QgsAnnotationItem::frameColor ( ) const
inline

Definition at line 85 of file qgsannotationitem.h.

QSizeF QgsAnnotationItem::frameSize ( ) const
inline

Definition at line 72 of file qgsannotationitem.h.

Referenced by setFrameSize().

QgsPoint QgsAnnotationItem::mapPosition ( ) const
inline

Definition at line 69 of file qgsannotationitem.h.

bool QgsAnnotationItem::mapPositionFixed ( ) const
inline

Definition at line 66 of file qgsannotationitem.h.

const QgsMarkerSymbolV2* QgsAnnotationItem::markerSymbol ( ) const
inline

Definition at line 79 of file qgsannotationitem.h.

QSizeF QgsAnnotationItem::minimumFrameSize ( ) const
virtual

Reimplemented in QgsHtmlAnnotationItem, and QgsFormAnnotationItem.

Definition at line 97 of file qgsannotationitem.cpp.

Referenced by setFrameSize().

QgsAnnotationItem::MouseMoveAction QgsAnnotationItem::moveActionForPosition ( const QPointF &  pos) const

Returns the mouse move behaviour for a given position.

Parameters
posthe position in scene coordinates

Definition at line 280 of file qgsannotationitem.cpp.

References mFrameSize, mOffsetFromReferencePoint, MoveFramePosition, MoveMapPosition, NoAction, ResizeFrameDown, ResizeFrameLeft, ResizeFrameLeftDown, ResizeFrameLeftUp, ResizeFrameRight, ResizeFrameRightDown, ResizeFrameRightUp, and ResizeFrameUp.

QPointF QgsAnnotationItem::offsetFromReferencePoint ( ) const
inline

Definition at line 75 of file qgsannotationitem.h.

QPointF QgsAnnotationItem::pointOnLineWithDistance ( const QPointF &  startPoint,
const QPointF &  directionPoint,
double  distance 
) const
protected

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

Definition at line 271 of file qgsannotationitem.cpp.

Referenced by updateBalloon().

virtual void QgsAnnotationItem::readXML ( const QDomDocument &  doc,
const QDomElement &  itemElem 
)
pure virtual
double QgsAnnotationItem::scaledSymbolSize ( ) const
protected

Returns the symbol size scaled in (mapcanvas) pixels.

Used for the counding rect calculation

Definition at line 365 of file qgsannotationitem.cpp.

References QgsMapCanvasItem::mMapCanvas, mMarkerSymbol, and QgsMarkerSymbolV2::size().

Referenced by updateBoundingRect().

QLineF QgsAnnotationItem::segment ( int  index)
protected

Returns frame width in painter units.

Gets the frame line (0 is the top line, 1 right, 2 bottom, 3 left)

Definition at line 250 of file qgsannotationitem.cpp.

References mFrameSize, and mOffsetFromReferencePoint.

Referenced by drawFrame(), and updateBalloon().

void QgsAnnotationItem::setFrameBackgroundColor ( const QColor &  c)
inline

Definition at line 87 of file qgsannotationitem.h.

void QgsAnnotationItem::setFrameBorderWidth ( double  w)
inline

Definition at line 81 of file qgsannotationitem.h.

void QgsAnnotationItem::setFrameColor ( const QColor &  c)
inline

Definition at line 84 of file qgsannotationitem.h.

void QgsAnnotationItem::setFrameSize ( const QSizeF &  size)
void QgsAnnotationItem::setMapPosition ( const QgsPoint pos)
virtual
void QgsAnnotationItem::setMapPositionFixed ( bool  fixed)
void QgsAnnotationItem::setMarkerSymbol ( QgsMarkerSymbolV2 symbol)

Set symbol that is drawn on map position.

Takes ownership

Definition at line 41 of file qgsannotationitem.cpp.

References mMarkerSymbol, and updateBoundingRect().

void QgsAnnotationItem::setOffsetFromReferencePoint ( const QPointF &  offset)
void QgsAnnotationItem::updateBalloon ( )
protected
void QgsAnnotationItem::updateBoundingRect ( )
protected
void QgsAnnotationItem::updatePosition ( )
virtual

called on changed extent or resize event to update position of the item

Reimplemented from QgsMapCanvasItem.

Definition at line 80 of file qgsannotationitem.cpp.

References mMapPosition, mMapPositionFixed, QgsMapCanvasItem::toCanvasCoordinates(), and QgsMapCanvasItem::toMapCoordinates().

virtual void QgsAnnotationItem::writeXML ( QDomDocument &  doc) const
pure virtual

Member Data Documentation

int QgsAnnotationItem::mBalloonSegment
protected

Segment number where the connection to the map point is attached.

-1 if no balloon needed (e.g. if point is contained in frame)

Definition at line 118 of file qgsannotationitem.h.

Referenced by drawFrame(), and updateBalloon().

QPointF QgsAnnotationItem::mBalloonSegmentPoint1
protected

First segment point for drawing the connection (ccw direction)

Definition at line 120 of file qgsannotationitem.h.

Referenced by drawFrame(), and updateBalloon().

QPointF QgsAnnotationItem::mBalloonSegmentPoint2
protected

Second segment point for drawing the balloon connection (ccw direction)

Definition at line 122 of file qgsannotationitem.h.

Referenced by drawFrame(), and updateBalloon().

QRectF QgsAnnotationItem::mBoundingRect
protected

Bounding rect (including item frame and balloon)

Definition at line 107 of file qgsannotationitem.h.

Referenced by boundingRect(), drawSelectionBoxes(), and updateBoundingRect().

QColor QgsAnnotationItem::mFrameBackgroundColor
protected
double QgsAnnotationItem::mFrameBorderWidth
protected
QColor QgsAnnotationItem::mFrameColor
protected

Frame / balloon color.

Definition at line 114 of file qgsannotationitem.h.

Referenced by _readXML(), _writeXML(), drawFrame(), and QgsAnnotationItem().

QSizeF QgsAnnotationItem::mFrameSize
protected
QgsPoint QgsAnnotationItem::mMapPosition
protected
bool QgsAnnotationItem::mMapPositionFixed
protected

True: the item stays at the same map position, False: the item stays on same screen position.

Definition at line 98 of file qgsannotationitem.h.

Referenced by _readXML(), _writeXML(), drawFrame(), QgsSvgAnnotationItem::paint(), QgsFormAnnotationItem::paint(), QgsTextAnnotationItem::paint(), QgsHtmlAnnotationItem::paint(), setMapPositionFixed(), updateBalloon(), and updatePosition().

QgsMarkerSymbolV2* QgsAnnotationItem::mMarkerSymbol
protected

Point symbol that is to be drawn at the map reference location.

Definition at line 110 of file qgsannotationitem.h.

Referenced by _readXML(), _writeXML(), drawMarkerSymbol(), QgsAnnotationItem(), scaledSymbolSize(), setMarkerSymbol(), updateBoundingRect(), and ~QgsAnnotationItem().

QPointF QgsAnnotationItem::mOffsetFromReferencePoint
protected

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