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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgstextpreview.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsTextPreview : QLabel
{
%Docstring(signature="appended")
A widget for previewing text formatting settings.
:py:class:`QgsTextPreview` provides a widget for previewing the appearance of text rendered
using :py:class:`QgsTextRenderer`. The preview includes all settings contained within
a :py:class:`QgsTextFormat`, including shadow, background and buffer.
In order to preview the exact appearance of text which uses sizes in map units,
the scale and map units must be set by calling :py:func:`~setScale` and :py:func:`~setMapUnits`.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgstextpreview.h"
%End
public:
QgsTextPreview( QWidget *parent = 0 );
%Docstring
Constructor for QgsTextPreview
:param parent: parent widget
%End
virtual void paintEvent( QPaintEvent *e );
void setFormat( const QgsTextFormat &format );
%Docstring
Sets the text format for previewing in the widget.
:param format: text format
.. seealso:: :py:func:`format`
%End
QgsTextFormat format() const;
%Docstring
Returns the text format used for previewing text in the widget.
.. seealso:: :py:func:`setFormat`
%End
void setScale( double scale );
%Docstring
Sets the ``scale`` to use for previewing format sizes in map units.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
.. seealso:: :py:func:`scale`
.. seealso:: :py:func:`setMapUnits`
%End
double scale() const;
%Docstring
Returns the scale used for previewing format sizes in map units.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
.. seealso:: :py:func:`setScale`
.. seealso:: :py:func:`mapUnits`
%End
void setMapUnits( QgsUnitTypes::DistanceUnit unit );
%Docstring
Sets the map unit type for previewing format sizes in map units.
:param unit: map units
.. seealso:: :py:func:`mapUnits`
.. seealso:: :py:func:`setScale`
%End
QgsUnitTypes::DistanceUnit mapUnits() const;
%Docstring
Returns the map unit type used for previewing format sizes in map units.
.. seealso:: :py:func:`setMapUnits`
.. seealso:: :py:func:`scale`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgstextpreview.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
