qtext/qtextdocumentlayout_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: Qt Software Information (qt-info@nokia.com)
   5 **
   6 ** This file is part of the QtGui module of the Qt Toolkit.
   7 **
   8 ** Commercial Usage
   9 ** Licensees holding valid Qt Commercial licenses may use this file in
  10 ** accordance with the Qt Commercial License Agreement provided with the
  11 ** Software or, alternatively, in accordance with the terms contained in
  12 ** a written agreement between you and Nokia.
  13 **
  14 **
  15 ** GNU General Public License Usage
  16 ** Alternatively, this file may be used under the terms of the GNU
  17 ** General Public License versions 2.0 or 3.0 as published by the Free
  18 ** Software Foundation and appearing in the file LICENSE.GPL included in
  19 ** the packaging of this file.  Please review the following information
  20 ** to ensure GNU General Public Licensing requirements will be met:
  21 ** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
  22 ** http://www.gnu.org/copyleft/gpl.html.  In addition, as a special
  23 ** exception, Nokia gives you certain additional rights. These rights
  24 ** are described in the Nokia Qt GPL Exception version 1.3, included in
  25 ** the file GPL_EXCEPTION.txt in this package.
  26 **
  27 ** Qt for Windows(R) Licensees
  28 ** As a special exception, Nokia, as the sole copyright holder for Qt
  29 ** Designer, grants users of the Qt/Eclipse Integration plug-in the
  30 ** right for the Qt/Eclipse Integration to link to functionality
  31 ** provided by Qt Designer and its related libraries.
  32 **
  33 ** If you are unsure which license is appropriate for your use, please
  34 ** contact the sales department at qt-sales@nokia.com.
  35 **
  36 ****************************************************************************/
  37
  38 #ifndef QTEXTDOCUMENTLAYOUT_P_H
  39 #define QTEXTDOCUMENTLAYOUT_P_H
  40
  41 //
  42 //  W A R N I N G
  43 //  -------------
  44 //
  45 // This file is not part of the Qt API.  It exists purely as an
  46 // implementation detail.  This header file may change from version to
  47 // version without notice, or even be removed.
  48 //
  49 // We mean it.
  50 //
  51
  52 #include "QtGui/qabstracttextdocumentlayout.h"
  53 #include "QtGui/qtextoption.h"
  54 #include "QtGui/qtextobject.h"
  55
  56 QT_BEGIN_NAMESPACE
  57
  58 class QTextListFormat;
  59
  60 class QTextDocumentLayoutPrivate;
  61
  62 class Q_AUTOTEST_EXPORT QTextDocumentLayout : public QAbstractTextDocumentLayout
  63 {
  64     Q_DECLARE_PRIVATE(QTextDocumentLayout)
  65     Q_OBJECT
  66     Q_PROPERTY(int cursorWidth READ cursorWidth WRITE setCursorWidth)
  67     Q_PROPERTY(qreal idealWidth READ idealWidth)
  68     Q_PROPERTY(bool contentHasAlignment READ contentHasAlignment)
  69 public:
  70     explicit QTextDocumentLayout(QTextDocument *doc);
  71
  72     // from the abstract layout
  73     void draw(QPainter *painter, const PaintContext &context);
  74     int hitTest(const QPointF &point, Qt::HitTestAccuracy accuracy) const;
  75
  76     int pageCount() const;
  77     QSizeF documentSize() const;
  78
  79     void setCursorWidth(int width);
  80     int cursorWidth() const;
  81
  82     // internal, to support the ugly FixedColumnWidth wordwrap mode in QTextEdit
  83     void setFixedColumnWidth(int width);
  84
  85     virtual QRectF frameBoundingRect(QTextFrame *frame) const;
  86     virtual QRectF blockBoundingRect(const QTextBlock &block) const;
  87
  88     // ####
  89     int layoutStatus() const;
  90     int dynamicPageCount() const;
  91     QSizeF dynamicDocumentSize() const;
  92     void ensureLayouted(qreal);
  93
  94     qreal idealWidth() const;
  95
  96     bool contentHasAlignment() const;
  97
  98 protected:
  99     void documentChanged(int from, int oldLength, int length);
 100     void resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
 101     void positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format);
 102     void drawInlineObject(QPainter *p, const QRectF &rect, QTextInlineObject item,
 103                           int posInDocument, const QTextFormat &format);
 104     virtual void timerEvent(QTimerEvent *e);
 105 private:
 106     QRectF doLayout(int from, int oldLength, int length);
 107     void layoutFinished();
 108 };
 109
 110 QT_END_NAMESPACE
 111
 112 #endif // QTEXTDOCUMENTLAYOUT_P_H