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 QtGui 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 QGLYPHRUN_H
41#define QGLYPHRUN_H
42
43#include <QtGui/qtguiglobal.h>
44#include <QtCore/qsharedpointer.h>
45#include <QtCore/qvector.h>
46#include <QtCore/qpoint.h>
47#include <QtGui/qrawfont.h>
48
49#if !defined(QT_NO_RAWFONT)
50
51QT_BEGIN_NAMESPACE
52
53
54class QGlyphRunPrivate;
55class Q_GUI_EXPORT QGlyphRun
56{
57public:
58 enum GlyphRunFlag {
59 Overline = 0x01,
60 Underline = 0x02,
61 StrikeOut = 0x04,
62 RightToLeft = 0x08,
63 SplitLigature = 0x10
64 };
65 Q_DECLARE_FLAGS(GlyphRunFlags, GlyphRunFlag)
66
67 QGlyphRun();
68 QGlyphRun(const QGlyphRun &other);
69 QGlyphRun &operator=(QGlyphRun &&other) noexcept { swap(other); return *this; }
70 QGlyphRun &operator=(const QGlyphRun &other);
71 ~QGlyphRun();
72
73 void swap(QGlyphRun &other) noexcept { qSwap(d, other.d); }
74
75 QRawFont rawFont() const;
76 void setRawFont(const QRawFont &rawFont);
77
78 void setRawData(const quint32 *glyphIndexArray,
79 const QPointF *glyphPositionArray,
80 int size);
81
82 QVector<quint32> glyphIndexes() const;
83 void setGlyphIndexes(const QVector<quint32> &glyphIndexes);
84
85 QVector<QPointF> positions() const;
86 void setPositions(const QVector<QPointF> &positions);
87
88 void clear();
89
90 bool operator==(const QGlyphRun &other) const;
91 inline bool operator!=(const QGlyphRun &other) const
92 { return !operator==(other); }
93
94 void setOverline(bool overline);
95 bool overline() const;
96
97 void setUnderline(bool underline);
98 bool underline() const;
99
100 void setStrikeOut(bool strikeOut);
101 bool strikeOut() const;
102
103 void setRightToLeft(bool on);
104 bool isRightToLeft() const;
105
106 void setFlag(GlyphRunFlag flag, bool enabled = true);
107 void setFlags(GlyphRunFlags flags);
108 GlyphRunFlags flags() const;
109
110 void setBoundingRect(const QRectF &boundingRect);
111 QRectF boundingRect() const;
112
113 bool isEmpty() const;
114
115private:
116 friend class QGlyphRunPrivate;
117 friend class QTextLine;
118
119 QGlyphRun operator+(const QGlyphRun &other) const;
120 QGlyphRun &operator+=(const QGlyphRun &other);
121
122 void detach();
123 QExplicitlySharedDataPointer<QGlyphRunPrivate> d;
124};
125
126Q_DECLARE_SHARED(QGlyphRun)
127
128QT_END_NAMESPACE
129
130#endif // QT_NO_RAWFONT
131
132#endif // QGLYPHRUN_H
133