Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
QTextEngine Class Reference

#include <qtextengine_p.h>

+ Inheritance diagram for QTextEngine:
+ Collaboration diagram for QTextEngine:

Classes

struct  ItemDecoration
 
struct  LayoutData
 

Public Types

enum  LayoutState { LayoutEmpty , InLayout , LayoutFailed }
 
enum  Mode { WidthOnly = 0x07 }
 
typedef QList< ItemDecoration > ItemDecorationList
 

Public Member Functions

 QTextEngine ()
 
 QTextEngine (const QString &str, const QFont &f)
 
 ~QTextEngine ()
 
void invalidate ()
 
void clearLineData ()
 
void validate () const
 
void itemize () const
 
bool isRightToLeft () const
 
const QCharAttributes * attributes () const
 
void shape (int item) const
 
void justify (const QScriptLine &si)
 
QFixed alignLine (const QScriptLine &line)
 
QFixed width (int charFrom, int numChars) const
 
glyph_metrics_t boundingBox (int from, int len) const
 
glyph_metrics_t tightBoundingBox (int from, int len) const
 
int length (int item) const
 
int length (const QScriptItem *si) const
 
QFontEngine * fontEngine (const QScriptItem &si, QFixed *ascent=nullptr, QFixed *descent=nullptr, QFixed *leading=nullptr) const
 
QFont font (const QScriptItem &si) const
 
QFont font () const
 
unsigned short * logClusters (const QScriptItem *si) const
 
QGlyphLayout availableGlyphs (const QScriptItem *si) const
 
QGlyphLayout shapedGlyphs (const QScriptItem *si) const
 
bool ensureSpace (int nGlyphs) const
 
void freeMemory ()
 
int findItem (int strPos, int firstItem=0) const
 
QTextFormatCollection * formatCollection () const
 
QTextCharFormat format (const QScriptItem *si) const
 
QAbstractTextDocumentLayout * docLayout () const
 
int formatIndex (const QScriptItem *si) const
 
QFixed calculateTabWidth (int index, QFixed x) const
 returns the width of tab at index (in the tabs array) with the tab-start at position x
 
bool visualCursorMovement () const
 
int preeditAreaPosition () const
 
QString preeditAreaText () const
 
void setPreeditArea (int position, const QString &text)
 
bool hasFormats () const
 
QList< QTextLayout::FormatRange > formats () const
 
void setFormats (const QList< QTextLayout::FormatRange > &formats)
 
bool atWordSeparator (int position) const
 
QString elidedText (Qt::TextElideMode mode, QFixed width, int flags=0, int from=0, int count=-1) const
 
void shapeLine (const QScriptLine &line)
 
QFixed leadingSpaceWidth (const QScriptLine &line)
 
QFixed offsetInLigature (const QScriptItem *si, int pos, int max, int glyph_pos)
 
int positionInLigature (const QScriptItem *si, int end, QFixed x, QFixed edge, int glyph_pos, bool cursorOnCharacter)
 
int previousLogicalPosition (int oldPos) const
 
int nextLogicalPosition (int oldPos) const
 
int lineNumberForTextPosition (int pos)
 
int positionAfterVisualMovement (int oldPos, QTextCursor::MoveOperation op)
 
std::vector< int > insertionPointsForLine (int lineNum)
 
void resetFontEngineCache ()
 
void enableDelayDecorations (bool enable=true)
 
void addUnderline (QPainter *painter, const QLineF &line)
 
void addStrikeOut (QPainter *painter, const QLineF &line)
 
void addOverline (QPainter *painter, const QLineF &line)
 
void drawDecorations (QPainter *painter)
 
void clearDecorations ()
 
void adjustUnderlines ()
 

Static Public Member Functions

static void bidiReorder (int numRuns, const quint8 *levels, int *visualOrder)
 

Public Attributes

QScriptLineArray lines
 
QString text
 
QFont fnt
 
QRawFont rawFont
 
QTextBlock block
 
QTextOption option
 
QFixed minWidth
 
QFixed maxWidth
 
QPointF position
 
uint ignoreBidi: 1
 
uint cacheGlyphs: 1
 
uint stackEngine: 1
 
uint forceJustification: 1
 
uint visualMovement: 1
 
uint delayDecorations: 1
 
uint useRawFont: 1
 
LayoutData * layoutData
 
ItemDecorationList underlineList
 
ItemDecorationList strikeOutList
 
ItemDecorationList overlineList
 

Detailed Description

Definition at line 365 of file qtextengine_p.h.

Member Typedef Documentation

◆ ItemDecorationList

typedef QList<ItemDecoration> QTextEngine::ItemDecorationList

Definition at line 403 of file qtextengine_p.h.

Member Enumeration Documentation

◆ LayoutState

enum QTextEngine::LayoutState
Enumerator
LayoutEmpty 
InLayout 
LayoutFailed 

Definition at line 367 of file qtextengine_p.h.

◆ Mode

enum QTextEngine::Mode
Enumerator
WidthOnly 

Definition at line 409 of file qtextengine_p.h.

Constructor & Destructor Documentation

◆ QTextEngine() [1/2]

QTextEngine::QTextEngine ( )

Definition at line 1804 of file qtextengine.cpp.

◆ QTextEngine() [2/2]

QTextEngine::QTextEngine ( const QString & str,
const QFont & f )

Definition at line 1809 of file qtextengine.cpp.

◆ ~QTextEngine()

QTextEngine::~QTextEngine ( )

Definition at line 1816 of file qtextengine.cpp.

Member Function Documentation

◆ addOverline()

void QTextEngine::addOverline ( QPainter * painter,
const QLineF & line )

Definition at line 3803 of file qtextengine.cpp.

◆ addStrikeOut()

void QTextEngine::addStrikeOut ( QPainter * painter,
const QLineF & line )

Definition at line 3798 of file qtextengine.cpp.

◆ addUnderline()

void QTextEngine::addUnderline ( QPainter * painter,
const QLineF & line )

Definition at line 3792 of file qtextengine.cpp.

◆ adjustUnderlines()

void QTextEngine::adjustUnderlines ( )

Definition at line 3841 of file qtextengine.cpp.

◆ alignLine()

QFixed QTextEngine::alignLine ( const QScriptLine & line)

Definition at line 3534 of file qtextengine.cpp.

◆ attributes()

const QCharAttributes * QTextEngine::attributes ( ) const

Definition at line 1824 of file qtextengine.cpp.

◆ atWordSeparator()

bool QTextEngine::atWordSeparator ( int position) const

Definition at line 2983 of file qtextengine.cpp.

◆ availableGlyphs()

QGlyphLayout QTextEngine::availableGlyphs ( const QScriptItem * si) const
inline

Returns an array of QGlyphLayout items, offset at the script item. Each item in the array matches one glyph in the text, storing the advance, position etc. The returned item's length equals to the number of available glyphs. This may be more than what was actually shaped.

See also
logClusters()

Definition at line 469 of file qtextengine_p.h.

◆ bidiReorder()

void QTextEngine::bidiReorder ( int numRuns,
const quint8 * levels,
int * visualOrder )
static

Definition at line 1136 of file qtextengine.cpp.

◆ boundingBox()

glyph_metrics_t QTextEngine::boundingBox ( int from,
int len ) const

Definition at line 2326 of file qtextengine.cpp.

◆ calculateTabWidth()

QFixed QTextEngine::calculateTabWidth ( int index,
QFixed x ) const

returns the width of tab at index (in the tabs array) with the tab-start at position x

Definition at line 3338 of file qtextengine.cpp.

◆ clearDecorations()

void QTextEngine::clearDecorations ( )

Definition at line 3834 of file qtextengine.cpp.

◆ clearLineData()

void QTextEngine::clearLineData ( )

Definition at line 1905 of file qtextengine.cpp.

◆ docLayout()

QAbstractTextDocumentLayout * QTextEngine::docLayout ( ) const
inline

Definition at line 497 of file qtextengine_p.h.

◆ drawDecorations()

void QTextEngine::drawDecorations ( QPainter * painter)

Definition at line 3820 of file qtextengine.cpp.

◆ elidedText()

QString QTextEngine::elidedText ( Qt::TextElideMode mode,
QFixed width,
int flags = 0,
int from = 0,
int count = -1 ) const

Definition at line 3142 of file qtextengine.cpp.

◆ enableDelayDecorations()

void QTextEngine::enableDelayDecorations ( bool enable = true)
inline

Definition at line 603 of file qtextengine_p.h.

◆ ensureSpace()

bool QTextEngine::ensureSpace ( int nGlyphs) const
inline

Definition at line 482 of file qtextengine_p.h.

◆ findItem()

int QTextEngine::findItem ( int strPos,
int firstItem = 0 ) const

Definition at line 2235 of file qtextengine.cpp.

◆ font() [1/2]

QFont QTextEngine::font ( ) const
inline

Definition at line 450 of file qtextengine_p.h.

◆ font() [2/2]

QFont QTextEngine::font ( const QScriptItem & si) const

Definition at line 2371 of file qtextengine.cpp.

◆ fontEngine()

QFontEngine * QTextEngine::fontEngine ( const QScriptItem & si,
QFixed * ascent = nullptr,
QFixed * descent = nullptr,
QFixed * leading = nullptr ) const

Definition at line 2409 of file qtextengine.cpp.

◆ format()

QTextCharFormat QTextEngine::format ( const QScriptItem * si) const

Definition at line 2964 of file qtextengine.cpp.

◆ formatCollection()

QTextFormatCollection * QTextEngine::formatCollection ( ) const
inline

Definition at line 491 of file qtextengine_p.h.

◆ formatIndex()

int QTextEngine::formatIndex ( const QScriptItem * si) const

Definition at line 2941 of file qtextengine.cpp.

◆ formats()

QList< QTextLayout::FormatRange > QTextEngine::formats ( ) const
inline

Definition at line 564 of file qtextengine_p.h.

◆ freeMemory()

void QTextEngine::freeMemory ( )

Definition at line 2920 of file qtextengine.cpp.

◆ hasFormats()

bool QTextEngine::hasFormats ( ) const
inline

Definition at line 562 of file qtextengine_p.h.

◆ insertionPointsForLine()

std::vector< int > QTextEngine::insertionPointsForLine ( int lineNum)

Definition at line 3702 of file qtextengine.cpp.

◆ invalidate()

void QTextEngine::invalidate ( )

Definition at line 1896 of file qtextengine.cpp.

◆ isRightToLeft()

bool QTextEngine::isRightToLeft ( ) const

Definition at line 2216 of file qtextengine.cpp.

◆ itemize()

void QTextEngine::itemize ( ) const

Definition at line 1960 of file qtextengine.cpp.

◆ justify()

void QTextEngine::justify ( const QScriptLine & si)

Definition at line 2570 of file qtextengine.cpp.

◆ leadingSpaceWidth()

QFixed QTextEngine::leadingSpaceWidth ( const QScriptLine & line)

Definition at line 3524 of file qtextengine.cpp.

◆ length() [1/2]

int QTextEngine::length ( const QScriptItem * si) const
inline

Definition at line 439 of file qtextengine_p.h.

◆ length() [2/2]

int QTextEngine::length ( int item) const
inline

Definition at line 433 of file qtextengine_p.h.

◆ lineNumberForTextPosition()

int QTextEngine::lineNumberForTextPosition ( int pos)

Definition at line 3688 of file qtextengine.cpp.

◆ logClusters()

unsigned short * QTextEngine::logClusters ( const QScriptItem * si) const
inline

Returns a pointer to an array of log clusters, offset at the script item. Each item in the array is a unsigned short. For each character in the original string there is an entry in the table so there is a one to one correlation in indexes between the original text and the index in the logcluster. The value of each item is the position in the glyphs array. Multiple similar pointers in the logclusters array imply that one glyph is used for more than one character.

See also
glyphs()

Definition at line 460 of file qtextengine_p.h.

◆ nextLogicalPosition()

int QTextEngine::nextLogicalPosition ( int oldPos) const

Definition at line 3673 of file qtextengine.cpp.

◆ offsetInLigature()

QFixed QTextEngine::offsetInLigature ( const QScriptItem * si,
int pos,
int max,
int glyph_pos )

Definition at line 3551 of file qtextengine.cpp.

◆ positionAfterVisualMovement()

int QTextEngine::positionAfterVisualMovement ( int oldPos,
QTextCursor::MoveOperation op )

Definition at line 3744 of file qtextengine.cpp.

◆ positionInLigature()

int QTextEngine::positionInLigature ( const QScriptItem * si,
int end,
QFixed x,
QFixed edge,
int glyph_pos,
bool cursorOnCharacter )

Definition at line 3599 of file qtextengine.cpp.

◆ preeditAreaPosition()

int QTextEngine::preeditAreaPosition ( ) const
inline

Definition at line 558 of file qtextengine_p.h.

◆ preeditAreaText()

QString QTextEngine::preeditAreaText ( ) const
inline

Definition at line 559 of file qtextengine_p.h.

◆ previousLogicalPosition()

int QTextEngine::previousLogicalPosition ( int oldPos) const

Definition at line 3658 of file qtextengine.cpp.

◆ resetFontEngineCache()

void QTextEngine::resetFontEngineCache ( )

Definition at line 1889 of file qtextengine.cpp.

◆ setFormats()

void QTextEngine::setFormats ( const QList< QTextLayout::FormatRange > & formats)

Definition at line 3047 of file qtextengine.cpp.

◆ setPreeditArea()

void QTextEngine::setPreeditArea ( int position,
const QString & text )

Definition at line 3025 of file qtextengine.cpp.

◆ shape()

void QTextEngine::shape ( int item) const

Definition at line 1854 of file qtextengine.cpp.

◆ shapedGlyphs()

QGlyphLayout QTextEngine::shapedGlyphs ( const QScriptItem * si) const
inline

Returns an array of QGlyphLayout items, offset at the script item. Each item in the array matches one glyph in the text, storing the advance, position etc. The returned item's length equals to the number of shaped glyphs.

See also
logClusters()

Definition at line 478 of file qtextengine_p.h.

◆ shapeLine()

void QTextEngine::shapeLine ( const QScriptLine & line)

Definition at line 1289 of file qtextengine.cpp.

◆ tightBoundingBox()

glyph_metrics_t QTextEngine::tightBoundingBox ( int from,
int len ) const

Definition at line 2349 of file qtextengine.cpp.

◆ validate()

void QTextEngine::validate ( ) const

Definition at line 1910 of file qtextengine.cpp.

◆ visualCursorMovement()

bool QTextEngine::visualCursorMovement ( ) const
inline

Definition at line 555 of file qtextengine_p.h.

◆ width()

QFixed QTextEngine::width ( int charFrom,
int numChars ) const

Definition at line 2311 of file qtextengine.cpp.

Member Data Documentation

◆ block

QTextBlock QTextEngine::block

Definition at line 532 of file qtextengine_p.h.

◆ cacheGlyphs

uint QTextEngine::cacheGlyphs

Definition at line 540 of file qtextengine_p.h.

◆ delayDecorations

uint QTextEngine::delayDecorations

Definition at line 544 of file qtextengine_p.h.

◆ fnt

QFont QTextEngine::fnt
mutable

Definition at line 528 of file qtextengine_p.h.

◆ forceJustification

uint QTextEngine::forceJustification

Definition at line 542 of file qtextengine_p.h.

◆ ignoreBidi

uint QTextEngine::ignoreBidi

Definition at line 539 of file qtextengine_p.h.

◆ layoutData

LayoutData* QTextEngine::layoutData
mutable

Definition at line 549 of file qtextengine_p.h.

◆ lines

QScriptLineArray QTextEngine::lines
mutable

Definition at line 506 of file qtextengine_p.h.

◆ maxWidth

QFixed QTextEngine::maxWidth

Definition at line 537 of file qtextengine_p.h.

◆ minWidth

QFixed QTextEngine::minWidth

Definition at line 536 of file qtextengine_p.h.

◆ option

QTextOption QTextEngine::option

Definition at line 534 of file qtextengine_p.h.

◆ overlineList

ItemDecorationList QTextEngine::overlineList

Definition at line 553 of file qtextengine_p.h.

◆ position

QPointF QTextEngine::position

Definition at line 538 of file qtextengine_p.h.

◆ rawFont

QRawFont QTextEngine::rawFont

Definition at line 530 of file qtextengine_p.h.

◆ stackEngine

uint QTextEngine::stackEngine

Definition at line 541 of file qtextengine_p.h.

◆ strikeOutList

ItemDecorationList QTextEngine::strikeOutList

Definition at line 552 of file qtextengine_p.h.

◆ text

QString QTextEngine::text

Definition at line 527 of file qtextengine_p.h.

◆ underlineList

ItemDecorationList QTextEngine::underlineList

Definition at line 551 of file qtextengine_p.h.

◆ useRawFont

uint QTextEngine::useRawFont

Definition at line 546 of file qtextengine_p.h.

◆ visualMovement

uint QTextEngine::visualMovement

Definition at line 543 of file qtextengine_p.h.

The documentation for this class was generated from the following files: