src/gui/text/qtextdocumentlayout_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtGui module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  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 class QTextTableCell;
  64 class QTextDocumentLayoutPrivate;
  65
  66 class Q_GUI_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     QRectF tableBoundingRect(QTextTable *table) const;
  95     QRectF tableCellBoundingRect(QTextTable *table, const QTextTableCell &cell) const;
  96
  97     // ####
  98     int layoutStatus() const;
  99     int dynamicPageCount() const;
 100     QSizeF dynamicDocumentSize() const;
 101     void ensureLayouted(qreal);
 102
 103     qreal idealWidth() const;
 104
 105     bool contentHasAlignment() const;
 106
 107 protected:
 108     void documentChanged(int from, int oldLength, int length);
 109     void resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
 110     void positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
 111     void drawInlineObject(QPainter *p, const QRectF &rect, QTextInlineObject item,
 112                           int posInDocument, const QTextFormat &format);
 113     virtual void timerEvent(QTimerEvent *e);
 114 private:
 115     QRectF doLayout(int from, int oldLength, int length);
 116     void layoutFinished();
 117 };
 118
 119 QT_END_NAMESPACE
 120
 121 #endif // QTEXTDOCUMENTLAYOUT_P_H