Get started with patching up the Qt GUI docs
[profile/ivi/qtbase.git] / src / gui / text / qabstractfontengine_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
16 **
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
20 **
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
28 **
29 ** Other Usage
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QABSTRACTFONTENGINE_P_H
43 #define QABSTRACTFONTENGINE_P_H
44
45 //
46 //  W A R N I N G
47 //  -------------
48 //
49 // This file is not part of the Qt API.  It exists purely as an
50 // implementation detail.  This header file may change from version to
51 // version without notice, or even be removed.
52 //
53 // We mean it.
54 //
55
56 #include "qfontengine_p.h"
57 #include "qabstractfontengine_qws.h"
58
59 QT_BEGIN_NAMESPACE
60
61 class QCustomFontEngine;
62
63 class QProxyFontEngine : public QFontEngine
64 {
65     Q_OBJECT
66 public:
67     QProxyFontEngine(QAbstractFontEngine *engine, const QFontDef &def);
68     virtual ~QProxyFontEngine();
69
70     virtual bool stringToCMap(const QChar *str, int len, QGlyphLayout *glyphs, int *nglyphs, QTextEngine::ShaperFlags flags) const;
71     virtual void recalcAdvances(QGlyphLayout *, QTextEngine::ShaperFlags) const;
72     virtual QImage alphaMapForGlyph(glyph_t);
73     virtual void addGlyphsToPath(glyph_t *glyphs, QFixedPoint *positions, int nglyphs, QPainterPath *path, QTextItem::RenderFlags flags);
74     virtual glyph_metrics_t boundingBox(const QGlyphLayout &glyphs);
75     virtual glyph_metrics_t boundingBox(glyph_t glyph);
76
77     virtual QFixed ascent() const;
78     virtual QFixed descent() const;
79     virtual QFixed leading() const;
80     virtual QFixed xHeight() const;
81     virtual QFixed averageCharWidth() const;
82     virtual QFixed lineThickness() const;
83     virtual QFixed underlinePosition() const;
84     virtual qreal maxCharWidth() const;
85     virtual qreal minLeftBearing() const;
86     virtual qreal minRightBearing() const;
87     virtual int glyphCount() const;
88
89     virtual bool canRender(const QChar *string, int len);
90
91     virtual Type type() const { return Proxy; }
92     virtual const char *name() const { return "proxy engine"; }
93
94     virtual void draw(QPaintEngine *, qreal, qreal, const QTextItemInt &);
95
96     inline QAbstractFontEngine::Capabilities capabilities() const
97     { return engineCapabilities; }
98
99     bool drawAsOutline() const;
100
101 private:
102     QAbstractFontEngine *engine;
103     QAbstractFontEngine::Capabilities engineCapabilities;
104 };
105
106 QT_END_NAMESPACE
107
108 #endif