1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
/** \ingroup core
* \class QgsAnnotation
* \note added in QGIS 2.18
*
* \brief An interface for annotation items which are drawn over a map.
*
* QgsAnnotation is an interface class for map annotation items. These annotations can be
* drawn within a map, and have either a fixed map position (retrieved using mapPosition())
* or are placed relative to the map's frame (retrieved using relativePosition()).
* Annotations with a fixed map position also have a corresponding
* QgsCoordinateReferenceSystem, which can be determined by calling mapPositionCrs().
*/
class QgsAnnotation
{
%TypeHeaderCode
#include <qgsannotation.h>
%End
public:
//! Returns true if the annotation should be shown.
virtual bool showItem() const = 0;
/** Returns true if the annotation is attached to a fixed map position, or
* false if the annotation uses a position relative to the current map
* extent.
* @see mapPosition()
* @see relativePositon()
*/
//TODO QGIS 3 - rename to hasFixedMapPosition()
virtual bool mapPositionFixed() const = 0;
/** Returns the map position of the annotation, if it is attached to a fixed map
* position.
* @see mapPositionFixed()
* @see mapPositionCrs()
*/
virtual QgsPoint mapPosition() const;
/** Returns the CRS of the map position, or an invalid CRS if the annotation does
* not have a fixed map position.
*/
virtual QgsCoordinateReferenceSystem mapPositionCrs() const;
/** Returns the relative position of the annotation, if it is not attached to a fixed map
* position. The coordinates in the return point should be between 0 and 1, and represent
* the relative percentage for the position compared to the map width and height.
* @see mapPositionFixed()
*/
virtual QPointF relativePosition() const;
/** Returns a scaling factor which should be applied to painters before rendering
* the item.
*/
virtual double scaleFactor() const = 0;
//! deprecated - do not use
// TODO QGIS 3.0 - remove
virtual void setItemData( int role, const QVariant& value ) = 0;
//! Paint the annotation to a destination painter
virtual void paint( QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget = nullptr ) = 0;
};
|
