1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtGui module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #ifndef QFONTMETRICS_H
43 #define QFONTMETRICS_H
45 #include <QtGui/qfont.h>
46 #include <QtCore/qsharedpointer.h>
47 #ifndef QT_INCLUDE_COMPAT
48 #include <QtCore/qrect.h>
65 class Q_GUI_EXPORT QFontMetrics
68 QFontMetrics(const QFont &);
69 QFontMetrics(const QFont &, QPaintDevice *pd);
70 QFontMetrics(const QFontMetrics &);
73 QFontMetrics &operator=(const QFontMetrics &);
74 #ifdef Q_COMPILER_RVALUE_REFS
75 inline QFontMetrics &operator=(QFontMetrics &&other)
76 { qSwap(d, other.d); return *this; }
83 int lineSpacing() const;
84 int minLeftBearing() const;
85 int minRightBearing() const;
89 int averageCharWidth() const;
91 bool inFont(QChar) const;
92 bool inFontUcs4(uint ucs4) const;
94 int leftBearing(QChar) const;
95 int rightBearing(QChar) const;
96 int width(const QString &, int len = -1) const;
97 int width(const QString &, int len, int flags) const;
99 int width(QChar) const;
100 int charWidth(const QString &str, int pos) const;
102 QRect boundingRect(QChar) const;
104 QRect boundingRect(const QString &text) const;
105 QRect boundingRect(const QRect &r, int flags, const QString &text, int tabstops=0, int *tabarray=0) const;
106 inline QRect boundingRect(int x, int y, int w, int h, int flags, const QString &text,
107 int tabstops=0, int *tabarray=0) const
108 { return boundingRect(QRect(x, y, w, h), flags, text, tabstops, tabarray); }
109 QSize size(int flags, const QString& str, int tabstops=0, int *tabarray=0) const;
111 QRect tightBoundingRect(const QString &text) const;
113 QString elidedText(const QString &text, Qt::TextElideMode mode, int width, int flags = 0) const;
115 int underlinePos() const;
116 int overlinePos() const;
117 int strikeOutPos() const;
118 int lineWidth() const;
120 bool operator==(const QFontMetrics &other); // 5.0 - remove me
121 bool operator==(const QFontMetrics &other) const;
122 inline bool operator !=(const QFontMetrics &other) { return !operator==(other); } // 5.0 - remove me
123 inline bool operator !=(const QFontMetrics &other) const { return !operator==(other); }
126 inline QRect boundingRect(const QString &text, int len) const
127 { return boundingRect(text.left(len)); }
128 inline QRect boundingRect(int x, int y, int w, int h, int flags, const QString& str, int len,
129 int tabstops=0, int *tabarray=0) const
130 { return boundingRect(QRect(x, y, w, h), flags, str.left(len), tabstops, tabarray); }
131 inline QSize size(int flags, const QString& str, int len, int tabstops=0, int *tabarray=0) const
132 { return size(flags, str.left(len), tabstops, tabarray); }
135 #if defined(Q_WS_MAC)
136 friend class QFontPrivate;
138 friend class QFontMetricsF;
139 friend class QStackTextEngine;
141 QExplicitlySharedDataPointer<QFontPrivate> d;
145 class Q_GUI_EXPORT QFontMetricsF
148 QFontMetricsF(const QFont &);
149 QFontMetricsF(const QFont &, QPaintDevice *pd);
150 QFontMetricsF(const QFontMetrics &);
151 QFontMetricsF(const QFontMetricsF &);
154 QFontMetricsF &operator=(const QFontMetricsF &);
155 QFontMetricsF &operator=(const QFontMetrics &);
156 #ifdef Q_COMPILER_RVALUE_REFS
157 inline QFontMetricsF &operator=(QFontMetricsF &&other)
158 { qSwap(d, other.d); return *this; }
160 qreal ascent() const;
161 qreal descent() const;
162 qreal height() const;
163 qreal leading() const;
164 qreal lineSpacing() const;
165 qreal minLeftBearing() const;
166 qreal minRightBearing() const;
167 qreal maxWidth() const;
169 qreal xHeight() const;
170 qreal averageCharWidth() const;
172 bool inFont(QChar) const;
173 bool inFontUcs4(uint ucs4) const;
175 qreal leftBearing(QChar) const;
176 qreal rightBearing(QChar) const;
177 qreal width(const QString &string) const;
179 qreal width(QChar) const;
181 QRectF boundingRect(const QString &string) const;
182 QRectF boundingRect(QChar) const;
183 QRectF boundingRect(const QRectF &r, int flags, const QString& string, int tabstops=0, int *tabarray=0) const;
184 QSizeF size(int flags, const QString& str, int tabstops=0, int *tabarray=0) const;
186 QRectF tightBoundingRect(const QString &text) const;
188 QString elidedText(const QString &text, Qt::TextElideMode mode, qreal width, int flags = 0) const;
190 qreal underlinePos() const;
191 qreal overlinePos() const;
192 qreal strikeOutPos() const;
193 qreal lineWidth() const;
195 bool operator==(const QFontMetricsF &other); // 5.0 - remove me
196 bool operator==(const QFontMetricsF &other) const;
197 inline bool operator !=(const QFontMetricsF &other) { return !operator==(other); } // 5.0 - remove me
198 inline bool operator !=(const QFontMetricsF &other) const { return !operator==(other); }
201 QExplicitlySharedDataPointer<QFontPrivate> d;
208 #endif // QFONTMETRICS_H