QGIS API Documentation  3.25.0-Master (dec16ba68b)
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
 Default constructor. More...
 
 QgsAnnotationItemNode (const QgsVertexId &id, const QgsPointXY &point, Qgis::AnnotationItemNodeType type)
 Constructor for QgsAnnotationItemNode, with the specified id, point and type. More...
 
QgsVertexId id () const
 Returns the ID number of the node, used for uniquely identifying the node in the item. More...
 
bool operator!= (const QgsAnnotationItemNode &other) const
 
bool operator== (const QgsAnnotationItemNode &other) const
 
QgsPointXY point () const
 Returns the node's position, in geographic coordinates. More...
 
void setPoint (QgsPointXY point)
 Sets the node's position, in geographic coordinates. More...
 
void setType (Qgis::AnnotationItemNodeType type)
 Sets the node type. More...
 
Qgis::AnnotationItemNodeType type () const
 Returns the node type. More...
 

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

Default constructor.

◆ QgsAnnotationItemNode() [2/2]

QgsAnnotationItemNode::QgsAnnotationItemNode ( const QgsVertexId id,
const QgsPointXY point,
Qgis::AnnotationItemNodeType  type 
)
inline

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

Definition at line 43 of file qgsannotationitemnode.h.

Member Function Documentation

◆ 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 63 of file qgsannotationitemnode.h.

◆ operator!=()

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

Definition at line 103 of file qgsannotationitemnode.h.

◆ operator==()

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

Definition at line 98 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 72 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 81 of file qgsannotationitemnode.h.

◆ setType()

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

Sets the node type.

See also
type()

Definition at line 95 of file qgsannotationitemnode.h.

◆ type()

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

Returns the node type.

See also
setType()

Definition at line 88 of file qgsannotationitemnode.h.


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