QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgstextpreview.h
Go to the documentation of this file.
1/***************************************************************************
2 qgstextpreview.h
3 ----------------
4 begin : October 2016
5 copyright : (C) 2016 by 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#ifndef QGSTEXTPREVIEW_H
16#define QGSTEXTPREVIEW_H
17
18#include "qgstextformat.h"
19#include "qgsrendercontext.h"
20
21#include <QLabel>
22#include "qgis_gui.h"
23
24class QgsScreenHelper;
25
40class GUI_EXPORT QgsTextPreview : public QLabel
41{
42 Q_OBJECT
43
44 Q_PROPERTY( QgsTextFormat format READ format WRITE setFormat )
45 Q_PROPERTY( double scale READ scale WRITE setScale )
46 Q_PROPERTY( Qgis::DistanceUnit mapUnits READ mapUnits WRITE setMapUnits )
47
48 public:
49
54 QgsTextPreview( QWidget *parent = nullptr );
55
56 void paintEvent( QPaintEvent *e ) override;
57
63 void setFormat( const QgsTextFormat &format );
64
69 QgsTextFormat format() const { return mFormat; }
70
77 void setScale( double scale );
78
85 double scale() const { return mScale; }
86
93 void setMapUnits( Qgis::DistanceUnit unit );
94
100 Qgis::DistanceUnit mapUnits() const { return mMapUnits; }
101
102 private:
103
104 QgsScreenHelper *mScreenHelper = nullptr;
105
106 QgsTextFormat mFormat;
107 QgsRenderContext mContext;
108 double mScale = -1;
110 void updateContext();
111};
112
113#endif // QGSTEXTPREVIEW_H
DistanceUnit
Units of distance.
Definition: qgis.h:4124
Contains information about the context of a rendering operation.
A utility class for dynamic handling of changes to screen properties.
Container for all settings relating to text rendering.
Definition: qgstextformat.h:41
A widget for previewing text formatting settings.
QgsTextFormat format() const
Returns the text format used for previewing text in the widget.
Qgis::DistanceUnit mapUnits() const
Returns the map unit type used for previewing format sizes in map units.
double scale() const
Returns the scale used for previewing format sizes in map units.