QgsCalloutPosition Class Reference

Represents the calculated placement of a map label callout line. More...

#include <qgscalloutposition.h>

Public Member Functions
	QgsCalloutPosition ()=default
	Constructor for QgsCalloutPosition. More...
	QgsCalloutPosition (QgsFeatureId id, const QString &layer, const QString &providerId=QString())
	Constructor for QgsCalloutPosition. More...
QPointF	destination () const
	Returns the destination of the callout line, in map coordinates. More...
bool	destinationIsPinned () const
	Returns true if the destination of the callout has pinned (manually placed). More...
QPointF	origin () const
	Returns the origin of the callout line, in map coordinates. More...
bool	originIsPinned () const
	Returns true if the origin of the callout has pinned (manually placed). More...
void	setDestination (const QPointF &destination)
	Sets the destination of the callout line, in map coordinates. More...
void	setDestinationIsPinned (bool pinned)
	Sets whether the destination of the callout has pinned (manually placed). More...
void	setOrigin (const QPointF &origin)
	Sets the origin of the callout line, in map coordinates. More...
void	setOriginIsPinned (bool pinned)
	Sets whether the origin of the callout has pinned (manually placed). More...

Public Attributes
QgsFeatureId	featureId = FID_NULL
	ID of feature associated with this callout. More...
QString	layerID
	ID of associated map layer. More...
QString	providerID
	ID of the associated label provider. More...

Detailed Description

Represents the calculated placement of a map label callout line.

Since

QGIS 3.20

Definition at line 32 of file qgscalloutposition.h.

Constructor & Destructor Documentation

QgsCalloutPosition() [1/2]

QgsCalloutPosition::QgsCalloutPosition ( QgsFeatureId  id, const QString &  layer, const QString &  providerId = QString()  )

inline

Constructor for QgsCalloutPosition.

Parameters

id	associated feature ID
layer	ID of associated map layer
providerId	ID of associated label provider

Definition at line 42 of file qgscalloutposition.h.

QgsCalloutPosition() [2/2]

QgsCalloutPosition::QgsCalloutPosition ( )

default

Constructor for QgsCalloutPosition.

Member Function Documentation

destination()

QPointF QgsCalloutPosition::destination ( ) const

inline

Returns the destination of the callout line, in map coordinates.

The destination of the callout line is the line point associated with the feature's geometry.

See also

setDestination()

origin()

Definition at line 94 of file qgscalloutposition.h.

destinationIsPinned()

bool QgsCalloutPosition::destinationIsPinned ( ) const

inline

Returns true if the destination of the callout has pinned (manually placed).

The destination of the callout line is the line point associated with the feature's geometry.

See also

originIsPinned()

setDestinationIsPinned()

Definition at line 134 of file qgscalloutposition.h.

origin()

QPointF QgsCalloutPosition::origin ( ) const

inline

Returns the origin of the callout line, in map coordinates.

The origin of the callout line is the line point associated with the label text.

See also

setOrigin()

destination()

Definition at line 74 of file qgscalloutposition.h.

originIsPinned()

bool QgsCalloutPosition::originIsPinned ( ) const

inline

Returns true if the origin of the callout has pinned (manually placed).

The origin of the callout line is the line point associated with the label text.

See also

destinationIsPinned()

setOriginIsPinned()

Definition at line 114 of file qgscalloutposition.h.

setDestination()

void QgsCalloutPosition::setDestination ( const QPointF &  destination )

inline

Sets the destination of the callout line, in map coordinates.

The destination of the callout line is the line point associated with the feature's geometry.

See also

destination()

setOrigin()

Definition at line 104 of file qgscalloutposition.h.

setDestinationIsPinned()

void QgsCalloutPosition::setDestinationIsPinned ( bool  pinned )

inline

Sets whether the destination of the callout has pinned (manually placed).

The destination of the callout line is the line point associated with the feature's geometry.

See also

setOriginIsPinned()

destinationIsPinned()

Definition at line 144 of file qgscalloutposition.h.

setOrigin()

void QgsCalloutPosition::setOrigin ( const QPointF &  origin )

inline

Sets the origin of the callout line, in map coordinates.

The origin of the callout line is the line point associated with the label text.

See also

origin()

setDestination()

Definition at line 84 of file qgscalloutposition.h.

setOriginIsPinned()

void QgsCalloutPosition::setOriginIsPinned ( bool  pinned )

inline

Sets whether the origin of the callout has pinned (manually placed).

The origin of the callout line is the line point associated with the label text.

See also

setDestinationIsPinned()

originIsPinned()

Definition at line 124 of file qgscalloutposition.h.

Member Data Documentation

featureId

QgsFeatureId QgsCalloutPosition::featureId = FID_NULL

ID of feature associated with this callout.

Definition at line 54 of file qgscalloutposition.h.

layerID

QString QgsCalloutPosition::layerID

ID of associated map layer.

Definition at line 59 of file qgscalloutposition.h.

providerID

QString QgsCalloutPosition::providerID

ID of the associated label provider.

Definition at line 64 of file qgscalloutposition.h.

---

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

• /build/qgis-3.26.3+32focal/src/core/labeling/qgscalloutposition.h