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

#include <qgsannotationitem.h>

Inheritance diagram for QgsAnnotationItem:

[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	_readXML (const QDomDocument &doc, const QDomElement &annotationElem)

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

QRectF	boundingRect () const override
	default implementation for canvas items More...

Qt::CursorShape	cursorShapeForAction (MouseMoveAction moveAction) const
	Returns suitable cursor shape for mouse move action. More...

QColor	frameBackgroundColor () const

double	frameBorderWidth () const

QColor	frameColor () const

QSizeF	frameSize () const

QgsPoint	mapPosition () const override
	Returns the map position of the annotation, if it is attached to a fixed map position. More...

QgsCoordinateReferenceSystem	mapPositionCrs () const override
	Returns the CRS of the map position. More...

bool	mapPositionFixed () const override
	Returns true if the annotation is attached to a fixed map position, or false if the annotation uses a position relative to the current map extent. More...

const QgsMarkerSymbolV2 *	markerSymbol () const

virtual QSizeF	minimumFrameSize () const

QgsAnnotationItem::MouseMoveAction	moveActionForPosition (QPointF pos) const
	Returns the mouse move behaviour for a given position. More...

QPointF	offsetFromReferencePoint () const

virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget=nullptr) override
	Paint the annotation to a destination painter. More...

void	paint (QPainter *painter) override
	function to be implemented by derived classes More...

virtual void	readXML (const QDomDocument &doc, const QDomElement &itemElem)=0

virtual QPointF	relativePosition () const override
	Returns the relative position of the annotation, if it is not attached to a fixed map position. More...

virtual double	scaleFactor () const override
	Returns a scaling factor which should be applied to painters before rendering the item. More...

void	setFrameBackgroundColor (const QColor &c)

void	setFrameBorderWidth (double w)

void	setFrameColor (const QColor &c)

void	setFrameSize (QSizeF size)

virtual void	setItemData (int role, const QVariant &value) override
	deprecated - do not use More...

virtual void	setMapPosition (const QgsPoint &pos)

virtual void	setMapPositionCrs (const QgsCoordinateReferenceSystem &crs)
	Sets the CRS of the map position. More...

void	setMapPositionFixed (bool fixed)

void	setMarkerSymbol (QgsMarkerSymbolV2 *symbol)
	Set symbol that is drawn on map position. More...

void	setOffsetFromReferencePoint (QPointF offset)

virtual bool	showItem () const override
	Returns true if the annotation should be shown. More...

void	updatePosition () override
	called on changed extent or resize event to update position of the item More...

virtual void	writeXML (QDomDocument &doc) const =0

Public Member Functions inherited from QgsMapCanvasItem
QgsRectangle	rect () const
	returns canvas item rectangle in map units More...

Q_DECL_DEPRECATED void	setPanningOffset (QPoint point)
	sets current offset, to be called from QgsMapCanvas More...

void	setRect (const QgsRectangle &r, bool resetRotation=true)
	sets canvas item rectangle in map units More...

QPointF	toCanvasCoordinates (const QgsPoint &point) const
	transformation from map coordinates to screen coordinates More...

QgsPoint	toMapCoordinates (QPoint point) const
	transformation from screen coordinates to map coordinates More...

Public Member Functions inherited from QGraphicsItem
	QGraphicsItem (QGraphicsItem *parent)

virtual	~QGraphicsItem ()

bool	acceptDrops () const

Qt::MouseButtons	acceptedMouseButtons () const

bool	acceptHoverEvents () const

bool	acceptsHoverEvents () const

bool	acceptTouchEvents () const

virtual void	advance (int phase)

virtual QRectF	boundingRect () const=0

QRegion	boundingRegion (const QTransform &itemToDeviceTransform) const

qreal	boundingRegionGranularity () const

CacheMode	cacheMode () const

QList< QGraphicsItem * >	childItems () const

QList< QGraphicsItem * >	children () const

QRectF	childrenBoundingRect () const

void	clearFocus ()

QPainterPath	clipPath () const

virtual bool	collidesWithItem (const QGraphicsItem *other, Qt::ItemSelectionMode mode) const

virtual bool	collidesWithPath (const QPainterPath &path, Qt::ItemSelectionMode mode) const

QList< QGraphicsItem * >	collidingItems (Qt::ItemSelectionMode mode) const

QGraphicsItem *	commonAncestorItem (const QGraphicsItem *other) const

virtual bool	contains (const QPointF &point) const

QCursor	cursor () const

QVariant	data (int key) const

QTransform	deviceTransform (const QTransform &viewportTransform) const

qreal	effectiveOpacity () const

void	ensureVisible (const QRectF &rect, int xmargin, int ymargin)

void	ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin, int ymargin)

bool	filtersChildEvents () const

GraphicsItemFlags	flags () const

QGraphicsItem *	focusItem () const

QGraphicsItem *	focusProxy () const

void	grabKeyboard ()

void	grabMouse ()

QGraphicsEffect *	graphicsEffect () const

QGraphicsItemGroup *	group () const

bool	handlesChildEvents () const

bool	hasCursor () const

bool	hasFocus () const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const

void	installSceneEventFilter (QGraphicsItem *filterItem)

bool	isActive () const

bool	isAncestorOf (const QGraphicsItem *child) const

bool	isBlockedByModalPanel (QGraphicsItem **blockingPanel) const

bool	isClipped () const

bool	isEnabled () const

bool	isObscured () const

bool	isObscured (const QRectF &rect) const

bool	isObscured (qreal x, qreal y, qreal w, qreal h) const

virtual bool	isObscuredBy (const QGraphicsItem *item) const

bool	isPanel () const

bool	isSelected () const

bool	isUnderMouse () const

bool	isVisible () const

bool	isVisibleTo (const QGraphicsItem *parent) const

bool	isWidget () const

bool	isWindow () const

QTransform	itemTransform (const QGraphicsItem other, bool ok) const

QPointF	mapFromItem (const QGraphicsItem *item, const QPointF &point) const

QPolygonF	mapFromItem (const QGraphicsItem *item, const QRectF &rect) const

QPolygonF	mapFromItem (const QGraphicsItem *item, const QPolygonF &polygon) const

QPainterPath	mapFromItem (const QGraphicsItem *item, const QPainterPath &path) const

QPointF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y) const

QPolygonF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QPointF	mapFromParent (const QPointF &point) const

QPolygonF	mapFromParent (const QRectF &rect) const

QPolygonF	mapFromParent (const QPolygonF &polygon) const

QPainterPath	mapFromParent (const QPainterPath &path) const

QPointF	mapFromParent (qreal x, qreal y) const

QPolygonF	mapFromParent (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapFromScene (const QPolygonF &polygon) const

QPointF	mapFromScene (const QPointF &point) const

QPolygonF	mapFromScene (const QRectF &rect) const

QPainterPath	mapFromScene (const QPainterPath &path) const

QPointF	mapFromScene (qreal x, qreal y) const

QPolygonF	mapFromScene (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromItem (const QGraphicsItem *item, const QRectF &rect) const

QRectF	mapRectFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromParent (const QRectF &rect) const

QRectF	mapRectFromParent (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromScene (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromScene (const QRectF &rect) const

QRectF	mapRectToItem (const QGraphicsItem *item, const QRectF &rect) const

QRectF	mapRectToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectToParent (const QRectF &rect) const

QRectF	mapRectToParent (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectToScene (const QRectF &rect) const

QRectF	mapRectToScene (qreal x, qreal y, qreal w, qreal h) const

QPointF	mapToItem (const QGraphicsItem *item, const QPointF &point) const

QPolygonF	mapToItem (const QGraphicsItem *item, const QRectF &rect) const

QPolygonF	mapToItem (const QGraphicsItem *item, const QPolygonF &polygon) const

QPainterPath	mapToItem (const QGraphicsItem *item, const QPainterPath &path) const

QPointF	mapToItem (const QGraphicsItem *item, qreal x, qreal y) const

QPolygonF	mapToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QPointF	mapToParent (const QPointF &point) const

QPolygonF	mapToParent (const QRectF &rect) const

QPainterPath	mapToParent (const QPainterPath &path) const

QPointF	mapToParent (qreal x, qreal y) const

QPolygonF	mapToParent (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapToParent (const QPolygonF &polygon) const

QPolygonF	mapToScene (const QRectF &rect) const

QPainterPath	mapToScene (const QPainterPath &path) const

QPointF	mapToScene (qreal x, qreal y) const

QPolygonF	mapToScene (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapToScene (const QPolygonF &polygon) const

QPointF	mapToScene (const QPointF &point) const

QMatrix	matrix () const

void	moveBy (qreal dx, qreal dy)

qreal	opacity () const

virtual QPainterPath	opaqueArea () const

virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget)=0

QGraphicsItem *	panel () const

PanelModality	panelModality () const

QGraphicsItem *	parentItem () const

QGraphicsObject *	parentObject () const

QGraphicsWidget *	parentWidget () const

QPointF	pos () const

void	removeSceneEventFilter (QGraphicsItem *filterItem)

void	resetMatrix ()

void	resetTransform ()

void	rotate (qreal angle)

qreal	rotation () const

void	scale (qreal sx, qreal sy)

qreal	scale () const

QGraphicsScene *	scene () const

QRectF	sceneBoundingRect () const

QMatrix	sceneMatrix () const

QPointF	scenePos () const

QTransform	sceneTransform () const

void	scroll (qreal dx, qreal dy, const QRectF &rect)

void	setAcceptDrops (bool on)

void	setAcceptedMouseButtons (QFlags< Qt::MouseButton > buttons)

void	setAcceptHoverEvents (bool enabled)

void	setAcceptsHoverEvents (bool enabled)

void	setAcceptTouchEvents (bool enabled)

void	setActive (bool active)

void	setBoundingRegionGranularity (qreal granularity)

void	setCacheMode (CacheMode mode, const QSize &logicalCacheSize)

void	setCursor (const QCursor &cursor)

void	setData (int key, const QVariant &value)

void	setEnabled (bool enabled)

void	setFiltersChildEvents (bool enabled)

void	setFlag (GraphicsItemFlag flag, bool enabled)

void	setFlags (QFlags< QGraphicsItem::GraphicsItemFlag > flags)

void	setFocus (Qt::FocusReason focusReason)

void	setFocusProxy (QGraphicsItem *item)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setGroup (QGraphicsItemGroup *group)

void	setHandlesChildEvents (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setMatrix (const QMatrix &matrix, bool combine)

void	setOpacity (qreal opacity)

void	setPanelModality (PanelModality panelModality)

void	setParentItem (QGraphicsItem *newParent)

void	setPos (const QPointF &pos)

void	setPos (qreal x, qreal y)

void	setRotation (qreal angle)

void	setScale (qreal factor)

void	setSelected (bool selected)

void	setToolTip (const QString &toolTip)

void	setTransform (const QTransform &matrix, bool combine)

void	setTransformations (const QList< QGraphicsTransform * > &transformations)

void	setTransformOriginPoint (qreal x, qreal y)

void	setTransformOriginPoint (const QPointF &origin)

void	setVisible (bool visible)

void	setX (qreal x)

void	setY (qreal y)

void	setZValue (qreal z)

virtual QPainterPath	shape () const

void	shear (qreal sh, qreal sv)

void	show ()

void	stackBefore (const QGraphicsItem *sibling)

QGraphicsObject *	toGraphicsObject ()

const QGraphicsObject *	toGraphicsObject () const

QString	toolTip () const

QGraphicsItem *	topLevelItem () const

QGraphicsWidget *	topLevelWidget () const

QTransform	transform () const

QList< QGraphicsTransform * >	transformations () const

QPointF	transformOriginPoint () const

void	translate (qreal dx, qreal dy)

virtual int	type () const

void	ungrabKeyboard ()

void	ungrabMouse ()

void	unsetCursor ()

void	update (qreal x, qreal y, qreal width, qreal height)

void	update (const QRectF &rect)

QGraphicsWidget *	window () const

qreal	x () const

qreal	y () const

qreal	zValue () const

Protected Member Functions
void	drawFrame (QPainter *p) const
	Draws the annotation frame to a destination painter. More...

void	drawMarkerSymbol (QPainter *p) const
	Draws the map position marker symbol to a destination painter. More...

void	drawSelectionBoxes (QPainter *p) const
	Draws selection handles around the item. More...

QPointF	pointOnLineWithDistance (QPointF startPoint, 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...

QLineF	segment (int index) const
	Returns frame width in painter units. More...

void	updateBalloon ()
	Check where to attach the balloon connection between frame and map point. More...

void	updateBoundingRect ()

Protected Member Functions inherited from QgsMapCanvasItem
	QgsMapCanvasItem (QgsMapCanvas *mapCanvas)
	protected constructor: cannot be constructed directly More...

virtual	~QgsMapCanvasItem ()

bool	setRenderContextVariables (QPainter *p, QgsRenderContext &context) const
	Sets render context parameters. More...

void	updateCanvas ()
	schedules map canvas for repaint More...

Protected Member Functions inherited from QGraphicsItem
virtual void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)

virtual void	dragEnterEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dragLeaveEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dragMoveEvent (QGraphicsSceneDragDropEvent *event)

virtual void	dropEvent (QGraphicsSceneDragDropEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	hoverEnterEvent (QGraphicsSceneHoverEvent *event)

virtual void	hoverLeaveEvent (QGraphicsSceneHoverEvent *event)

virtual void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

virtual QVariant	itemChange (GraphicsItemChange change, const QVariant &value)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)

virtual void	mousePressEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event)

void	prepareGeometryChange ()

virtual bool	sceneEvent (QEvent *event)

virtual bool	sceneEventFilter (QGraphicsItem watched, QEvent event)

void	updateMicroFocus ()

virtual void	wheelEvent (QGraphicsSceneWheelEvent *event)

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

QRectF	mBoundingRect
	Bounding rect (including item frame and balloon) More...

QColor	mFrameBackgroundColor

double	mFrameBorderWidth
	Width of the frame. More...

QColor	mFrameColor
	Frame / balloon color. More...

QSizeF	mFrameSize
	Size of the frame (without balloon) More...

QgsPoint	mMapPosition
	Map position (in case mMapPositionFixed is true) More...

QgsCoordinateReferenceSystem	mMapPositionCrs
	CRS of the map position. More...

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

QgsMarkerSymbolV2 *	mMarkerSymbol
	Point symbol that is to be drawn at the map reference location. More...

QPointF	mOffsetFromReferencePoint
	Describes the shift of the item content box to the reference point. More...

Protected Attributes inherited from QgsMapCanvasItem
QSizeF	mItemSize
	cached size of the item (to return in boundingRect()) More...

QgsMapCanvas *	mMapCanvas
	pointer to map canvas More...

QPoint	mPanningOffset
	offset from normal position due current panning operation, used when converting map coordinates to move map canvas items More...

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

double	mRectRotation

Additional Inherited Members
Public Attributes inherited from QGraphicsItem
typedef	GraphicsItemFlags

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 35 of file qgsannotationitem.h.

Member Enumeration Documentation

◆ MouseMoveAction

enum QgsAnnotationItem::MouseMoveAction

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

Definition at line 38 of file qgsannotationitem.h.

Constructor & Destructor Documentation

◆ QgsAnnotationItem()

QgsAnnotationItem::QgsAnnotationItem ( QgsMapCanvas * mapCanvas )

Definition at line 26 of file qgsannotationitem.cpp.

◆ ~QgsAnnotationItem()

QgsAnnotationItem::~QgsAnnotationItem ( )

virtual

Definition at line 41 of file qgsannotationitem.cpp.

Member Function Documentation

◆ _readXML()

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

Definition at line 444 of file qgsannotationitem.cpp.

◆ _writeXML()

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

Definition at line 408 of file qgsannotationitem.cpp.

◆ boundingRect()

QRectF QgsAnnotationItem::boundingRect ( ) const

overridevirtual

default implementation for canvas items

Reimplemented from QgsMapCanvasItem.

Definition at line 116 of file qgsannotationitem.cpp.

◆ cursorShapeForAction()

Qt::CursorShape QgsAnnotationItem::cursorShapeForAction ( MouseMoveAction moveAction ) const

Returns suitable cursor shape for mouse move action.

Definition at line 366 of file qgsannotationitem.cpp.

◆ drawFrame()

void QgsAnnotationItem::drawFrame ( QPainter * p ) const

protected

Draws the annotation frame to a destination painter.

Definition at line 200 of file qgsannotationitem.cpp.

◆ drawMarkerSymbol()

void QgsAnnotationItem::drawMarkerSymbol ( QPainter * p ) const

protected

Draws the map position marker symbol to a destination painter.

Definition at line 234 of file qgsannotationitem.cpp.

◆ drawSelectionBoxes()

void QgsAnnotationItem::drawSelectionBoxes ( QPainter * p ) const

protected

Draws selection handles around the item.

Definition at line 255 of file qgsannotationitem.cpp.

◆ frameBackgroundColor()

QColor QgsAnnotationItem::frameBackgroundColor ( ) const

inline

Definition at line 104 of file qgsannotationitem.h.

◆ frameBorderWidth()

double QgsAnnotationItem::frameBorderWidth ( ) const

inline

Definition at line 98 of file qgsannotationitem.h.

◆ frameColor()

QColor QgsAnnotationItem::frameColor ( ) const

inline

Definition at line 101 of file qgsannotationitem.h.

◆ frameSize()

QSizeF QgsAnnotationItem::frameSize ( ) const

inline

Definition at line 88 of file qgsannotationitem.h.

◆ mapPosition()

QgsPoint QgsAnnotationItem::mapPosition ( ) const

inlineoverridevirtual

Returns the map position of the annotation, if it is attached to a fixed map position.

See also: mapPositionFixed(); mapPositionCrs()

Reimplemented from QgsAnnotation.

Definition at line 73 of file qgsannotationitem.h.

◆ mapPositionCrs()

QgsCoordinateReferenceSystem QgsAnnotationItem::mapPositionCrs ( ) const

inlineoverridevirtual

Returns the CRS of the map position.

Reimplemented from QgsAnnotation.

Definition at line 85 of file qgsannotationitem.h.

◆ mapPositionFixed()

bool QgsAnnotationItem::mapPositionFixed ( ) const

inlineoverridevirtual

Returns true if the annotation is attached to a fixed map position, or false if the annotation uses a position relative to the current map extent.

See also: mapPosition(); relativePositon()

Implements QgsAnnotation.

Definition at line 70 of file qgsannotationitem.h.

◆ markerSymbol()

const QgsMarkerSymbolV2* QgsAnnotationItem::markerSymbol ( ) const

inline

Definition at line 95 of file qgsannotationitem.h.

◆ minimumFrameSize()

QSizeF QgsAnnotationItem::minimumFrameSize ( ) const

virtual

Reimplemented in QgsHtmlAnnotationItem, and QgsFormAnnotationItem.

Definition at line 121 of file qgsannotationitem.cpp.

◆ moveActionForPosition()

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

Returns the mouse move behaviour for a given position.

Parameters

pos	the position in scene coordinates

Definition at line 307 of file qgsannotationitem.cpp.

◆ offsetFromReferencePoint()

QPointF QgsAnnotationItem::offsetFromReferencePoint ( ) const

inline

Definition at line 91 of file qgsannotationitem.h.

◆ paint() [1/2]

void QgsAnnotationItem::paint	(	QPainter *	painter,
		const QStyleOptionGraphicsItem *	option,
		QWidget *	widget = `nullptr`
	)

overridevirtual

Paint the annotation to a destination painter.

Implements QgsAnnotation.

Reimplemented in QgsHtmlAnnotationItem, and QgsFormAnnotationItem.

Definition at line 498 of file qgsannotationitem.cpp.

◆ paint() [2/2]

void QgsAnnotationItem::paint ( QPainter * painter )

overridevirtual

function to be implemented by derived classes

Implements QgsMapCanvasItem.

Reimplemented in QgsTextAnnotationItem, QgsHtmlAnnotationItem, QgsSvgAnnotationItem, and QgsFormAnnotationItem.

Definition at line 504 of file qgsannotationitem.cpp.

◆ pointOnLineWithDistance()

QPointF QgsAnnotationItem::pointOnLineWithDistance	(	QPointF	startPoint,
		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 298 of file qgsannotationitem.cpp.

◆ readXML()

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

pure virtual

Implemented in QgsHtmlAnnotationItem, QgsFormAnnotationItem, QgsTextAnnotationItem, and QgsSvgAnnotationItem.

◆ relativePosition()

QPointF QgsAnnotationItem::relativePosition ( ) const

overridevirtual

Returns the relative position of the annotation, if it is not attached to a fixed map position.

The coordinates in the return point should be between 0 and 1, and represent the relative percentage for the position compared to the map width and height.

See also: mapPositionFixed()

Reimplemented from QgsAnnotation.

Definition at line 60 of file qgsannotationitem.cpp.

◆ scaledSymbolSize()

double QgsAnnotationItem::scaledSymbolSize ( ) const

protected

Returns the symbol size scaled in (mapcanvas) pixels.

Used for the counding rect calculation

Definition at line 392 of file qgsannotationitem.cpp.

◆ scaleFactor()

double QgsAnnotationItem::scaleFactor ( ) const

overridevirtual

Returns a scaling factor which should be applied to painters before rendering the item.

Implements QgsAnnotation.

Definition at line 67 of file qgsannotationitem.cpp.

◆ segment()

QLineF QgsAnnotationItem::segment ( int index ) const

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

◆ setFrameBackgroundColor()

void QgsAnnotationItem::setFrameBackgroundColor ( const QColor & c )

inline

Definition at line 103 of file qgsannotationitem.h.

◆ setFrameBorderWidth()

void QgsAnnotationItem::setFrameBorderWidth ( double w )

inline

Definition at line 97 of file qgsannotationitem.h.

◆ setFrameColor()

void QgsAnnotationItem::setFrameColor ( const QColor & c )

inline

Definition at line 100 of file qgsannotationitem.h.

◆ setFrameSize()

void QgsAnnotationItem::setFrameSize ( QSizeF size )

Definition at line 226 of file qgsannotationitem.cpp.

◆ setItemData()

void QgsAnnotationItem::setItemData	(	int	role,
		const QVariant &	value
	)

overridevirtual

deprecated - do not use

Implements QgsAnnotation.

Definition at line 493 of file qgsannotationitem.cpp.

◆ setMapPosition()

void QgsAnnotationItem::setMapPosition ( const QgsPoint & pos )

virtual

Reimplemented in QgsHtmlAnnotationItem, and QgsFormAnnotationItem.

Definition at line 53 of file qgsannotationitem.cpp.

◆ setMapPositionCrs()

void QgsAnnotationItem::setMapPositionCrs ( const QgsCoordinateReferenceSystem & crs )

virtual

Sets the CRS of the map position.

Parameters

crs	the CRS to set

Definition at line 72 of file qgsannotationitem.cpp.

◆ setMapPositionFixed()

void QgsAnnotationItem::setMapPositionFixed ( bool fixed )

Definition at line 84 of file qgsannotationitem.cpp.

◆ setMarkerSymbol()

void QgsAnnotationItem::setMarkerSymbol ( QgsMarkerSymbolV2 * symbol )

Set symbol that is drawn on map position.

Takes ownership

Definition at line 46 of file qgsannotationitem.cpp.

◆ setOffsetFromReferencePoint()

void QgsAnnotationItem::setOffsetFromReferencePoint ( QPointF offset )

Definition at line 77 of file qgsannotationitem.cpp.

◆ showItem()

virtual bool QgsAnnotationItem::showItem ( ) const

inlineoverridevirtual

Returns true if the annotation should be shown.

Implements QgsAnnotation.

Definition at line 79 of file qgsannotationitem.h.

◆ updateBalloon()

void QgsAnnotationItem::updateBalloon ( )

protected

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

Definition at line 142 of file qgsannotationitem.cpp.

◆ updateBoundingRect()

void QgsAnnotationItem::updateBoundingRect ( )

protected

Definition at line 126 of file qgsannotationitem.cpp.

◆ updatePosition()

void QgsAnnotationItem::updatePosition ( )

overridevirtual

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

Reimplemented from QgsMapCanvasItem.

Definition at line 103 of file qgsannotationitem.cpp.

◆ writeXML()

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

pure virtual

Implemented in QgsHtmlAnnotationItem, QgsFormAnnotationItem, QgsTextAnnotationItem, and QgsSvgAnnotationItem.

Member Data Documentation

◆ mBalloonSegment

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 143 of file qgsannotationitem.h.

◆ mBalloonSegmentPoint1

QPointF QgsAnnotationItem::mBalloonSegmentPoint1

protected

First segment point for drawing the connection (ccw direction)

Definition at line 145 of file qgsannotationitem.h.

◆ mBalloonSegmentPoint2

QPointF QgsAnnotationItem::mBalloonSegmentPoint2

protected

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

Definition at line 147 of file qgsannotationitem.h.

◆ mBoundingRect

QRectF QgsAnnotationItem::mBoundingRect

protected

Bounding rect (including item frame and balloon)

Definition at line 132 of file qgsannotationitem.h.

◆ mFrameBackgroundColor

QColor QgsAnnotationItem::mFrameBackgroundColor

protected

Definition at line 140 of file qgsannotationitem.h.

◆ mFrameBorderWidth

double QgsAnnotationItem::mFrameBorderWidth

protected

Width of the frame.

Definition at line 137 of file qgsannotationitem.h.

◆ mFrameColor

QColor QgsAnnotationItem::mFrameColor

protected

Frame / balloon color.

Definition at line 139 of file qgsannotationitem.h.

◆ mFrameSize

QSizeF QgsAnnotationItem::mFrameSize

protected

Size of the frame (without balloon)

Definition at line 130 of file qgsannotationitem.h.

◆ mMapPosition

QgsPoint QgsAnnotationItem::mMapPosition

protected

Map position (in case mMapPositionFixed is true)

Definition at line 122 of file qgsannotationitem.h.

◆ mMapPositionCrs

QgsCoordinateReferenceSystem QgsAnnotationItem::mMapPositionCrs

protected

CRS of the map position.

Definition at line 124 of file qgsannotationitem.h.

◆ mMapPositionFixed

bool QgsAnnotationItem::mMapPositionFixed

protected

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

Definition at line 120 of file qgsannotationitem.h.

◆ mMarkerSymbol

QgsMarkerSymbolV2* QgsAnnotationItem::mMarkerSymbol

protected

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

Definition at line 135 of file qgsannotationitem.h.

◆ mOffsetFromReferencePoint

QPointF QgsAnnotationItem::mOffsetFromReferencePoint

protected

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

Definition at line 127 of file qgsannotationitem.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/gui/qgsannotationitem.h
/tmp/buildd/qgis-2.18.21+99unstable/src/gui/qgsannotationitem.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MouseMoveAction

Constructor & Destructor Documentation

◆ QgsAnnotationItem()

◆ ~QgsAnnotationItem()

Member Function Documentation

◆ _readXML()

◆ _writeXML()

◆ boundingRect()

◆ cursorShapeForAction()

◆ drawFrame()

◆ drawMarkerSymbol()

◆ drawSelectionBoxes()

◆ frameBackgroundColor()

◆ frameBorderWidth()

◆ frameColor()

◆ frameSize()

◆ mapPosition()

◆ mapPositionCrs()

◆ mapPositionFixed()

◆ markerSymbol()

◆ minimumFrameSize()

◆ moveActionForPosition()

◆ offsetFromReferencePoint()

◆ paint() [1/2]

◆ paint() [2/2]

◆ pointOnLineWithDistance()

◆ readXML()

◆ relativePosition()

◆ scaledSymbolSize()

◆ scaleFactor()

◆ segment()

◆ setFrameBackgroundColor()

◆ setFrameBorderWidth()

◆ setFrameColor()

◆ setFrameSize()

◆ setItemData()

◆ setMapPosition()

◆ setMapPositionCrs()

◆ setMapPositionFixed()

◆ setMarkerSymbol()

◆ setOffsetFromReferencePoint()

◆ showItem()

◆ updateBalloon()

◆ updateBoundingRect()

◆ updatePosition()

◆ writeXML()

Member Data Documentation

◆ mBalloonSegment

◆ mBalloonSegmentPoint1

◆ mBalloonSegmentPoint2

◆ mBoundingRect

◆ mFrameBackgroundColor

◆ mFrameBorderWidth

◆ mFrameColor

◆ mFrameSize

◆ mMapPosition

◆ mMapPositionCrs

◆ mMapPositionFixed

◆ mMarkerSymbol

◆ mOffsetFromReferencePoint