src/gui/text/qtextdocumentlayout_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 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 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QTEXTDOCUMENTLAYOUT_P_H
  43 #define QTEXTDOCUMENTLAYOUT_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 "QtGui/qabstracttextdocumentlayout.h"
  57 #include "QtGui/qtextoption.h"
  58 #include "QtGui/qtextobject.h"
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 class QTextListFormat;
  63
  64 class QTextDocumentLayoutPrivate;
  65
  66 class Q_AUTOTEST_EXPORT QTextDocumentLayout : public QAbstractTextDocumentLayout
  67 {
  68     Q_DECLARE_PRIVATE(QTextDocumentLayout)
  69     Q_OBJECT
  70     Q_PROPERTY(int cursorWidth READ cursorWidth WRITE setCursorWidth)
  71     Q_PROPERTY(qreal idealWidth READ idealWidth)
  72     Q_PROPERTY(bool contentHasAlignment READ contentHasAlignment)
  73 public:
  74     explicit QTextDocumentLayout(QTextDocument *doc);
  75
  76     // from the abstract layout
  77     void draw(QPainter *painter, const PaintContext &context);
  78     int hitTest(const QPointF &point, Qt::HitTestAccuracy accuracy) const;
  79
  80     int pageCount() const;
  81     QSizeF documentSize() const;
  82
  83     void setCursorWidth(int width);
  84     int cursorWidth() const;
  85
  86     // internal, to support the ugly FixedColumnWidth wordwrap mode in QTextEdit
  87     void setFixedColumnWidth(int width);
  88
  89     // internal for QTextEdit's NoWrap mode
  90     void setViewport(const QRectF &viewport);
  91
  92     virtual QRectF frameBoundingRect(QTextFrame *frame) const;
  93     virtual QRectF blockBoundingRect(const QTextBlock &block) const;
  94
  95     // ####
  96     int layoutStatus() const;
  97     int dynamicPageCount() const;
  98     QSizeF dynamicDocumentSize() const;
  99     void ensureLayouted(qreal);
 100
 101     qreal idealWidth() const;
 102
 103     bool contentHasAlignment() const;
 104
 105 protected:
 106     void documentChanged(int from, int oldLength, int length);
 107     void resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
 108     void positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
 109     void drawInlineObject(QPainter *p, const QRectF &rect, QTextInlineObject item,
 110                           int posInDocument, const QTextFormat &format);
 111     virtual void timerEvent(QTimerEvent *e);
 112 private:
 113     QRectF doLayout(int from, int oldLength, int length);
 114     void layoutFinished();
 115 };
 116
 117 QT_END_NAMESPACE
 118
 119 #endif // QTEXTDOCUMENTLAYOUT_P_H