Qt 4.8
qabstracttextdocumentlayout.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/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 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
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 
52 
54 
55 QT_MODULE(Gui)
56 
58 class QTextBlock;
60 class QTextFrame;
61 
63 {
64  Q_OBJECT
66 
67 public:
70 
71  struct Selection
72  {
75  };
76 
77  struct PaintContext
78  {
80  : cursorPosition(-1)
81  {}
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:
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 
137 {
138 public:
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 
147 
149 
150 #endif // QABSTRACTTEXTDOCUMENTLAYOUT_H
The QPainter class performs low-level painting on widgets and other paint devices.
Definition: qpainter.h:86
The QTextCharFormat class provides formatting information for characters in a QTextDocument.
Definition: qtextformat.h:372
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
QRectF rect() const
Returns the line&#39;s bounding rectangle.
#define QT_MODULE(x)
Definition: qglobal.h:2783
QTextCharFormat format
the format of the selection
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
The QTextFrame class represents a frame in a QTextDocument.
Definition: qtextobject.h:122
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
HitTestAccuracy
Definition: qtextdocument.h:78
The QPointF class defines a point in the plane using floating point precision.
Definition: qpoint.h:214
The QTextLine class represents a line of text inside a QTextLayout.
Definition: qtextlayout.h:197
#define Q_PRIVATE_SLOT(d, signature)
Definition: qobjectdefs.h:73
QTextCursor cursor
the selection&#39;s cursor
static QSize documentSize(QTextControl *control)
Definition: qtextedit.cpp:238
The QString class provides a Unicode character string.
Definition: qstring.h:83
QPalette palette
the default color that is used for the text, when no color is specified.
The QVector class is a template class that provides a dynamic array.
Definition: qdatastream.h:64
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
#define Q_SIGNALS
Definition: qobjectdefs.h:72
int cursorPosition
the position within the document, where the cursor line should be drawn.
The QSizeF class defines the size of a two-dimensional object using floating point precision...
Definition: qsize.h:202
#define Q_DECLARE_INTERFACE(IFace, IId)
Definition: qobject.h:397
The QAbstractTextDocumentLayout::Selection class is a convenience class defining the parameters of a ...
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
The QRectF class defines a rectangle in the plane using floating point precision. ...
Definition: qrect.h:511
The QTextFormat class provides formatting information for a QTextDocument.
Definition: qtextformat.h:129
The QTextCursor class offers an API to access and modify QTextDocuments.
Definition: qtextcursor.h:70
The QTextBlock class provides a container for text fragments in a QTextDocument.
Definition: qtextobject.h:199
QRectF clip
a hint to the layout specifying the area around paragraphs, frames or text require painting...
static qreal component(const QPointF &point, unsigned int i)
The QTextObjectInterface class allows drawing of custom text objects in QTextDocument.
#define Q_OBJECT
Definition: qobjectdefs.h:157
The QTextLayout class is used to lay out and render text.
Definition: qtextlayout.h:105
The QTextInlineObject class represents an inline object in a QTextLayout.
Definition: qtextlayout.h:69
The QAbstractTextDocumentLayout::PaintContext class is a convenience class defining the parameters us...
virtual ~QTextObjectInterface()
Destroys this QTextObjectInterface.
The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit...
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
QVector< Selection > selections
the collection of selections that will be rendered when passing this paint context to QAbstractTextDo...
#define class
#define QT_END_HEADER
Definition: qglobal.h:137
The QAbstractTextDocumentLayout class is an abstract base class used to implement custom layouts for ...
The QPalette class contains color groups for each widget state.
Definition: qpalette.h:61