src/gui/text/qtextlayout.h
changeset 0 1918ee327afb
child 3 41300fa6a67c
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     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 #ifndef QTEXTLAYOUT_H
       
    42 #define QTEXTLAYOUT_H
       
    43 
       
    44 #include <QtCore/qstring.h>
       
    45 #include <QtCore/qnamespace.h>
       
    46 #include <QtCore/qrect.h>
       
    47 #include <QtCore/qvector.h>
       
    48 #include <QtGui/qcolor.h>
       
    49 #include <QtCore/qobject.h>
       
    50 #include <QtGui/qevent.h>
       
    51 #include <QtGui/qtextformat.h>
       
    52 
       
    53 QT_BEGIN_HEADER
       
    54 
       
    55 QT_BEGIN_NAMESPACE
       
    56 
       
    57 QT_MODULE(Gui)
       
    58 
       
    59 class QTextEngine;
       
    60 class QFont;
       
    61 class QRect;
       
    62 class QRegion;
       
    63 class QTextFormat;
       
    64 class QPalette;
       
    65 class QPainter;
       
    66 
       
    67 class Q_GUI_EXPORT QTextInlineObject
       
    68 {
       
    69 public:
       
    70     QTextInlineObject(int i, QTextEngine *e) : itm(i), eng(e) {}
       
    71     inline QTextInlineObject() : itm(0), eng(0) {}
       
    72     inline bool isValid() const { return eng; }
       
    73 
       
    74     QRectF rect() const;
       
    75     qreal width() const;
       
    76     qreal ascent() const;
       
    77     qreal descent() const;
       
    78     qreal height() const;
       
    79 
       
    80     Qt::LayoutDirection textDirection() const;
       
    81 
       
    82     void setWidth(qreal w);
       
    83     void setAscent(qreal a);
       
    84     void setDescent(qreal d);
       
    85 
       
    86     int textPosition() const;
       
    87 
       
    88     int formatIndex() const;
       
    89     QTextFormat format() const;
       
    90 
       
    91 private:
       
    92     friend class QTextLayout;
       
    93     int itm;
       
    94     QTextEngine *eng;
       
    95 };
       
    96 
       
    97 class QPaintDevice;
       
    98 class QTextFormat;
       
    99 class QTextLine;
       
   100 class QTextBlock;
       
   101 class QTextOption;
       
   102 
       
   103 class Q_GUI_EXPORT QTextLayout
       
   104 {
       
   105 public:
       
   106     // does itemization
       
   107     QTextLayout();
       
   108     QTextLayout(const QString& text);
       
   109     QTextLayout(const QString& text, const QFont &font, QPaintDevice *paintdevice = 0);
       
   110     QTextLayout(const QTextBlock &b);
       
   111     ~QTextLayout();
       
   112 
       
   113     void setFont(const QFont &f);
       
   114     QFont font() const;
       
   115 
       
   116     void setText(const QString& string);
       
   117     QString text() const;
       
   118 
       
   119     void setTextOption(const QTextOption &option);
       
   120     QTextOption textOption() const;
       
   121 
       
   122     void setPreeditArea(int position, const QString &text);
       
   123     int preeditAreaPosition() const;
       
   124     QString preeditAreaText() const;
       
   125 
       
   126     struct FormatRange {
       
   127         int start;
       
   128         int length;
       
   129         QTextCharFormat format;
       
   130     };
       
   131     void setAdditionalFormats(const QList<FormatRange> &overrides);
       
   132     QList<FormatRange> additionalFormats() const;
       
   133     void clearAdditionalFormats();
       
   134 
       
   135     void setCacheEnabled(bool enable);
       
   136     bool cacheEnabled() const;
       
   137 
       
   138     void beginLayout();
       
   139     void endLayout();
       
   140     void clearLayout();
       
   141 
       
   142     QTextLine createLine();
       
   143 
       
   144     int lineCount() const;
       
   145     QTextLine lineAt(int i) const;
       
   146     QTextLine lineForTextPosition(int pos) const;
       
   147 
       
   148     enum CursorMode {
       
   149         SkipCharacters,
       
   150         SkipWords
       
   151     };
       
   152     bool isValidCursorPosition(int pos) const;
       
   153     int nextCursorPosition(int oldPos, CursorMode mode = SkipCharacters) const;
       
   154     int previousCursorPosition(int oldPos, CursorMode mode = SkipCharacters) const;
       
   155 
       
   156     void draw(QPainter *p, const QPointF &pos, const QVector<FormatRange> &selections = QVector<FormatRange>(),
       
   157               const QRectF &clip = QRectF()) const;
       
   158     void drawCursor(QPainter *p, const QPointF &pos, int cursorPosition) const;
       
   159     void drawCursor(QPainter *p, const QPointF &pos, int cursorPosition, int width) const;
       
   160 
       
   161     QPointF position() const;
       
   162     void setPosition(const QPointF &p);
       
   163 
       
   164     QRectF boundingRect() const;
       
   165 
       
   166     qreal minimumWidth() const;
       
   167     qreal maximumWidth() const;
       
   168 
       
   169     QTextEngine *engine() const { return d; }
       
   170     void setFlags(int flags);
       
   171 private:
       
   172     QTextLayout(QTextEngine *e) : d(e) {}
       
   173     Q_DISABLE_COPY(QTextLayout)
       
   174 
       
   175     friend class QPainter;
       
   176     friend class QPSPrinter;
       
   177     friend class QGraphicsSimpleTextItemPrivate;
       
   178     friend class QGraphicsSimpleTextItem;
       
   179     friend void qt_format_text(const QFont &font, const QRectF &_r, int tf, const QTextOption *, const QString& str,
       
   180                                QRectF *brect, int tabstops, int* tabarray, int tabarraylen,
       
   181                                QPainter *painter);
       
   182     QTextEngine *d;
       
   183 };
       
   184 
       
   185 
       
   186 class Q_GUI_EXPORT QTextLine
       
   187 {
       
   188 public:
       
   189     inline QTextLine() : i(0), eng(0) {}
       
   190     inline bool isValid() const { return eng; }
       
   191 
       
   192     QRectF rect() const;
       
   193     qreal x() const;
       
   194     qreal y() const;
       
   195     qreal width() const;
       
   196     qreal ascent() const;
       
   197     qreal descent() const;
       
   198     qreal height() const;
       
   199 
       
   200     qreal naturalTextWidth() const;
       
   201     QRectF naturalTextRect() const;
       
   202 
       
   203     enum Edge {
       
   204         Leading,
       
   205         Trailing
       
   206     };
       
   207     enum CursorPosition {
       
   208         CursorBetweenCharacters,
       
   209         CursorOnCharacter
       
   210     };
       
   211 
       
   212     /* cursorPos gets set to the valid position */
       
   213     qreal cursorToX(int *cursorPos, Edge edge = Leading) const;
       
   214     inline qreal cursorToX(int cursorPos, Edge edge = Leading) const { return cursorToX(&cursorPos, edge); }
       
   215     int xToCursor(qreal x, CursorPosition = CursorBetweenCharacters) const;
       
   216 
       
   217     void setLineWidth(qreal width);
       
   218     void setNumColumns(int columns);
       
   219     void setNumColumns(int columns, qreal alignmentWidth);
       
   220 
       
   221     void setPosition(const QPointF &pos);
       
   222     QPointF position() const;
       
   223 
       
   224     int textStart() const;
       
   225     int textLength() const;
       
   226 
       
   227     int lineNumber() const { return i; }
       
   228 
       
   229     void draw(QPainter *p, const QPointF &point, const QTextLayout::FormatRange *selection = 0) const;
       
   230 
       
   231 private:
       
   232     QTextLine(int line, QTextEngine *e) : i(line), eng(e) {}
       
   233     void layout_helper(int numGlyphs);
       
   234     friend class QTextLayout;
       
   235     int i;
       
   236     QTextEngine *eng;
       
   237 };
       
   238 
       
   239 QT_END_NAMESPACE
       
   240 
       
   241 QT_END_HEADER
       
   242 
       
   243 #endif // QTEXTLAYOUT_H