QGIS API Documentation  2.99.0-Master (19b062c)
Public Types | Public Member Functions | List of all members
QgsMapCanvasAnnotationItem Class Reference

An interactive map canvas item which displays a QgsAnnotation. More...

#include <qgsmapcanvasannotationitem.h>

Inheritance diagram for QgsMapCanvasAnnotationItem:
Inheritance graph
[legend]

Public Types

enum  MouseMoveAction {
  NoAction, MoveMapPosition, MoveFramePosition, ResizeFrameUp,
  ResizeFrameDown, ResizeFrameLeft, ResizeFrameRight, ResizeFrameLeftUp,
  ResizeFrameRightUp, ResizeFrameLeftDown, ResizeFrameRightDown
}
 Mouse actions for interacting with item. More...
 

Public Member Functions

 QgsMapCanvasAnnotationItem (QgsAnnotation *annotation, QgsMapCanvas *mapCanvas)
 Constructor for QgsMapCanvasAnnotationItem. More...
 
const QgsAnnotationannotation () const
 Returns the item's annotation. More...
 
QgsAnnotationannotation ()
 Returns the item's annotation. More...
 
QRectF boundingRect () const override
 
Qt::CursorShape cursorShapeForAction (MouseMoveAction moveAction) const
 Returns matching cursor shape for a mouse move action. More...
 
MouseMoveAction moveActionForPosition (QPointF pos) const
 Returns the mouse move behavior for a given position in scene coordinates. More...
 
void paint (QPainter *painter) override
 function to be implemented by derived classes More...
 
void updatePosition () override
 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 in map units More...
 
void setRect (const QgsRectangle &r, bool resetRotation=true)
 sets canvas item rectangle in map units More...
 
QPointF toCanvasCoordinates (const QgsPointXY &point) const
 transformation from map coordinates to screen coordinates More...
 
QgsPointXY toMapCoordinates (QPoint point) const
 transformation from screen coordinates to map coordinates More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsMapCanvasItem
 QgsMapCanvasItem (QgsMapCanvas *mapCanvas)
 protected constructor: cannot be constructed directly More...
 
virtual ~QgsMapCanvasItem ()
 
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=nullptr) override
 
bool setRenderContextVariables (QPainter *p, QgsRenderContext &context) const
 Sets render context parameters. More...
 
void updateCanvas ()
 schedules map canvas for repaint More...
 
- Protected Attributes inherited from QgsMapCanvasItem
QSizeF mItemSize
 cached size of the item (to return in boundingRect()) More...
 
QgsMapCanvasmMapCanvas = nullptr
 pointer to map canvas 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
 

Detailed Description

An interactive map canvas item which displays a QgsAnnotation.

Since
QGIS 3.0

Definition at line 32 of file qgsmapcanvasannotationitem.h.

Member Enumeration Documentation

◆ MouseMoveAction

Mouse actions for interacting with item.

Enumerator
NoAction 

No action.

MoveMapPosition 

Moving annotation map position.

MoveFramePosition 

Moving position of frame relative to annotation.

ResizeFrameUp 

Resize frame up.

ResizeFrameDown 

Resize frame down.

ResizeFrameLeft 

Resize frame left.

ResizeFrameRight 

Resize frame right.

ResizeFrameLeftUp 

Resize frame left up.

ResizeFrameRightUp 

Resize frame right up.

ResizeFrameLeftDown 

Resize frame left down.

ResizeFrameRightDown 

Resize frame right down.

Definition at line 39 of file qgsmapcanvasannotationitem.h.

Constructor & Destructor Documentation

◆ QgsMapCanvasAnnotationItem()

QgsMapCanvasAnnotationItem::QgsMapCanvasAnnotationItem ( QgsAnnotation annotation,
QgsMapCanvas mapCanvas 
)

Constructor for QgsMapCanvasAnnotationItem.

Definition at line 31 of file qgsmapcanvasannotationitem.cpp.

Member Function Documentation

◆ annotation() [1/2]

const QgsAnnotation* QgsMapCanvasAnnotationItem::annotation ( ) const
inline

Returns the item's annotation.

Note
not available in Python bindings

Definition at line 63 of file qgsmapcanvasannotationitem.h.

◆ annotation() [2/2]

QgsAnnotation* QgsMapCanvasAnnotationItem::annotation ( )
inline

Returns the item's annotation.

Definition at line 68 of file qgsmapcanvasannotationitem.h.

◆ boundingRect()

QRectF QgsMapCanvasAnnotationItem::boundingRect ( ) const
overridevirtual

Reimplemented from QgsMapCanvasItem.

Definition at line 84 of file qgsmapcanvasannotationitem.cpp.

◆ cursorShapeForAction()

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

Returns matching cursor shape for a mouse move action.

Definition at line 246 of file qgsmapcanvasannotationitem.cpp.

◆ moveActionForPosition()

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

Returns the mouse move behavior for a given position in scene coordinates.

Definition at line 183 of file qgsmapcanvasannotationitem.cpp.

◆ paint()

void QgsMapCanvasAnnotationItem::paint ( QPainter *  painter)
overridevirtual

function to be implemented by derived classes

Implements QgsMapCanvasItem.

Definition at line 288 of file qgsmapcanvasannotationitem.cpp.

◆ updatePosition()

void QgsMapCanvasAnnotationItem::updatePosition ( )
overridevirtual

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

Reimplemented from QgsMapCanvasItem.

Definition at line 56 of file qgsmapcanvasannotationitem.cpp.


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