QGIS API Documentation  2.5.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
[legend]

Public Member Functions

 QgsHtmlAnnotationItem (QgsMapCanvas *canvas, QgsVectorLayer *vlayer=0, bool hasFeature=false, int feature=0)
 
 ~QgsHtmlAnnotationItem ()
 
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...
 
QSizeF minimumFrameSize () const
 
void setMapPosition (const QgsPoint &pos)
 Reimplemented from QgsAnnotationItem. More...
 
void setHTMLPage (const QString &htmlFile)
 
QString htmlPage () const
 
void writeXML (QDomDocument &doc) const
 
void readXML (const QDomDocument &doc, const QDomElement &itemElem)
 
QgsVectorLayervectorLayer () const
 
- 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 More...
 
QRectF boundingRect () const
 default implementation for canvas items More...
 
QgsAnnotationItem::MouseMoveAction moveActionForPosition (const QPointF &pos) const
 Returns the mouse move behaviour for a given position. More...
 
Qt::CursorShape cursorShapeForAction (MouseMoveAction moveAction) const
 Returns suitable cursor shape for mouse move action. More...
 
void setMapPositionFixed (bool fixed)
 
bool mapPositionFixed () const
 
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. More...
 
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
Q_DECL_DEPRECATED void setPanningOffset (const QPoint &point)
 sets current offset, to be called from QgsMapCanvas More...
 
QgsRectangle rect () const
 returns canvas item rectangle More...
 
void setRect (const QgsRectangle &r)
 sets canvas item rectangle More...
 
QgsPoint toMapCoordinates (const QPoint &point)
 transformation from screen coordinates to map coordinates More...
 
QPointF toCanvasCoordinates (const QgsPoint &point)
 transformation from map coordinates to screen 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 updateBoundingRect ()
 
void updateBalloon ()
 Check where to attach the balloon connection between frame and map point. More...
 
void drawFrame (QPainter *p)
 
void drawMarkerSymbol (QPainter *p)
 
void drawSelectionBoxes (QPainter *p)
 
QLineF segment (int index)
 Returns frame width in painter units. More...
 
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...
 
- Protected Member Functions inherited from QgsMapCanvasItem
 QgsMapCanvasItem (QgsMapCanvas *mapCanvas)
 protected constructor: cannot be constructed directly More...
 
virtual ~QgsMapCanvasItem ()
 
void updateCanvas ()
 schedules map canvas for repaint More...
 
bool setRenderContextVariables (QPainter *p, QgsRenderContext &context) const
 Sets render context parameters. More...
 
- Protected Attributes inherited from QgsAnnotationItem
bool mMapPositionFixed
 True: the item stays at the same map position, False: the item stays on same screen position. More...
 
QgsPoint mMapPosition
 Map position (in case mMapPositionFixed is true) More...
 
QPointF mOffsetFromReferencePoint
 Describes the shift of the item content box to the reference point. More...
 
QSizeF mFrameSize
 Size of the frame (without balloon) More...
 
QRectF mBoundingRect
 Bounding rect (including item frame and balloon) More...
 
QgsMarkerSymbolV2mMarkerSymbol
 Point symbol that is to be drawn at the map reference location. More...
 
double mFrameBorderWidth
 Width of the frame. More...
 
QColor mFrameColor
 Frame / balloon color. More...
 
QColor mFrameBackgroundColor
 
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...
 
- Protected Attributes inherited from QgsMapCanvasItem
QgsMapCanvasmMapCanvas
 pointer to map canvas More...
 
QgsRectangle mRect
 canvas item rectangle (in map coordinates) More...
 
QPoint mPanningOffset
 offset from normal position due current panning operation, used when converting map coordinates to move map canvas items More...
 
QSizeF mItemSize
 cached size of the item (to return in boundingRect()) More...
 

Detailed Description

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

Constructor & Destructor Documentation

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

Member Function Documentation

QString QgsHtmlAnnotationItem::htmlPage ( ) const
inline
QSizeF QgsHtmlAnnotationItem::minimumFrameSize ( ) const
virtual

Reimplemented from QgsAnnotationItem.

void QgsHtmlAnnotationItem::paint ( QPainter *  painter)
virtual

function to be implemented by derived classes

Implements QgsMapCanvasItem.

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

paint function called by map canvas

Reimplemented from QgsMapCanvasItem.

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

Implements QgsAnnotationItem.

void QgsHtmlAnnotationItem::setHTMLPage ( const QString &  htmlFile)
void QgsHtmlAnnotationItem::setMapPosition ( const QgsPoint pos)
virtual

Reimplemented from QgsAnnotationItem.

Reimplemented from QgsAnnotationItem.

QgsVectorLayer* QgsHtmlAnnotationItem::vectorLayer ( ) const
inline
void QgsHtmlAnnotationItem::writeXML ( QDomDocument &  doc) const
virtual

Implements QgsAnnotationItem.


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