QGIS API Documentation  2.8.2-Wien
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsTextAnnotationItem Class Reference

An annotation item that displays formated text. More...

#include <qgstextannotationitem.h>

Inheritance diagram for QgsTextAnnotationItem:
Inheritance graph
[legend]

Public Member Functions

 QgsTextAnnotationItem (QgsMapCanvas *canvas)
 ~QgsTextAnnotationItem ()
QTextDocument * document () const
 Returns document (caller takes ownership)
void paint (QPainter *painter) override
 function to be implemented by derived classes
void readXML (const QDomDocument &doc, const QDomElement &itemElem) override
void setDocument (const QTextDocument *doc)
 Sets document (does not take ownership)
void writeXML (QDomDocument &doc) const override
- Public Member Functions inherited from QgsAnnotationItem
 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 QgsMarkerSymbolV2markerSymbol () const
virtual QSizeF minimumFrameSize () const
QgsAnnotationItem::MouseMoveAction moveActionForPosition (const QPointF &pos) const
 Returns the mouse move behaviour for a given position.
QPointF offsetFromReferencePoint () const
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
- 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

Additional Inherited Members

- Public Types inherited from QgsAnnotationItem
enum  MouseMoveAction {
  NoAction, MoveMapPosition, MoveFramePosition, ResizeFrameUp,
  ResizeFrameDown, ResizeFrameLeft, ResizeFrameRight, ResizeFrameLeftUp,
  ResizeFrameRightUp, ResizeFrameLeftDown, ResizeFrameRightDown
}
- Protected Member Functions inherited from QgsAnnotationItem
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 Attributes inherited from QgsAnnotationItem
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.
QgsMarkerSymbolV2mMarkerSymbol
 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.

Detailed Description

An annotation item that displays formated text.

Definition at line 25 of file qgstextannotationitem.h.

Constructor & Destructor Documentation

QgsTextAnnotationItem::QgsTextAnnotationItem ( QgsMapCanvas canvas)

Definition at line 22 of file qgstextannotationitem.cpp.

QgsTextAnnotationItem::~QgsTextAnnotationItem ( )

Definition at line 27 of file qgstextannotationitem.cpp.

Member Function Documentation

QTextDocument * QgsTextAnnotationItem::document ( ) const

Returns document (caller takes ownership)

Definition at line 32 of file qgstextannotationitem.cpp.

void QgsTextAnnotationItem::paint ( QPainter *  painter)
overridevirtual

function to be implemented by derived classes

Implements QgsMapCanvasItem.

Definition at line 48 of file qgstextannotationitem.cpp.

void QgsTextAnnotationItem::readXML ( const QDomDocument &  doc,
const QDomElement &  itemElem 
)
overridevirtual

Implements QgsAnnotationItem.

Definition at line 100 of file qgstextannotationitem.cpp.

void QgsTextAnnotationItem::setDocument ( const QTextDocument *  doc)

Sets document (does not take ownership)

Definition at line 42 of file qgstextannotationitem.cpp.

void QgsTextAnnotationItem::writeXML ( QDomDocument &  doc) const
overridevirtual

Implements QgsAnnotationItem.

Definition at line 84 of file qgstextannotationitem.cpp.


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