1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtQuick module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QQUICKTEXTMETRICS_H
41 #define QQUICKTEXTMETRICS_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API.  It exists purely as an
48 // implementation detail.  This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include <qqml.h>
55 
56 #include <QtGui/QFontMetricsF>
57 #include <QtCore/QObject>
58 
59 QT_BEGIN_NAMESPACE
60 
61 class QFont;
62 
63 class Q_AUTOTEST_EXPORT QQuickTextMetrics : public QObject
64 {
65     Q_OBJECT
66 
67     Q_PROPERTY(QFont font READ font WRITE setFont NOTIFY fontChanged FINAL)
68     Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged FINAL)
69     Q_PROPERTY(qreal advanceWidth READ advanceWidth NOTIFY metricsChanged FINAL)
70     Q_PROPERTY(QRectF boundingRect READ boundingRect NOTIFY metricsChanged FINAL)
71     Q_PROPERTY(qreal width READ width NOTIFY metricsChanged FINAL)
72     Q_PROPERTY(qreal height READ height NOTIFY metricsChanged FINAL)
73     Q_PROPERTY(QRectF tightBoundingRect READ tightBoundingRect NOTIFY metricsChanged FINAL)
74     Q_PROPERTY(QString elidedText READ elidedText NOTIFY metricsChanged FINAL)
75     Q_PROPERTY(Qt::TextElideMode elide READ elide WRITE setElide NOTIFY elideChanged FINAL)
76     Q_PROPERTY(qreal elideWidth READ elideWidth WRITE setElideWidth NOTIFY elideWidthChanged FINAL)
77     QML_NAMED_ELEMENT(TextMetrics)
78     QML_ADDED_IN_MINOR_VERSION(4)
79 
80 public:
81     explicit QQuickTextMetrics(QObject *parent = 0);
82     ~QQuickTextMetrics();
83 
84     QFont font() const;
85     void setFont(const QFont &font);
86 
87     QString text() const;
88     void setText(const QString &text);
89 
90     Qt::TextElideMode elide() const;
91     void setElide(Qt::TextElideMode elide);
92 
93     qreal elideWidth() const;
94     void setElideWidth(qreal elideWidth);
95 
96     qreal advanceWidth() const;
97     QRectF boundingRect() const;
98     qreal width() const;
99     qreal height() const;
100     QRectF tightBoundingRect() const;
101     QString elidedText() const;
102 
103 Q_SIGNALS:
104     void fontChanged();
105     void textChanged();
106     void elideChanged();
107     void elideWidthChanged();
108     void metricsChanged();
109 
110 private:
111     QString m_text;
112     QFont m_font;
113     QFontMetricsF m_metrics;
114     Qt::TextElideMode m_elide;
115     qreal m_elideWidth;
116 };
117 
118 QT_END_NAMESPACE
119 
120 QML_DECLARE_TYPE(QQuickTextMetrics)
121 
122 #endif // QQUICKTEXTMETRICS_H
123