src/gui/text/qtextlayout.h
changeset 0 1918ee327afb
child 3 41300fa6a67c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/gui/text/qtextlayout.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,243 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+#ifndef QTEXTLAYOUT_H
+#define QTEXTLAYOUT_H
+
+#include <QtCore/qstring.h>
+#include <QtCore/qnamespace.h>
+#include <QtCore/qrect.h>
+#include <QtCore/qvector.h>
+#include <QtGui/qcolor.h>
+#include <QtCore/qobject.h>
+#include <QtGui/qevent.h>
+#include <QtGui/qtextformat.h>
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+QT_MODULE(Gui)
+
+class QTextEngine;
+class QFont;
+class QRect;
+class QRegion;
+class QTextFormat;
+class QPalette;
+class QPainter;
+
+class Q_GUI_EXPORT QTextInlineObject
+{
+public:
+    QTextInlineObject(int i, QTextEngine *e) : itm(i), eng(e) {}
+    inline QTextInlineObject() : itm(0), eng(0) {}
+    inline bool isValid() const { return eng; }
+
+    QRectF rect() const;
+    qreal width() const;
+    qreal ascent() const;
+    qreal descent() const;
+    qreal height() const;
+
+    Qt::LayoutDirection textDirection() const;
+
+    void setWidth(qreal w);
+    void setAscent(qreal a);
+    void setDescent(qreal d);
+
+    int textPosition() const;
+
+    int formatIndex() const;
+    QTextFormat format() const;
+
+private:
+    friend class QTextLayout;
+    int itm;
+    QTextEngine *eng;
+};
+
+class QPaintDevice;
+class QTextFormat;
+class QTextLine;
+class QTextBlock;
+class QTextOption;
+
+class Q_GUI_EXPORT QTextLayout
+{
+public:
+    // does itemization
+    QTextLayout();
+    QTextLayout(const QString& text);
+    QTextLayout(const QString& text, const QFont &font, QPaintDevice *paintdevice = 0);
+    QTextLayout(const QTextBlock &b);
+    ~QTextLayout();
+
+    void setFont(const QFont &f);
+    QFont font() const;
+
+    void setText(const QString& string);
+    QString text() const;
+
+    void setTextOption(const QTextOption &option);
+    QTextOption textOption() const;
+
+    void setPreeditArea(int position, const QString &text);
+    int preeditAreaPosition() const;
+    QString preeditAreaText() const;
+
+    struct FormatRange {
+        int start;
+        int length;
+        QTextCharFormat format;
+    };
+    void setAdditionalFormats(const QList<FormatRange> &overrides);
+    QList<FormatRange> additionalFormats() const;
+    void clearAdditionalFormats();
+
+    void setCacheEnabled(bool enable);
+    bool cacheEnabled() const;
+
+    void beginLayout();
+    void endLayout();
+    void clearLayout();
+
+    QTextLine createLine();
+
+    int lineCount() const;
+    QTextLine lineAt(int i) const;
+    QTextLine lineForTextPosition(int pos) const;
+
+    enum CursorMode {
+        SkipCharacters,
+        SkipWords
+    };
+    bool isValidCursorPosition(int pos) const;
+    int nextCursorPosition(int oldPos, CursorMode mode = SkipCharacters) const;
+    int previousCursorPosition(int oldPos, CursorMode mode = SkipCharacters) const;
+
+    void draw(QPainter *p, const QPointF &pos, const QVector<FormatRange> &selections = QVector<FormatRange>(),
+              const QRectF &clip = QRectF()) const;
+    void drawCursor(QPainter *p, const QPointF &pos, int cursorPosition) const;
+    void drawCursor(QPainter *p, const QPointF &pos, int cursorPosition, int width) const;
+
+    QPointF position() const;
+    void setPosition(const QPointF &p);
+
+    QRectF boundingRect() const;
+
+    qreal minimumWidth() const;
+    qreal maximumWidth() const;
+
+    QTextEngine *engine() const { return d; }
+    void setFlags(int flags);
+private:
+    QTextLayout(QTextEngine *e) : d(e) {}
+    Q_DISABLE_COPY(QTextLayout)
+
+    friend class QPainter;
+    friend class QPSPrinter;
+    friend class QGraphicsSimpleTextItemPrivate;
+    friend class QGraphicsSimpleTextItem;
+    friend void qt_format_text(const QFont &font, const QRectF &_r, int tf, const QTextOption *, const QString& str,
+                               QRectF *brect, int tabstops, int* tabarray, int tabarraylen,
+                               QPainter *painter);
+    QTextEngine *d;
+};
+
+
+class Q_GUI_EXPORT QTextLine
+{
+public:
+    inline QTextLine() : i(0), eng(0) {}
+    inline bool isValid() const { return eng; }
+
+    QRectF rect() const;
+    qreal x() const;
+    qreal y() const;
+    qreal width() const;
+    qreal ascent() const;
+    qreal descent() const;
+    qreal height() const;
+
+    qreal naturalTextWidth() const;
+    QRectF naturalTextRect() const;
+
+    enum Edge {
+        Leading,
+        Trailing
+    };
+    enum CursorPosition {
+        CursorBetweenCharacters,
+        CursorOnCharacter
+    };
+
+    /* cursorPos gets set to the valid position */
+    qreal cursorToX(int *cursorPos, Edge edge = Leading) const;
+    inline qreal cursorToX(int cursorPos, Edge edge = Leading) const { return cursorToX(&cursorPos, edge); }
+    int xToCursor(qreal x, CursorPosition = CursorBetweenCharacters) const;
+
+    void setLineWidth(qreal width);
+    void setNumColumns(int columns);
+    void setNumColumns(int columns, qreal alignmentWidth);
+
+    void setPosition(const QPointF &pos);
+    QPointF position() const;
+
+    int textStart() const;
+    int textLength() const;
+
+    int lineNumber() const { return i; }
+
+    void draw(QPainter *p, const QPointF &point, const QTextLayout::FormatRange *selection = 0) const;
+
+private:
+    QTextLine(int line, QTextEngine *e) : i(line), eng(e) {}
+    void layout_helper(int numGlyphs);
+    friend class QTextLayout;
+    int i;
+    QTextEngine *eng;
+};
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif // QTEXTLAYOUT_H