QGIS API Documentation 3.39.0-Master (3aed037ce22)
Loading...
Searching...
No Matches
qgscalloutposition.h
Go to the documentation of this file.
1/***************************************************************************
2 qgscalloutposition.h
3 -------------------
4 begin : February 2021
5 copyright : (C) Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSCALLOUTPOSITION_H
17#define QGSCALLOUTPOSITION_H
18
19#include "qgis_core.h"
20#include "qgis_sip.h"
21
22#include "qgsfeatureid.h"
23
24#include <QPointF>
25
32class CORE_EXPORT QgsCalloutPosition
33{
34 public:
35
42 QgsCalloutPosition( QgsFeatureId id, const QString &layer, const QString &providerId = QString() )
43 : featureId( id )
44 , layerID( layer )
45 , providerID( providerId )
46 {}
47
48 QgsCalloutPosition() = default;
49
54
58 QString layerID;
59
63 QString providerID;
64
73 QPointF origin() const { return mOrigin; }
74
83 void setOrigin( const QPointF &origin ) { mOrigin = origin; }
84
93 QPointF destination() const { return mDestination; }
94
103 void setDestination( const QPointF &destination ) { mDestination = destination; }
104
113 bool originIsPinned() const { return mOriginIsPinned; }
114
123 void setOriginIsPinned( bool pinned ) { mOriginIsPinned = pinned; }
124
133 bool destinationIsPinned() const { return mDestinationIsPinned; }
134
143 void setDestinationIsPinned( bool pinned ) { mDestinationIsPinned = pinned; }
144
145 private:
146
147 QPointF mOrigin;
148
149 QPointF mDestination;
150
151 bool mOriginIsPinned = false;
152 bool mDestinationIsPinned = false;
153};
154
155#endif // QGSCALLOUTPOSITION_H
Represents the calculated placement of a map label callout line.
void setDestination(const QPointF &destination)
Sets the destination of the callout line, in map coordinates.
QString providerID
ID of the associated label provider.
QPointF origin() const
Returns the origin of the callout line, in map coordinates.
void setOrigin(const QPointF &origin)
Sets the origin of the callout line, in map coordinates.
QgsCalloutPosition()=default
QPointF destination() const
Returns the destination of the callout line, in map coordinates.
bool originIsPinned() const
Returns true if the origin of the callout has pinned (manually placed).
bool destinationIsPinned() const
Returns true if the destination of the callout has pinned (manually placed).
QgsCalloutPosition(QgsFeatureId id, const QString &layer, const QString &providerId=QString())
Constructor for QgsCalloutPosition.
QString layerID
ID of associated map layer.
void setDestinationIsPinned(bool pinned)
Sets whether the destination of the callout has pinned (manually placed).
void setOriginIsPinned(bool pinned)
Sets whether the origin of the callout has pinned (manually placed).
#define FID_NULL
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features