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

API reference - Class QTextFormat

Notation used in Ruby API documentation

Description: Binding of QTextFormat

• Public constructors
• Public methods
• Public static methods and constants
• Detailed description

Public constructors

Public methods

Public static methods and constants

Detailed description

[const] bool !=(const QTextFormat rhs)

Description: Method bool QTextFormat::operator!=(const QTextFormat &rhs)

[const] bool ==(const QTextFormat rhs)

Description: Method bool QTextFormat::operator==(const QTextFormat &rhs)

[static] QTextFormat_PageBreakFlag PageBreak_AlwaysAfter

Description: Enum constant QTextFormat::PageBreak_AlwaysAfter

[static] QTextFormat_PageBreakFlag PageBreak_AlwaysBefore

Description: Enum constant QTextFormat::PageBreak_AlwaysBefore

[static] QTextFormat_PageBreakFlag PageBreak_Auto

Description: Enum constant QTextFormat::PageBreak_Auto

QTextFormat assign(const QTextFormat rhs)

Description: Method QTextFormat &QTextFormat::operator=(const QTextFormat &rhs)

[const] void assign(const QTextFormat 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] QBrush background

Description: Method QBrush QTextFormat::background()

void background=(const QBrush brush)

Description: Method void QTextFormat::setBackground(const QBrush &brush)

[const] bool boolProperty(int propertyId)

Description: Method bool QTextFormat::boolProperty(int propertyId)

[const] QBrush brushProperty(int propertyId)

Description: Method QBrush QTextFormat::brushProperty(int propertyId)

void clearBackground

Description: Method void QTextFormat::clearBackground()

void clearForeground

Description: Method void QTextFormat::clearForeground()

void clearProperty(int propertyId)

Description: Method void QTextFormat::clearProperty(int propertyId)

[const] QColor colorProperty(int propertyId)

Description: Method QColor QTextFormat::colorProperty(int propertyId)

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] double doubleProperty(int propertyId)

Description: Method double QTextFormat::doubleProperty(int propertyId)

[const] QTextFormat dup

Description: Creates a copy of self

[const] QBrush foreground

Description: Method QBrush QTextFormat::foreground()

void foreground=(const QBrush brush)

Description: Method void QTextFormat::setForeground(const QBrush &brush)

[const] bool hasProperty(int propertyId)

Description: Method bool QTextFormat::hasProperty(int propertyId)

[const] int intProperty(int propertyId)

Description: Method int QTextFormat::intProperty(int propertyId)

[const] bool isBlockFormat

Description: Method bool QTextFormat::isBlockFormat()

[const] bool isBlockFormat?

Description: Method bool QTextFormat::isBlockFormat()

[const] bool isCharFormat

Description: Method bool QTextFormat::isCharFormat()

[const] bool isCharFormat?

Description: Method bool QTextFormat::isCharFormat()

[const] bool isFrameFormat

Description: Method bool QTextFormat::isFrameFormat()

[const] bool isFrameFormat?

Description: Method bool QTextFormat::isFrameFormat()

[const] bool isImageFormat

Description: Method bool QTextFormat::isImageFormat()

[const] bool isImageFormat?

Description: Method bool QTextFormat::isImageFormat()

[const] bool isListFormat

Description: Method bool QTextFormat::isListFormat()

[const] bool isListFormat?

Description: Method bool QTextFormat::isListFormat()

[const] bool isTableCellFormat

Description: Method bool QTextFormat::isTableCellFormat()

[const] bool isTableCellFormat?

Description: Method bool QTextFormat::isTableCellFormat()

[const] bool isTableFormat

Description: Method bool QTextFormat::isTableFormat()

[const] bool isTableFormat?

Description: Method bool QTextFormat::isTableFormat()

[const] bool isValid

Description: Method bool QTextFormat::isValid()

[const] bool isValid?

Description: Method bool QTextFormat::isValid()

[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] Qt_LayoutDirection layoutDirection

Description: Method Qt::LayoutDirection QTextFormat::layoutDirection()

void layoutDirection=(const Qt_LayoutDirection direction)

Description: Method void QTextFormat::setLayoutDirection(Qt::LayoutDirection direction)

[const] QTextLength lengthProperty(int propertyId)

Description: Method QTextLength QTextFormat::lengthProperty(int propertyId)

[const] QTextLength[] lengthVectorProperty(int propertyId)

Description: Method QVector<QTextLength> QTextFormat::lengthVectorProperty(int propertyId)

void merge(const QTextFormat other)

Description: Method void QTextFormat::merge(const QTextFormat &other)

[static] new QTextFormat new

Description: Constructor QTextFormat::QTextFormat()

This method creates an object of class QTextFormat.

[static] new QTextFormat new(int type)

Description: Constructor QTextFormat::QTextFormat(int type)

This method creates an object of class QTextFormat.

[static] new QTextFormat new(const QTextFormat rhs)

Description: Constructor QTextFormat::QTextFormat(const QTextFormat &rhs)

This method creates an object of class QTextFormat.

[const] int objectIndex

Description: Method int QTextFormat::objectIndex()

void objectIndex=(int object)

Description: Method void QTextFormat::setObjectIndex(int object)

[const] int objectType

Description: Method int QTextFormat::objectType()

void objectType=(int type)

Description: Method void QTextFormat::setObjectType(int type)

[const] QPen penProperty(int propertyId)

Description: Method QPen QTextFormat::penProperty(int propertyId)

[const] QVariant property(int propertyId)

Description: Method QVariant QTextFormat::property(int propertyId)

[const] int propertyCount

Description: Method int QTextFormat::propertyCount()

void setBackground(const QBrush brush)

Description: Method void QTextFormat::setBackground(const QBrush &brush)

void setForeground(const QBrush brush)

Description: Method void QTextFormat::setForeground(const QBrush &brush)

void setLayoutDirection(const Qt_LayoutDirection direction)

Description: Method void QTextFormat::setLayoutDirection(Qt::LayoutDirection direction)

void setObjectIndex(int object)

Description: Method void QTextFormat::setObjectIndex(int object)

void setObjectType(int type)

Description: Method void QTextFormat::setObjectType(int type)

void setProperty(int propertyId,const QVariant value)

Description: Method void QTextFormat::setProperty(int propertyId, const QVariant &value)

void setProperty(int propertyId,QTextLength[] lengths)

Description: Method void QTextFormat::setProperty(int propertyId, const QVector<QTextLength> &lengths)

[const] string stringProperty(int propertyId)

Description: Method QString QTextFormat::stringProperty(int propertyId)

[const] QTextBlockFormat toBlockFormat

Description: Method QTextBlockFormat QTextFormat::toBlockFormat()

[const] QTextCharFormat toCharFormat

Description: Method QTextCharFormat QTextFormat::toCharFormat()

[const] QTextFrameFormat toFrameFormat

Description: Method QTextFrameFormat QTextFormat::toFrameFormat()

[const] QTextImageFormat toImageFormat

Description: Method QTextImageFormat QTextFormat::toImageFormat()

[const] QTextListFormat toListFormat

Description: Method QTextListFormat QTextFormat::toListFormat()

[const] QTextTableCellFormat toTableCellFormat

Description: Method QTextTableCellFormat QTextFormat::toTableCellFormat()

[const] QTextTableFormat toTableFormat

Description: Method QTextTableFormat QTextFormat::toTableFormat()

[const] int type

Description: Method int QTextFormat::type()