1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QABSTRACTTEXTDOCUMENTLAYOUT_H
43 #define QABSTRACTTEXTDOCUMENTLAYOUT_H
44 
45 #include <QtCore/qobject.h>
46 #include <QtGui/qtextlayout.h>
47 #include <QtGui/qtextdocument.h>
48 #include <QtGui/qtextcursor.h>
49 #include <QtGui/qpalette.h>
50 
51 QT_BEGIN_HEADER
52 
53 QT_BEGIN_NAMESPACE
54 
55 QT_MODULE(Gui)
56 
57 class QAbstractTextDocumentLayoutPrivate;
58 class QTextBlock;
59 class QTextObjectInterface;
60 class QTextFrame;
61 
62 class Q_GUI_EXPORT QAbstractTextDocumentLayout : public QObject
63 {
64     Q_OBJECT
65     Q_DECLARE_PRIVATE(QAbstractTextDocumentLayout)
66 
67 public:
68     explicit QAbstractTextDocumentLayout(QTextDocument *doc);
69     ~QAbstractTextDocumentLayout();
70 
71     struct Selection
72     {
73         QTextCursor cursor;
74         QTextCharFormat format;
75     };
76 
77     struct PaintContext
78     {
PaintContextPaintContext79         PaintContext()
80             : cursorPosition(-1)
81             {}
82         int cursorPosition;
83         QPalette palette;
84         QRectF clip;
85         QVector<Selection> selections;
86     };
87 
88     virtual void draw(QPainter *painter, const PaintContext &context) = 0;
89     virtual int hitTest(const QPointF &point, Qt::HitTestAccuracy accuracy) const = 0;
90     QString anchorAt(const QPointF& pos) const;
91 
92     virtual int pageCount() const = 0;
93     virtual QSizeF documentSize() const = 0;
94 
95     virtual QRectF frameBoundingRect(QTextFrame *frame) const = 0;
96     virtual QRectF blockBoundingRect(const QTextBlock &block) const = 0;
97 
98     void setPaintDevice(QPaintDevice *device);
99     QPaintDevice *paintDevice() const;
100 
101     QTextDocument *document() const;
102 
103     void registerHandler(int objectType, QObject *component);
104     QTextObjectInterface *handlerForObject(int objectType) const;
105 
106 Q_SIGNALS:
107     void update(const QRectF & = QRectF(0., 0., 1000000000., 1000000000.));
108     void updateBlock(const QTextBlock &block);
109     void documentSizeChanged(const QSizeF &newSize);
110     void pageCountChanged(int newPages);
111 
112 protected:
113     QAbstractTextDocumentLayout(QAbstractTextDocumentLayoutPrivate &, QTextDocument *);
114 
115     virtual void documentChanged(int from, int charsRemoved, int charsAdded) = 0;
116 
117     virtual void resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
118     virtual void positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
119     virtual void drawInlineObject(QPainter *painter, const QRectF &rect, QTextInlineObject object, int posInDocument, const QTextFormat &format);
120 
121     int formatIndex(int pos);
122     QTextCharFormat format(int pos);
123 
124 private:
125     friend class QTextControl;
126     friend class QTextDocument;
127     friend class QTextDocumentPrivate;
128     friend class QTextEngine;
129     friend class QTextLayout;
130     friend class QTextLine;
131     Q_PRIVATE_SLOT(d_func(), void _q_handlerDestroyed(QObject *obj))
132     Q_PRIVATE_SLOT(d_func(), int _q_dynamicPageCountSlot())
133     Q_PRIVATE_SLOT(d_func(), QSizeF _q_dynamicDocumentSizeSlot())
134 };
135 
136 class Q_GUI_EXPORT QTextObjectInterface
137 {
138 public:
~QTextObjectInterface()139     virtual ~QTextObjectInterface() {}
140     virtual QSizeF intrinsicSize(QTextDocument *doc, int posInDocument, const QTextFormat &format) = 0;
141     virtual void drawObject(QPainter *painter, const QRectF &rect, QTextDocument *doc, int posInDocument, const QTextFormat &format) = 0;
142 };
143 
144 Q_DECLARE_INTERFACE(QTextObjectInterface, "com.trolltech.Qt.QTextObjectInterface")
145 
146 QT_END_NAMESPACE
147 
148 QT_END_HEADER
149 
150 #endif // QABSTRACTTEXTDOCUMENTLAYOUT_H
151