KLayout Manual: Main Index » Class Index » API reference - Class QTextLayout

API reference - Class QTextLayout

Notation used in Ruby API documentation

Description: Binding of QTextLayout

Public constructors

new QTextLayoutnewConstructor QTextLayout::QTextLayout()
new QTextLayoutnew(string text)Constructor QTextLayout::QTextLayout(const QString &text)
new QTextLayoutnew(const QTextBlock b)Constructor QTextLayout::QTextLayout(const QTextBlock &b)
new QTextLayoutnew(string text,
const QFont font)
Constructor QTextLayout::QTextLayout(const QString &text, const QFont &font, QPaintDevice *paintdevice)
new QTextLayoutnew(string text,
const QFont font,
QPaintDevice ptr paintdevice)
Constructor QTextLayout::QTextLayout(const QString &text, const QFont &font, QPaintDevice *paintdevice)

Public methods

[const]QTextLayout_FormatRange[]additionalFormatsMethod QList<struct QTextLayout::FormatRange> QTextLayout::additionalFormats()
voidadditionalFormats=(QTextLayout_FormatRange[] overrides)Method void QTextLayout::setAdditionalFormats(const QList<struct QTextLayout::FormatRange> &overrides)
voidbeginLayoutMethod void QTextLayout::beginLayout()
[const]QRectFboundingRectMethod QRectF QTextLayout::boundingRect()
[const]boolcacheEnabledMethod bool QTextLayout::cacheEnabled()
voidcacheEnabled=(bool enable)Method void QTextLayout::setCacheEnabled(bool enable)
voidclearAdditionalFormatsMethod void QTextLayout::clearAdditionalFormats()
voidclearLayoutMethod void QTextLayout::clearLayout()
voidcreateEnsures the C++ object is created
QTextLinecreateLineMethod QTextLine QTextLayout::createLine()
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]voiddraw(QPainter ptr p,
const QPointF pos)
Method void QTextLayout::draw(QPainter *p, const QPointF &pos, const QVector<struct QTextLayout::FormatRange> &selections, const QRectF &clip)
[const]voiddraw(QPainter ptr p,
const QPointF pos,
QTextLayout_FormatRange[] selections)
Method void QTextLayout::draw(QPainter *p, const QPointF &pos, const QVector<struct QTextLayout::FormatRange> &selections, const QRectF &clip)
[const]voiddraw(QPainter ptr p,
const QPointF pos,
QTextLayout_FormatRange[] selections,
const QRectF clip)
Method void QTextLayout::draw(QPainter *p, const QPointF &pos, const QVector<struct QTextLayout::FormatRange> &selections, const QRectF &clip)
[const]voiddrawCursor(QPainter ptr p,
const QPointF pos,
int cursorPosition)
Method void QTextLayout::drawCursor(QPainter *p, const QPointF &pos, int cursorPosition)
[const]voiddrawCursor(QPainter ptr p,
const QPointF pos,
int cursorPosition,
int width)
Method void QTextLayout::drawCursor(QPainter *p, const QPointF &pos, int cursorPosition, int width)
voidendLayoutMethod void QTextLayout::endLayout()
[const]QFontfontMethod QFont QTextLayout::font()
voidfont=(const QFont f)Method void QTextLayout::setFont(const QFont &f)
[const]boolisValidCursorPosition(int pos)Method bool QTextLayout::isValidCursorPosition(int pos)
[const]boolisValidCursorPosition?(int pos)Method bool QTextLayout::isValidCursorPosition(int pos)
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]QTextLinelineAt(int i)Method QTextLine QTextLayout::lineAt(int i)
[const]intlineCountMethod int QTextLayout::lineCount()
[const]QTextLinelineForTextPosition(int pos)Method QTextLine QTextLayout::lineForTextPosition(int pos)
[const]doublemaximumWidthMethod double QTextLayout::maximumWidth()
[const]doubleminimumWidthMethod double QTextLayout::minimumWidth()
[const]intnextCursorPosition(int oldPos)Method int QTextLayout::nextCursorPosition(int oldPos, QTextLayout::CursorMode mode)
[const]intnextCursorPosition(int oldPos,
const QTextLayout_CursorMode mode)
Method int QTextLayout::nextCursorPosition(int oldPos, QTextLayout::CursorMode mode)
[const]QPointFpositionMethod QPointF QTextLayout::position()
voidposition=(const QPointF p)Method void QTextLayout::setPosition(const QPointF &p)
[const]intpreeditAreaPositionMethod int QTextLayout::preeditAreaPosition()
[const]stringpreeditAreaTextMethod QString QTextLayout::preeditAreaText()
[const]intpreviousCursorPosition(int oldPos)Method int QTextLayout::previousCursorPosition(int oldPos, QTextLayout::CursorMode mode)
[const]intpreviousCursorPosition(int oldPos,
const QTextLayout_CursorMode mode)
Method int QTextLayout::previousCursorPosition(int oldPos, QTextLayout::CursorMode mode)
voidsetAdditionalFormats(QTextLayout_FormatRange[] overrides)Method void QTextLayout::setAdditionalFormats(const QList<struct QTextLayout::FormatRange> &overrides)
voidsetCacheEnabled(bool enable)Method void QTextLayout::setCacheEnabled(bool enable)
voidsetFlags(int flags)Method void QTextLayout::setFlags(int flags)
voidsetFont(const QFont f)Method void QTextLayout::setFont(const QFont &f)
voidsetPosition(const QPointF p)Method void QTextLayout::setPosition(const QPointF &p)
voidsetPreeditArea(int position,
string text)
Method void QTextLayout::setPreeditArea(int position, const QString &text)
voidsetText(string string)Method void QTextLayout::setText(const QString &string)
voidsetTextOption(const QTextOption option)Method void QTextLayout::setTextOption(const QTextOption &option)
[const]stringtextMethod QString QTextLayout::text()
voidtext=(string string)Method void QTextLayout::setText(const QString &string)
[const]QTextOptiontextOptionMethod QTextOption QTextLayout::textOption()
voidtextOption=(const QTextOption option)Method void QTextLayout::setTextOption(const QTextOption &option)

Public static methods and constants

QTextLayout_CursorModeSkipCharactersEnum constant enum QTextLayout::SkipCharacters
QTextLayout_CursorModeSkipWordsEnum constant enum QTextLayout::SkipWords

Detailed description

[static] QTextLayout_CursorMode SkipCharacters

Description: Enum constant enum QTextLayout::SkipCharacters

[static] QTextLayout_CursorMode SkipWords

Description: Enum constant enum QTextLayout::SkipWords

[const] QTextLayout_FormatRange[] additionalFormats

Description: Method QList<struct QTextLayout::FormatRange> QTextLayout::additionalFormats()

void additionalFormats=(QTextLayout_FormatRange[] overrides)

Description: Method void QTextLayout::setAdditionalFormats(const QList<struct QTextLayout::FormatRange> &overrides)

void beginLayout

Description: Method void QTextLayout::beginLayout()

[const] QRectF boundingRect

Description: Method QRectF QTextLayout::boundingRect()

[const] bool cacheEnabled

Description: Method bool QTextLayout::cacheEnabled()

void cacheEnabled=(bool enable)

Description: Method void QTextLayout::setCacheEnabled(bool enable)

void clearAdditionalFormats

Description: Method void QTextLayout::clearAdditionalFormats()

void clearLayout

Description: Method void QTextLayout::clearLayout()

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

QTextLine createLine

Description: Method QTextLine QTextLayout::createLine()

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] void draw(QPainter ptr p,const QPointF pos)

Description: Method void QTextLayout::draw(QPainter *p, const QPointF &pos, const QVector<struct QTextLayout::FormatRange> &selections, const QRectF &clip)

[const] void draw(QPainter ptr p,const QPointF pos,QTextLayout_FormatRange[] selections)

Description: Method void QTextLayout::draw(QPainter *p, const QPointF &pos, const QVector<struct QTextLayout::FormatRange> &selections, const QRectF &clip)

[const] void draw(QPainter ptr p,const QPointF pos,QTextLayout_FormatRange[] selections,const QRectF clip)

Description: Method void QTextLayout::draw(QPainter *p, const QPointF &pos, const QVector<struct QTextLayout::FormatRange> &selections, const QRectF &clip)

[const] void drawCursor(QPainter ptr p,const QPointF pos,int cursorPosition)

Description: Method void QTextLayout::drawCursor(QPainter *p, const QPointF &pos, int cursorPosition)

[const] void drawCursor(QPainter ptr p,const QPointF pos,int cursorPosition,int width)

Description: Method void QTextLayout::drawCursor(QPainter *p, const QPointF &pos, int cursorPosition, int width)

void endLayout

Description: Method void QTextLayout::endLayout()

[const] QFont font

Description: Method QFont QTextLayout::font()

void font=(const QFont f)

Description: Method void QTextLayout::setFont(const QFont &f)

[const] bool isValidCursorPosition(int pos)

Description: Method bool QTextLayout::isValidCursorPosition(int pos)

[const] bool isValidCursorPosition?(int pos)

Description: Method bool QTextLayout::isValidCursorPosition(int pos)

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[const] QTextLine lineAt(int i)

Description: Method QTextLine QTextLayout::lineAt(int i)

[const] int lineCount

Description: Method int QTextLayout::lineCount()

[const] QTextLine lineForTextPosition(int pos)

Description: Method QTextLine QTextLayout::lineForTextPosition(int pos)

[const] double maximumWidth

Description: Method double QTextLayout::maximumWidth()

[const] double minimumWidth

Description: Method double QTextLayout::minimumWidth()

[static] new QTextLayout new

Description: Constructor QTextLayout::QTextLayout()

This method creates an object of class QTextLayout.

[static] new QTextLayout new(string text)

Description: Constructor QTextLayout::QTextLayout(const QString &text)

This method creates an object of class QTextLayout.

[static] new QTextLayout new(const QTextBlock b)

Description: Constructor QTextLayout::QTextLayout(const QTextBlock &b)

This method creates an object of class QTextLayout.

[static] new QTextLayout new(string text,const QFont font)

Description: Constructor QTextLayout::QTextLayout(const QString &text, const QFont &font, QPaintDevice *paintdevice)

This method creates an object of class QTextLayout.

[static] new QTextLayout new(string text,const QFont font,QPaintDevice ptr paintdevice)

Description: Constructor QTextLayout::QTextLayout(const QString &text, const QFont &font, QPaintDevice *paintdevice)

This method creates an object of class QTextLayout.

[const] int nextCursorPosition(int oldPos)

Description: Method int QTextLayout::nextCursorPosition(int oldPos, QTextLayout::CursorMode mode)

[const] int nextCursorPosition(int oldPos,const QTextLayout_CursorMode mode)

Description: Method int QTextLayout::nextCursorPosition(int oldPos, QTextLayout::CursorMode mode)

[const] QPointF position

Description: Method QPointF QTextLayout::position()

void position=(const QPointF p)

Description: Method void QTextLayout::setPosition(const QPointF &p)

[const] int preeditAreaPosition

Description: Method int QTextLayout::preeditAreaPosition()

[const] string preeditAreaText

Description: Method QString QTextLayout::preeditAreaText()

[const] int previousCursorPosition(int oldPos)

Description: Method int QTextLayout::previousCursorPosition(int oldPos, QTextLayout::CursorMode mode)

[const] int previousCursorPosition(int oldPos,const QTextLayout_CursorMode mode)

Description: Method int QTextLayout::previousCursorPosition(int oldPos, QTextLayout::CursorMode mode)

void setAdditionalFormats(QTextLayout_FormatRange[] overrides)

Description: Method void QTextLayout::setAdditionalFormats(const QList<struct QTextLayout::FormatRange> &overrides)

void setCacheEnabled(bool enable)

Description: Method void QTextLayout::setCacheEnabled(bool enable)

void setFlags(int flags)

Description: Method void QTextLayout::setFlags(int flags)

void setFont(const QFont f)

Description: Method void QTextLayout::setFont(const QFont &f)

void setPosition(const QPointF p)

Description: Method void QTextLayout::setPosition(const QPointF &p)

void setPreeditArea(int position,string text)

Description: Method void QTextLayout::setPreeditArea(int position, const QString &text)

void setText(string string)

Description: Method void QTextLayout::setText(const QString &string)

void setTextOption(const QTextOption option)

Description: Method void QTextLayout::setTextOption(const QTextOption &option)

[const] string text

Description: Method QString QTextLayout::text()

void text=(string string)

Description: Method void QTextLayout::setText(const QString &string)

[const] QTextOption textOption

Description: Method QTextOption QTextLayout::textOption()

void textOption=(const QTextOption option)

Description: Method void QTextLayout::setTextOption(const QTextOption &option)