1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtGui module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    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 

    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     {

    79         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 QTextDocument;

   126     friend class QTextDocumentPrivate;

   127     friend class QTextEngine;

   128     friend class QTextLayout;

   129     friend class QTextLine;

   130     Q_PRIVATE_SLOT(d_func(), void _q_handlerDestroyed(QObject *obj))

   131     Q_PRIVATE_SLOT(d_func(), int _q_dynamicPageCountSlot())

   132     Q_PRIVATE_SLOT(d_func(), QSizeF _q_dynamicDocumentSizeSlot())

   133 };

   134 

   135 class Q_GUI_EXPORT QTextObjectInterface

   136 {

   137 public:

   138     virtual ~QTextObjectInterface() {}

   139     virtual QSizeF intrinsicSize(QTextDocument *doc, int posInDocument, const QTextFormat &format) = 0;

   140     virtual void drawObject(QPainter *painter, const QRectF &rect, QTextDocument *doc, int posInDocument, const QTextFormat &format) = 0;

   141 };

   142 

   143 Q_DECLARE_INTERFACE(QTextObjectInterface, "com.trolltech.Qt.QTextObjectInterface")

   144 

   145 QT_END_NAMESPACE

   146 

   147 QT_END_HEADER

   148 

   149 #endif // QABSTRACTTEXTDOCUMENTLAYOUT_H