- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Directories
- Examples

- File List
- File Members

# qabstracttextdocumentlayout.h

Go to the documentation of this file.

    00001 /****************************************************************************
    00002 **
    00003 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
    00004 ** All rights reserved.
    00005 ** Contact: Nokia Corporation (qt-info@nokia.com)
    00006 **
    00007 ** This file is part of the QtGui module of the Qt Toolkit.
    00008 **
    00009 ** $QT_BEGIN_LICENSE:LGPL$
    00010 ** Commercial Usage
    00011 ** Licensees holding valid Qt Commercial licenses may use this file in
    00012 ** accordance with the Qt Commercial License Agreement provided with the
    00013 ** Software or, alternatively, in accordance with the terms contained in
    00014 ** a written agreement between you and Nokia.
    00015 **
    00016 ** GNU Lesser General Public License Usage
    00017 ** Alternatively, this file may be used under the terms of the GNU Lesser
    00018 ** General Public License version 2.1 as published by the Free Software
    00019 ** Foundation and appearing in the file LICENSE.LGPL included in the
    00020 ** packaging of this file.  Please review the following information to
    00021 ** ensure the GNU Lesser General Public License version 2.1 requirements
    00022 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
    00023 **
    00024 ** In addition, as a special exception, Nokia gives you certain additional
    00025 ** rights.  These rights are described in the Nokia Qt LGPL Exception
    00026 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this module.
    00027 **
    00028 ** GNU General Public License Usage
    00029 ** Alternatively, this file may be used under the terms of the GNU
    00030 ** General Public License version 3.0 as published by the Free Software
    00031 ** Foundation and appearing in the file LICENSE.GPL included in the
    00032 ** packaging of this file.  Please review the following information to
    00033 ** ensure the GNU General Public License version 3.0 requirements will be
    00034 ** met: http://www.gnu.org/copyleft/gpl.html.
    00035 **
    00036 ** If you have questions regarding the use of this file, please contact
    00037 ** Nokia at qt-info@nokia.com.
    00038 ** $QT_END_LICENSE$
    00039 **
    00040 ****************************************************************************/
    00041
    00042 #ifndef QABSTRACTTEXTDOCUMENTLAYOUT_H
    00043 #define QABSTRACTTEXTDOCUMENTLAYOUT_H
    00044
    00045 #include <QtCore/qobject.h>
    00046 #include <QtGui/qtextlayout.h>
    00047 #include <QtGui/qtextdocument.h>
    00048 #include <QtGui/qtextcursor.h>
    00049 #include <QtGui/qpalette.h>
    00050
    00051 QT_BEGIN_HEADER
    00052
    00053 QT_BEGIN_NAMESPACE
    00054
    00055 QT_MODULE(Gui)
    00056
    00057 class QAbstractTextDocumentLayoutPrivate;
    00058 class QTextBlock;
    00059 class QTextObjectInterface;
    00060 class QTextFrame;
    00061
    00062 class Q_GUI_EXPORT QAbstractTextDocumentLayout : public QObject
    00063 {
    00064     Q_OBJECT
    00065     Q_DECLARE_PRIVATE(QAbstractTextDocumentLayout)
    00066
    00067 public:
    00068     explicit QAbstractTextDocumentLayout(QTextDocument *doc);
    00069     ~QAbstractTextDocumentLayout();
    00070
    00071     struct Selection
    00072     {
    00073         QTextCursor cursor;
    00074         QTextCharFormat format;
    00075     };
    00076
    00077     struct PaintContext
    00078     {
    00079         PaintContext()
    00080             : cursorPosition(-1)
    00081             {}
    00082         int cursorPosition;
    00083         QPalette palette;
    00084         QRectF clip;
    00085         QVector<Selection> selections;
    00086     };
    00087
    00088     virtual void draw(QPainter *painter, const PaintContext &context) = 0;
    00089     virtual int hitTest(const QPointF &point, Qt::HitTestAccuracy accuracy) const = 0;
    00090     QString anchorAt(const QPointF& pos) const;
    00091
    00092     virtual int pageCount() const = 0;
    00093     virtual QSizeF documentSize() const = 0;
    00094
    00095     virtual QRectF frameBoundingRect(QTextFrame *frame) const = 0;
    00096     virtual QRectF blockBoundingRect(const QTextBlock &block) const = 0;
    00097
    00098     void setPaintDevice(QPaintDevice *device);
    00099     QPaintDevice *paintDevice() const;
    00100
    00101     QTextDocument *document() const;
    00102
    00103     void registerHandler(int objectType, QObject *component);
    00104     QTextObjectInterface *handlerForObject(int objectType) const;
    00105
    00106 Q_SIGNALS:
    00107     void update(const QRectF & = QRectF(0., 0., 1000000000., 1000000000.));
    00108     void updateBlock(const QTextBlock &block);
    00109     void documentSizeChanged(const QSizeF &newSize);
    00110     void pageCountChanged(int newPages);
    00111
    00112 protected:
    00113     QAbstractTextDocumentLayout(QAbstractTextDocumentLayoutPrivate &, QTextDocument *);
    00114
    00115     virtual void documentChanged(int from, int charsRemoved, int charsAdded) = 0;
    00116
    00117     virtual void resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
    00118     virtual void positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
    00119     virtual void drawInlineObject(QPainter *painter, const QRectF &rect, QTextInlineObject object, int posInDocument, const QTextFormat &format);
    00120
    00121     int formatIndex(int pos);
    00122     QTextCharFormat format(int pos);
    00123
    00124 private:
    00125     friend class QTextControl;
    00126     friend class QTextDocument;
    00127     friend class QTextDocumentPrivate;
    00128     friend class QTextEngine;
    00129     friend class QTextLayout;
    00130     friend class QTextLine;
    00131     Q_PRIVATE_SLOT(d_func(), void _q_handlerDestroyed(QObject *obj))
    00132     Q_PRIVATE_SLOT(d_func(), int _q_dynamicPageCountSlot())
    00133     Q_PRIVATE_SLOT(d_func(), QSizeF _q_dynamicDocumentSizeSlot())
    00134 };
    00135
    00136 class Q_GUI_EXPORT QTextObjectInterface
    00137 {
    00138 public:
    00139     virtual ~QTextObjectInterface() {}
    00140     virtual QSizeF intrinsicSize(QTextDocument *doc, int posInDocument, const QTextFormat &format) = 0;
    00141     virtual void drawObject(QPainter *painter, const QRectF &rect, QTextDocument *doc, int posInDocument, const QTextFormat &format) = 0;
    00142 };
    00143
    00144 Q_DECLARE_INTERFACE(QTextObjectInterface, "com.trolltech.Qt.QTextObjectInterface")
    00145
    00146 QT_END_NAMESPACE
    00147
    00148 QT_END_HEADER
    00149
    00150 #endif // QABSTRACTTEXTDOCUMENTLAYOUT_H