QgsAnnotationItem Class Reference

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

#include <qgsannotationitem.h>

Inheritance diagram for QgsAnnotationItem:

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

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

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

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

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

enum QgsAnnotationItem::MouseMoveAction

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

)

Definition at line 26 of file qgsannotationitem.cpp.

QgsAnnotationItem::~QgsAnnotationItem ( )

virtual

Definition at line 40 of file qgsannotationitem.cpp.

Member Function Documentation

void QgsAnnotationItem::_readXML	(	const QDomDocument &	doc,
		const QDomElement &	annotationElem
	)

Definition at line 419 of file qgsannotationitem.cpp.

void QgsAnnotationItem::_writeXML	(	QDomDocument &	doc,
		QDomElement &	itemElem
	)		const

Definition at line 385 of file qgsannotationitem.cpp.

QRectF QgsAnnotationItem::boundingRect ( ) const

overridevirtual

default implementation for canvas items

Reimplemented from QgsMapCanvasItem.

Definition at line 96 of file qgsannotationitem.cpp.

Qt::CursorShape QgsAnnotationItem::cursorShapeForAction

(

MouseMoveAction

moveAction

)

const

Returns suitable cursor shape for mouse move action.

Definition at line 343 of file qgsannotationitem.cpp.

void QgsAnnotationItem::drawFrame ( QPainter *  p )

protected

Definition at line 177 of file qgsannotationitem.cpp.

void QgsAnnotationItem::drawMarkerSymbol ( QPainter *  p )

protected

Definition at line 211 of file qgsannotationitem.cpp.

void QgsAnnotationItem::drawSelectionBoxes ( QPainter *  p )

protected

Definition at line 232 of file qgsannotationitem.cpp.

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.

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 101 of file qgsannotationitem.cpp.

QgsAnnotationItem::MouseMoveAction QgsAnnotationItem::moveActionForPosition

(

const QPointF &

pos

)

const

Returns the mouse move behaviour for a given position.

Parameters

pos	the position in scene coordinates

Definition at line 284 of file qgsannotationitem.cpp.

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 275 of file qgsannotationitem.cpp.

virtual void QgsAnnotationItem::readXML ( const QDomDocument &  doc, const QDomElement &  itemElem  )

pure virtual

Implemented in QgsFormAnnotationItem, QgsHtmlAnnotationItem, QgsTextAnnotationItem, and QgsSvgAnnotationItem.

double QgsAnnotationItem::scaledSymbolSize ( ) const

protected

Returns the symbol size scaled in (mapcanvas) pixels.

Used for the counding rect calculation

Definition at line 369 of file qgsannotationitem.cpp.

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 254 of file qgsannotationitem.cpp.

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

)

Definition at line 203 of file qgsannotationitem.cpp.

void QgsAnnotationItem::setMapPosition ( const QgsPoint &  pos )

virtual

Reimplemented in QgsFormAnnotationItem, and QgsHtmlAnnotationItem.

Definition at line 52 of file qgsannotationitem.cpp.

void QgsAnnotationItem::setMapPositionFixed

(

bool

fixed

)

Definition at line 65 of file qgsannotationitem.cpp.

void QgsAnnotationItem::setMarkerSymbol

(

QgsMarkerSymbolV2 *

symbol

)

Set symbol that is drawn on map position.

Takes ownership

Definition at line 45 of file qgsannotationitem.cpp.

void QgsAnnotationItem::setOffsetFromReferencePoint

(

const QPointF &

offset

)

Definition at line 58 of file qgsannotationitem.cpp.

void QgsAnnotationItem::updateBalloon ( )

protected

Check where to attach the balloon connection between frame and map point.

Definition at line 122 of file qgsannotationitem.cpp.

void QgsAnnotationItem::updateBoundingRect ( )

protected

Definition at line 106 of file qgsannotationitem.cpp.

void QgsAnnotationItem::updatePosition ( )

overridevirtual

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

Reimplemented from QgsMapCanvasItem.

Definition at line 84 of file qgsannotationitem.cpp.

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

pure virtual

Implemented in QgsFormAnnotationItem, QgsHtmlAnnotationItem, QgsTextAnnotationItem, and QgsSvgAnnotationItem.

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.

QPointF QgsAnnotationItem::mBalloonSegmentPoint1

protected

First segment point for drawing the connection (ccw direction)

Definition at line 120 of file qgsannotationitem.h.

QPointF QgsAnnotationItem::mBalloonSegmentPoint2

protected

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

Definition at line 122 of file qgsannotationitem.h.

QRectF QgsAnnotationItem::mBoundingRect

protected

Bounding rect (including item frame and balloon)

Definition at line 107 of file qgsannotationitem.h.

QColor QgsAnnotationItem::mFrameBackgroundColor

protected

Definition at line 115 of file qgsannotationitem.h.

double QgsAnnotationItem::mFrameBorderWidth

protected

Width of the frame.

Definition at line 112 of file qgsannotationitem.h.

QColor QgsAnnotationItem::mFrameColor

protected

Frame / balloon color.

Definition at line 114 of file qgsannotationitem.h.

QSizeF QgsAnnotationItem::mFrameSize

protected

Size of the frame (without balloon)

Definition at line 105 of file qgsannotationitem.h.

QgsPoint QgsAnnotationItem::mMapPosition

protected

Map position (in case mMapPositionFixed is true)

Definition at line 100 of file qgsannotationitem.h.

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.

QgsMarkerSymbolV2* QgsAnnotationItem::mMarkerSymbol

protected

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

Definition at line 110 of file qgsannotationitem.h.

QPointF QgsAnnotationItem::mOffsetFromReferencePoint

protected

Describes the shift of the item content box to the reference point.

Definition at line 102 of file qgsannotationitem.h.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgsannotationitem.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgsannotationitem.cpp