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

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

#include <qgstextannotationitem.h>

Inheritance diagram for QgsTextAnnotationItem:
Inheritance graph
Collaboration diagram for QgsTextAnnotationItem:
Collaboration graph

Public Member Functions

 QgsTextAnnotationItem (QgsMapCanvas *canvas)
 ~QgsTextAnnotationItem ()
QTextDocument * document () const
 Returns document (caller takes ownership)
void setDocument (const QTextDocument *doc)
 Sets document (does not take ownership)
void writeXML (QDomDocument &doc) const
void readXML (const QDomDocument &doc, const QDomElement &itemElem)
void paint (QPainter *painter)
 function to be implemented by derived classes
- Public Member Functions inherited from QgsAnnotationItem
 QgsAnnotationItem (QgsMapCanvas *mapCanvas)
virtual ~QgsAnnotationItem ()
void updatePosition ()
 called on changed extent or resize event to update position of the item
QRectF boundingRect () const
 default implementation for canvas items
virtual QSizeF minimumFrameSize () const
QgsAnnotationItem::MouseMoveAction moveActionForPosition (const QPointF &pos) const
 Returns the mouse move behaviour for a given position.
Qt::CursorShape cursorShapeForAction (MouseMoveAction moveAction) const
 Returns suitable cursor shape for mouse move action.
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.
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
void _writeXML (QDomDocument &doc, QDomElement &itemElem) const
void _readXML (const QDomDocument &doc, const QDomElement &annotationElem)
- Public Member Functions inherited from QgsMapCanvasItem
void setPanningOffset (const QPoint &point)
 sets current offset, to be called from QgsMapCanvas
QgsRectangle rect () const
 returns canvas item rectangle
void setRect (const QgsRectangle &r)
 sets canvas item rectangle
QgsPoint toMapCoordinates (const QPoint &point)
 transformation from screen coordinates to map coordinates
QPointF toCanvasCoordinates (const QgsPoint &point)
 transformation from map coordinates to screen coordinates

Private Attributes

QTextDocument * mDocument

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 updateBoundingRect ()
void updateBalloon ()
 Check where to attach the balloon connection between frame and map point.
void drawFrame (QPainter *p)
void drawMarkerSymbol (QPainter *p)
void drawSelectionBoxes (QPainter *p)
QLineF segment (int index)
 Returns frame width in painter units.
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.
- Protected Attributes inherited from QgsAnnotationItem
bool mMapPositionFixed
 True: the item stays at the same map position, False: the item stays on same screen position.
QgsPoint mMapPosition
 Map position (in case mMapPositionFixed is true)
QPointF mOffsetFromReferencePoint
 Describes the shift of the item content box to the reference point.
QSizeF mFrameSize
 Size of the frame (without balloon)
QRectF mBoundingRect
 Bounding rect (including item frame and balloon)
 Point symbol that is to be drawn at the map reference location.
double mFrameBorderWidth
 Width of the frame.
QColor mFrameColor
 Frame / balloon color.
QColor mFrameBackgroundColor
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)

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.

References mDocument.

QgsTextAnnotationItem::~QgsTextAnnotationItem ( )

Definition at line 27 of file qgstextannotationitem.cpp.

References mDocument.

Member Function Documentation

QTextDocument * QgsTextAnnotationItem::document ( ) const

Returns document (caller takes ownership)

Definition at line 32 of file qgstextannotationitem.cpp.

References mDocument.

void QgsTextAnnotationItem::paint ( QPainter *  painter)
void QgsTextAnnotationItem::readXML ( const QDomDocument &  doc,
const QDomElement &  itemElem 

Implements QgsAnnotationItem.

Definition at line 92 of file qgstextannotationitem.cpp.

References QgsAnnotationItem::_readXML(), mDocument, and tr.

void QgsTextAnnotationItem::setDocument ( const QTextDocument *  doc)

Sets document (does not take ownership)

Definition at line 42 of file qgstextannotationitem.cpp.

References mDocument.

void QgsTextAnnotationItem::writeXML ( QDomDocument &  doc) const

Implements QgsAnnotationItem.

Definition at line 76 of file qgstextannotationitem.cpp.

References QgsAnnotationItem::_writeXML(), and mDocument.

Member Data Documentation

QTextDocument* QgsTextAnnotationItem::mDocument

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