src/gui/text/qglyphrun.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 QOpenGLYPHRUN_H
  43 #define QOpenGLYPHRUN_H
  44
  45 #include <QtCore/qsharedpointer.h>
  46 #include <QtCore/qvector.h>
  47 #include <QtCore/qpoint.h>
  48 #include <QtGui/qrawfont.h>
  49
  50 #if !defined(QT_NO_RAWFONT)
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56
  57 class QGlyphRunPrivate;
  58 class Q_GUI_EXPORT QGlyphRun
  59 {
  60 public:
  61     enum GlyphRunFlag {
  62         Overline        = 0x01,
  63         Underline       = 0x02,
  64         StrikeOut       = 0x04,
  65         RightToLeft     = 0x08,
  66         SplitLigature   = 0x10
  67     };
  68     Q_DECLARE_FLAGS(GlyphRunFlags, GlyphRunFlag)
  69
  70     QGlyphRun();
  71     QGlyphRun(const QGlyphRun &other);
  72     ~QGlyphRun();
  73
  74     QRawFont rawFont() const;
  75     void setRawFont(const QRawFont &rawFont);
  76
  77     void setRawData(const quint32 *glyphIndexArray,
  78                     const QPointF *glyphPositionArray,
  79                     int size);
  80
  81     QVector<quint32> glyphIndexes() const;
  82     void setGlyphIndexes(const QVector<quint32> &glyphIndexes);
  83
  84     QVector<QPointF> positions() const;
  85     void setPositions(const QVector<QPointF> &positions);
  86
  87     void clear();
  88
  89     QGlyphRun &operator=(const QGlyphRun &other);
  90
  91     bool operator==(const QGlyphRun &other) const;
  92     inline bool operator!=(const QGlyphRun &other) const
  93     { return !operator==(other); }
  94
  95     void setOverline(bool overline);
  96     bool overline() const;
  97
  98     void setUnderline(bool underline);
  99     bool underline() const;
 100
 101     void setStrikeOut(bool strikeOut);
 102     bool strikeOut() const;
 103
 104     void setRightToLeft(bool on);
 105     bool isRightToLeft() const;
 106
 107     void setFlag(GlyphRunFlag flag, bool enabled = true);
 108     void setFlags(GlyphRunFlags flags);
 109     GlyphRunFlags flags() const;
 110
 111     void setBoundingRect(const QRectF &boundingRect);
 112     QRectF boundingRect() const;
 113
 114     bool isEmpty() const;
 115
 116 private:
 117     friend class QGlyphRunPrivate;
 118     friend class QTextLine;
 119
 120     QGlyphRun operator+(const QGlyphRun &other) const;
 121     QGlyphRun &operator+=(const QGlyphRun &other);
 122
 123     void detach();
 124     QExplicitlySharedDataPointer<QGlyphRunPrivate> d;
 125 };
 126
 127 Q_DECLARE_TYPEINFO(QGlyphRun, Q_MOVABLE_TYPE);
 128
 129 QT_END_NAMESPACE
 130
 131 QT_END_HEADER
 132
 133 #endif // QT_NO_RAWFONT
 134
 135 #endif // QOpenGLYPHS_H