QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
QgsHtmlAnnotationItem Class Reference

An annotation item that embedds a designer form showing the feature attribute. More...

#include <qgshtmlannotationitem.h>

Inheritance diagram for QgsHtmlAnnotationItem:
Inheritance graph

Public Member Functions

 QgsHtmlAnnotationItem (QgsMapCanvas *canvas, QgsVectorLayer *vlayer=0, bool hasFeature=false, int feature=0)
 ~QgsHtmlAnnotationItem ()
QString htmlPage () const
QSizeF minimumFrameSize () const
void paint (QPainter *painter)
 function to be implemented by derived classes More...
void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=0)
 paint function called by map canvas More...
void readXML (const QDomDocument &doc, const QDomElement &itemElem)
void setHTMLPage (const QString &htmlFile)
void setMapPosition (const QgsPoint &pos)
 Reimplemented from QgsAnnotationItem. More...
QgsVectorLayervectorLayer () const
void writeXML (QDomDocument &doc) const
- 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
 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
bool mapPositionFixed () const
const QgsMarkerSymbolV2markerSymbol () const
QgsAnnotationItem::MouseMoveAction moveActionForPosition (const QPointF &pos) const
 Returns the mouse move behaviour for a given position. More...
QPointF offsetFromReferencePoint () const
void setFrameBackgroundColor (const QColor &c)
void setFrameBorderWidth (double w)
void setFrameColor (const QColor &c)
void setFrameSize (const QSizeF &size)
void setMapPositionFixed (bool fixed)
void setMarkerSymbol (QgsMarkerSymbolV2 *symbol)
 Set symbol that is drawn on map position. More...
void setOffsetFromReferencePoint (const QPointF &offset)
void updatePosition ()
 called on changed extent or resize event to update position of the item More...
- Public Member Functions inherited from QgsMapCanvasItem
QgsRectangle rect () const
 returns canvas item rectangle More...
Q_DECL_DEPRECATED void setPanningOffset (const QPoint &point)
 sets current offset, to be called from QgsMapCanvas More...
void setRect (const QgsRectangle &r)
 sets canvas item rectangle More...
QPointF toCanvasCoordinates (const QgsPoint &point)
 transformation from map coordinates to screen coordinates More...
QgsPoint toMapCoordinates (const QPoint &point)
 transformation from screen coordinates to map coordinates More...

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. More...
double scaledSymbolSize () const
 Returns the symbol size scaled in (mapcanvas) pixels. More...
QLineF segment (int index)
 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 Attributes inherited from QgsAnnotationItem
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...
bool mMapPositionFixed
 True: the item stays at the same map position, False: the item stays on same screen position. More...
 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...
 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
 canvas item rectangle (in map coordinates) More...

Detailed Description

An annotation item that embedds a designer form showing the feature attribute.

Definition at line 30 of file qgshtmlannotationitem.h.

Constructor & Destructor Documentation

QgsHtmlAnnotationItem::QgsHtmlAnnotationItem ( QgsMapCanvas canvas,
QgsVectorLayer vlayer = 0,
bool  hasFeature = false,
int  feature = 0 

Definition at line 39 of file qgshtmlannotationitem.cpp.

QgsHtmlAnnotationItem::~QgsHtmlAnnotationItem ( )

Definition at line 61 of file qgshtmlannotationitem.cpp.

Member Function Documentation

QString QgsHtmlAnnotationItem::htmlPage ( ) const

Definition at line 48 of file qgshtmlannotationitem.h.

QSizeF QgsHtmlAnnotationItem::minimumFrameSize ( ) const

Reimplemented from QgsAnnotationItem.

Definition at line 125 of file qgshtmlannotationitem.cpp.

void QgsHtmlAnnotationItem::paint ( QPainter *  painter)

function to be implemented by derived classes

Implements QgsMapCanvasItem.

Definition at line 91 of file qgshtmlannotationitem.cpp.

void QgsHtmlAnnotationItem::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  option,
QWidget *  widget = 0 

paint function called by map canvas

Reimplemented from QgsMapCanvasItem.

Definition at line 96 of file qgshtmlannotationitem.cpp.

void QgsHtmlAnnotationItem::readXML ( const QDomDocument &  doc,
const QDomElement &  itemElem 

Implements QgsAnnotationItem.

Definition at line 159 of file qgshtmlannotationitem.cpp.

void QgsHtmlAnnotationItem::setHTMLPage ( const QString &  htmlFile)

Definition at line 66 of file qgshtmlannotationitem.cpp.

void QgsHtmlAnnotationItem::setMapPosition ( const QgsPoint pos)

Reimplemented from QgsAnnotationItem.

Reimplemented from QgsAnnotationItem.

Definition at line 85 of file qgshtmlannotationitem.cpp.

QgsVectorLayer* QgsHtmlAnnotationItem::vectorLayer ( ) const

Definition at line 53 of file qgshtmlannotationitem.h.

void QgsHtmlAnnotationItem::writeXML ( QDomDocument &  doc) const

Implements QgsAnnotationItem.

Definition at line 138 of file qgshtmlannotationitem.cpp.

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