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 QQUICKFONTMETRICS_H 41 #define QQUICKFONTMETRICS_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 QQuickFontMetrics : public QObject 64 { 65 Q_OBJECT 66 67 Q_PROPERTY(QFont font READ font WRITE setFont NOTIFY fontChanged) 68 Q_PROPERTY(qreal ascent READ ascent NOTIFY fontChanged) 69 Q_PROPERTY(qreal descent READ descent NOTIFY fontChanged) 70 Q_PROPERTY(qreal height READ height NOTIFY fontChanged) 71 Q_PROPERTY(qreal leading READ leading NOTIFY fontChanged) 72 Q_PROPERTY(qreal lineSpacing READ lineSpacing NOTIFY fontChanged) 73 Q_PROPERTY(qreal minimumLeftBearing READ minimumLeftBearing NOTIFY fontChanged) 74 Q_PROPERTY(qreal minimumRightBearing READ minimumRightBearing NOTIFY fontChanged) 75 Q_PROPERTY(qreal maximumCharacterWidth READ maximumCharacterWidth NOTIFY fontChanged) 76 Q_PROPERTY(qreal xHeight READ xHeight NOTIFY fontChanged) 77 Q_PROPERTY(qreal averageCharacterWidth READ averageCharacterWidth NOTIFY fontChanged) 78 Q_PROPERTY(qreal underlinePosition READ underlinePosition NOTIFY fontChanged) 79 Q_PROPERTY(qreal overlinePosition READ overlinePosition NOTIFY fontChanged) 80 Q_PROPERTY(qreal strikeOutPosition READ strikeOutPosition NOTIFY fontChanged) 81 Q_PROPERTY(qreal lineWidth READ lineWidth NOTIFY fontChanged) 82 QML_NAMED_ELEMENT(FontMetrics) 83 QML_ADDED_IN_MINOR_VERSION(4) 84 public: 85 explicit QQuickFontMetrics(QObject *parent = nullptr); 86 ~QQuickFontMetrics(); 87 88 QFont font() const; 89 void setFont(const QFont &font); 90 91 qreal ascent() const; 92 qreal descent() const; 93 qreal height() const; 94 qreal leading() const; 95 qreal lineSpacing() const; 96 qreal minimumLeftBearing() const; 97 qreal minimumRightBearing() const; 98 qreal maximumCharacterWidth() const; 99 100 qreal xHeight() const; 101 qreal averageCharacterWidth() const; 102 103 qreal underlinePosition() const; 104 qreal overlinePosition() const; 105 qreal strikeOutPosition() const; 106 qreal lineWidth() const; 107 108 Q_INVOKABLE qreal advanceWidth(const QString &text) const; 109 Q_INVOKABLE QRectF boundingRect(const QString &text) const; 110 Q_INVOKABLE QRectF tightBoundingRect(const QString &text) const; 111 Q_INVOKABLE QString elidedText(const QString &text, Qt::TextElideMode mode, qreal width, int flags = 0) const; 112 113 Q_SIGNALS: 114 void fontChanged(const QFont &font); 115 116 private: 117 QFont m_font; 118 QFontMetricsF m_metrics; 119 }; 120 121 QT_END_NAMESPACE 122 123 QML_DECLARE_TYPE(QQuickFontMetrics) 124 125 #endif // QQUICKFONTMETRICS_H 126