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

API reference - Class QTextBlock

Notation used in Ruby API documentation

Description: Binding of QTextBlock

• Public constructors
• Public methods
• Detailed description

Public constructors

Public methods

Detailed description

[const] bool !=(const QTextBlock o)

Description: Method bool QTextBlock::operator!=(const QTextBlock &o)

[const] bool <(const QTextBlock o)

Description: Method bool QTextBlock::operator<(const QTextBlock &o)

[const] bool ==(const QTextBlock o)

Description: Method bool QTextBlock::operator==(const QTextBlock &o)

QTextBlock assign(const QTextBlock o)

Description: Method QTextBlock &QTextBlock::operator=(const QTextBlock &o)

[const] void assign(const QTextBlock other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

[const] QTextBlock_iterator begin

Description: Method QTextBlock::iterator QTextBlock::begin()

[const] QTextBlockFormat blockFormat

Description: Method QTextBlockFormat QTextBlock::blockFormat()

[const] int blockFormatIndex

Description: Method int QTextBlock::blockFormatIndex()

[const] int blockNumber

Description: Method int QTextBlock::blockNumber()

[const] QTextCharFormat charFormat

Description: Method QTextCharFormat QTextBlock::charFormat()

[const] int charFormatIndex

Description: Method int QTextBlock::charFormatIndex()

void clearLayout

Description: Method void QTextBlock::clearLayout()

[const] bool contains(int position)

Description: Method bool QTextBlock::contains(int position)

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.

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] const QTextDocument ptr document

Description: Method const QTextDocument *QTextBlock::document()

[const] QTextBlock dup

Description: Creates a copy of self

[const] QTextBlock_iterator end

Description: Method QTextBlock::iterator QTextBlock::end()

[const] int firstLineNumber

Description: Method int QTextBlock::firstLineNumber()

[const] int fragmentIndex

Description: Method int QTextBlock::fragmentIndex()

[const] bool isValid

Description: Method bool QTextBlock::isValid()

[const] bool isValid?

Description: Method bool QTextBlock::isValid()

[const] bool isVisible

Description: Method bool QTextBlock::isVisible()

[const] bool isVisible?

Description: Method bool QTextBlock::isVisible()

[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] QTextLayout ptr layout

Description: Method QTextLayout *QTextBlock::layout()

[const] int length

Description: Method int QTextBlock::length()

[const] int lineCount

Description: Method int QTextBlock::lineCount()

void lineCount=(int count)

Description: Method void QTextBlock::setLineCount(int count)

[static] new QTextBlock new

Description: Constructor QTextBlock::QTextBlock()

This method creates an object of class QTextBlock.

[static] new QTextBlock new(const QTextBlock o)

Description: Constructor QTextBlock::QTextBlock(const QTextBlock &o)

This method creates an object of class QTextBlock.

[const] QTextBlock next

Description: Method QTextBlock QTextBlock::next()

[const] int position

Description: Method int QTextBlock::position()

[const] QTextBlock previous

Description: Method QTextBlock QTextBlock::previous()

[const] int revision

Description: Method int QTextBlock::revision()

void revision=(int rev)

Description: Method void QTextBlock::setRevision(int rev)

void setLineCount(int count)

Description: Method void QTextBlock::setLineCount(int count)

void setRevision(int rev)

Description: Method void QTextBlock::setRevision(int rev)

void setUserData(QTextBlockUserData ptr data)

Description: Method void QTextBlock::setUserData(QTextBlockUserData *data)

void setUserState(int state)

Description: Method void QTextBlock::setUserState(int state)

void setVisible(bool visible)

Description: Method void QTextBlock::setVisible(bool visible)

[const] string text

Description: Method QString QTextBlock::text()

[const] QTextList ptr textList

Description: Method QTextList *QTextBlock::textList()

[const] QTextBlockUserData ptr userData

Description: Method QTextBlockUserData *QTextBlock::userData()

void userData=(QTextBlockUserData ptr data)

Description: Method void QTextBlock::setUserData(QTextBlockUserData *data)

[const] int userState

Description: Method int QTextBlock::userState()

void userState=(int state)

Description: Method void QTextBlock::setUserState(int state)

void visible=(bool visible)

Description: Method void QTextBlock::setVisible(bool visible)