QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsAnnotationItemNode Class Reference

Contains information about a node used for editing an annotation item. More...

#include <qgsannotationitemnode.h>

Public Member Functions

 QgsAnnotationItemNode ()=default
 
 QgsAnnotationItemNode (const QgsVertexId &id, const QgsPointXY &point, Qgis::AnnotationItemNodeType type, Qt::CursorShape cursor=Qt::CursorShape::ArrowCursor)
 Constructor for QgsAnnotationItemNode, with the specified id, point and type.
 
Qt::CursorShape cursor () const
 Returns the mouse cursor shape to use when hovering the node.
 
QgsVertexId id () const
 Returns the ID number of the node, used for uniquely identifying the node in the item.
 
bool operator!= (const QgsAnnotationItemNode &other) const
 
bool operator== (const QgsAnnotationItemNode &other) const
 
QgsPointXY point () const
 Returns the node's position, in geographic coordinates.
 
void setCursor (Qt::CursorShape shape)
 Sets the mouse cursor shape to use when hovering the node.
 
void setPoint (QgsPointXY point)
 Sets the node's position, in geographic coordinates.
 
void setType (Qgis::AnnotationItemNodeType type)
 Sets the node type.
 
Qgis::AnnotationItemNodeType type () const
 Returns the node type.
 

Detailed Description

Contains information about a node used for editing an annotation item.

Since
QGIS 3.22

Definition at line 31 of file qgsannotationitemnode.h.

Constructor & Destructor Documentation

◆ QgsAnnotationItemNode() [1/2]

QgsAnnotationItemNode::QgsAnnotationItemNode ( )
default

◆ QgsAnnotationItemNode() [2/2]

QgsAnnotationItemNode::QgsAnnotationItemNode ( const QgsVertexId id,
const QgsPointXY point,
Qgis::AnnotationItemNodeType  type,
Qt::CursorShape  cursor = Qt::CursorShape::ArrowCursor 
)
inline

Constructor for QgsAnnotationItemNode, with the specified id, point and type.

Definition at line 40 of file qgsannotationitemnode.h.

Member Function Documentation

◆ cursor()

Qt::CursorShape QgsAnnotationItemNode::cursor ( ) const
inline

Returns the mouse cursor shape to use when hovering the node.

See also
setCursor()
Since
QGIS 3.34

Definition at line 101 of file qgsannotationitemnode.h.

◆ id()

QgsVertexId QgsAnnotationItemNode::id ( ) const
inline

Returns the ID number of the node, used for uniquely identifying the node in the item.

Definition at line 61 of file qgsannotationitemnode.h.

◆ operator!=()

bool QgsAnnotationItemNode::operator!= ( const QgsAnnotationItemNode other) const
inline

Definition at line 123 of file qgsannotationitemnode.h.

◆ operator==()

bool QgsAnnotationItemNode::operator== ( const QgsAnnotationItemNode other) const
inline

Definition at line 118 of file qgsannotationitemnode.h.

◆ point()

QgsPointXY QgsAnnotationItemNode::point ( ) const
inline

Returns the node's position, in geographic coordinates.

The coordinates will match the annotation item's CRS.

See also
setPoint()

Definition at line 70 of file qgsannotationitemnode.h.

◆ setCursor()

void QgsAnnotationItemNode::setCursor ( Qt::CursorShape  shape)
inline

Sets the mouse cursor shape to use when hovering the node.

See also
cursor()
Since
QGIS 3.34

Definition at line 112 of file qgsannotationitemnode.h.

◆ setPoint()

void QgsAnnotationItemNode::setPoint ( QgsPointXY  point)
inline

Sets the node's position, in geographic coordinates.

The coordinates will match the annotation item's CRS.

See also
point()

Definition at line 79 of file qgsannotationitemnode.h.

◆ setType()

void QgsAnnotationItemNode::setType ( Qgis::AnnotationItemNodeType  type)
inline

Sets the node type.

See also
type()

Definition at line 93 of file qgsannotationitemnode.h.

◆ type()

Qgis::AnnotationItemNodeType QgsAnnotationItemNode::type ( ) const
inline

Returns the node type.

See also
setType()

Definition at line 86 of file qgsannotationitemnode.h.


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