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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgshighlight.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
%ModuleHeaderCode
// For ConvertToSubClassCode.
#include <qgshighlight.h>
%End
class QgsHighlight : QgsMapCanvasItem
{
%Docstring(signature="appended")
A class for highlight features on the map.
The :py:class:`QgsHighlight` class provides a transparent overlay canvas
item for highlighting features or geometries on a map canvas.
.. code-block:: python
color = QColor(Qt.red)
highlight = QgsHighlight(mapCanvas, feature, layer)
highlight.setColor(color)
color.setAlpha(50)
highlight.setFillColor(color)
highlight.show()
%End
%TypeHeaderCode
#include "qgshighlight.h"
%End
%ConvertToSubClassCode
if ( dynamic_cast<QgsHighlight *>( sipCpp ) )
{
sipType = sipType_QgsHighlight;
// We need to tweak the pointer as sip believes it is single inheritance
// from QgsMapCanvasItem, but the raw address of QgsHighlight (sipCpp)
// is actually a QObject
*sipCppRet = dynamic_cast<QgsHighlight *>( sipCpp );
}
else
sipType = nullptr;
%End
public:
QgsHighlight( QgsMapCanvas *mapCanvas /TransferThis/, const QgsGeometry &geom, QgsMapLayer *layer );
%Docstring
Constructor for QgsHighlight
:param mapCanvas: associated map canvas
:param geom: initial geometry of highlight
:param layer: associated map layer
%End
QgsHighlight( QgsMapCanvas *mapCanvas /TransferThis/, const QgsFeature &feature, QgsVectorLayer *layer );
%Docstring
Constructor for highlighting ``True`` feature shape using feature
attributes and renderer.
:param mapCanvas: map canvas
:param feature:
:param layer: vector layer
%End
~QgsHighlight();
QColor color() const;
%Docstring
Returns the line/stroke color
.. versionadded:: 3.4
%End
void setColor( const QColor &color );
%Docstring
Set line/stroke to color, polygon fill to color with alpha = 63. This is
legacy function, use :py:func:`~QgsHighlight.setFillColor` after
:py:func:`~QgsHighlight.setColor` if different fill color is required.
%End
QColor fillColor() const;
%Docstring
Returns the fill color
.. versionadded:: 3.4
%End
void setFillColor( const QColor &fillColor );
%Docstring
Fill color for the highlight. Will be used for polygons and points.
%End
int width() const;
%Docstring
Returns the stroke width
.. versionadded:: 3.4
%End
void setWidth( int width );
%Docstring
Set stroke width.
.. note::
Ignored in feature mode.
%End
double buffer() const;
%Docstring
Returns the line/stroke buffer size (in millimeters)
.. seealso:: :py:func:`setBuffer`
.. versionadded:: 3.4
%End
void setBuffer( double buffer );
%Docstring
Sets the line/stroke buffer size (in millimeters).
.. seealso:: :py:func:`buffer`
%End
void setMinWidth( double width );
%Docstring
Sets the minimum line/stroke width (in millimeters).
%End
QgsMapLayer *layer() const;
%Docstring
Returns the layer for which this highlight has been created.
%End
virtual void updatePosition();
void applyDefaultStyle();
%Docstring
Applies the default style from the user settings to the highlight.
.. versionadded:: 3.30
%End
protected:
virtual void paint( QPainter *p );
void updateRect();
%Docstring
recalculates needed rectangle
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgshighlight.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
