summaryrefslogtreecommitdiffstats log msg author committer range
path: root/src/gui/text/qglyphs.cpp
blob: cfea6ece93f8735c57d51051b1d4571cd4bcbb5d (plain)
 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323  /**************************************************************************** ** ** Copyright (C) 2011 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$ ** ****************************************************************************/ #include "qglobal.h" #if !defined(QT_NO_RAWFONT) #include "qglyphs.h" #include "qglyphs_p.h" QT_BEGIN_NAMESPACE /*! \class QGlyphs \brief The QGlyphs class provides direct access to the internal glyphs in a font. \since 4.8 \ingroup text \mainclass When Qt displays a string of text encoded in Unicode, it will first convert the Unicode points into a list of glyph indexes and a list of positions based on one or more fonts. The Unicode representation of the text and the QFont object will in this case serve as a convenient abstraction that hides the details of what actually takes place when displaying the text on-screen. For instance, by the time the text actually reaches the screen, it may be represented by a set of fonts in addition to the one specified by the user, e.g. in case the originally selected font did not support all the writing systems contained in the text. Under certain circumstances, it can be useful as an application developer to have more low-level control over which glyphs in a specific font are drawn to the screen. This could for instance be the case in applications that use an external font engine and text shaper together with Qt. QGlyphs provides an interface to the raw data needed to get text on the screen. It contains a list of glyph indexes, a position for each glyph and a font. It is the user's responsibility to ensure that the selected font actually contains the provided glyph indexes. QTextLayout::glyphs() or QTextFragment::glyphs() can be used to convert unicode encoded text into a list of QGlyphs objects, and QPainter::drawGlyphs() can be used to draw the glyphs. \note Please note that QRawFont is considered local to the thread in which it is constructed. This in turn means that a new QRawFont will have to be created and set on the QGlyphs if it is moved to a different thread. If the QGlyphs contains a reference to a QRawFont from a different thread than the current, it will not be possible to draw the glyphs using a QPainter, as the QRawFont is considered invalid and inaccessible in this case. */ /*! Constructs an empty QGlyphs object. */ QGlyphs::QGlyphs() : d(new QGlyphsPrivate) { } /*! Constructs a QGlyphs object which is a copy of \a other. */ QGlyphs::QGlyphs(const QGlyphs &other) { d = other.d; } /*! Destroys the QGlyphs. */ QGlyphs::~QGlyphs() { // Required for QExplicitlySharedDataPointer } /*! \internal */ void QGlyphs::detach() { if (d->ref != 1) d.detach(); } /*! Assigns \a other to this QGlyphs object. */ QGlyphs &QGlyphs::operator=(const QGlyphs &other) { d = other.d; return *this; } /*! Compares \a other to this QGlyphs object. Returns true if the list of glyph indexes, the list of positions and the font are all equal, otherwise returns false. */ bool QGlyphs::operator==(const QGlyphs &other) const { return ((d == other.d) || (d->glyphIndexes == other.d->glyphIndexes && d->glyphPositions == other.d->glyphPositions && d->overline == other.d->overline && d->underline == other.d->underline && d->strikeOut == other.d->strikeOut && d->font == other.d->font)); } /*! Compares \a other to this QGlyphs object. Returns true if any of the list of glyph indexes, the list of positions or the font are different, otherwise returns false. */ bool QGlyphs::operator!=(const QGlyphs &other) const { return !(*this == other); } /*! \internal Adds together the lists of glyph indexes and positions in \a other and this QGlyphs object and returns the result. The font in the returned QGlyphs will be the same as in this QGlyphs object. */ QGlyphs QGlyphs::operator+(const QGlyphs &other) const { QGlyphs ret(*this); ret += other; return ret; } /*! \internal Appends the glyph indexes and positions in \a other to this QGlyphs object and returns a reference to the current object. */ QGlyphs &QGlyphs::operator+=(const QGlyphs &other) { detach(); d->glyphIndexes += other.d->glyphIndexes; d->glyphPositions += other.d->glyphPositions; return *this; } /*! Returns the font selected for this QGlyphs object. \sa setFont() */ QRawFont QGlyphs::font() const { return d->font; } /*! Sets the font in which to look up the glyph indexes to \a font. \sa font(), setGlyphIndexes() */ void QGlyphs::setFont(const QRawFont &font) { detach(); d->font = font; } /*! Returns the glyph indexes for this QGlyphs object. \sa setGlyphIndexes(), setPositions() */ QVector QGlyphs::glyphIndexes() const { return d->glyphIndexes; } /*! Set the glyph indexes for this QGlyphs object to \a glyphIndexes. The glyph indexes must be valid for the selected font. */ void QGlyphs::setGlyphIndexes(const QVector &glyphIndexes) { detach(); d->glyphIndexes = glyphIndexes; } /*! Returns the position of the edge of the baseline for each glyph in this set of glyph indexes. */ QVector QGlyphs::positions() const { return d->glyphPositions; } /*! Sets the positions of the edge of the baseline for each glyph in this set of glyph indexes to \a positions. */ void QGlyphs::setPositions(const QVector &positions) { detach(); d->glyphPositions = positions; } /*! Clears all data in the QGlyphs object. */ void QGlyphs::clear() { detach(); d->glyphPositions = QVector(); d->glyphIndexes = QVector(); d->font = QRawFont(); d->strikeOut = false; d->overline = false; d->underline = false; } /*! Returns true if this QGlyphs should be painted with an overline decoration. \sa setOverline() */ bool QGlyphs::overline() const { return d->overline; } /*! Indicates that this QGlyphs should be painted with an overline decoration if \a overline is true. Otherwise the QGlyphs should be painted with no overline decoration. \sa overline() */ void QGlyphs::setOverline(bool overline) { detach(); d->overline = overline; } /*! Returns true if this QGlyphs should be painted with an underline decoration. \sa setUnderline() */ bool QGlyphs::underline() const { return d->underline; } /*! Indicates that this QGlyphs should be painted with an underline decoration if \a underline is true. Otherwise the QGlyphs should be painted with no underline decoration. \sa underline() */ void QGlyphs::setUnderline(bool underline) { detach(); d->underline = underline; } /*! Returns true if this QGlyphs should be painted with a strike out decoration. \sa setStrikeOut() */ bool QGlyphs::strikeOut() const { return d->strikeOut; } /*! Indicates that this QGlyphs should be painted with an strike out decoration if \a strikeOut is true. Otherwise the QGlyphs should be painted with no strike out decoration. \sa strikeOut() */ void QGlyphs::setStrikeOut(bool strikeOut) { detach(); d->strikeOut = strikeOut; } QT_END_NAMESPACE #endif // QT_NO_RAWFONT