API reference - Class QTextListFormat

Notation used in Ruby API documentation

Description: Binding of QTextListFormat

Class hierarchy: QTextListFormat » QTextFormat

Public constructors

new QTextListFormatnewConstructor QTextListFormat::QTextListFormat()

Public methods

[const]voidassign(const QTextListFormat other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QTextListFormatdupCreates a copy of self
[const]intindentMethod int QTextListFormat::indent()
voidindent=(int indent)Method void QTextListFormat::setIndent(int indent)
[const]boolisValidMethod bool QTextListFormat::isValid()
[const]boolisValid?Method bool QTextListFormat::isValid()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
voidsetIndent(int indent)Method void QTextListFormat::setIndent(int indent)
voidsetStyle(const QTextListFormat_Style style)Method void QTextListFormat::setStyle(QTextListFormat::Style style)
[const]QTextListFormat_StylestyleMethod QTextListFormat::Style QTextListFormat::style()
voidstyle=(const QTextListFormat_Style style)Method void QTextListFormat::setStyle(QTextListFormat::Style style)

Public static methods and constants

QTextListFormat_StyleListCircleEnum constant QTextListFormat::ListCircle
QTextListFormat_StyleListDecimalEnum constant QTextListFormat::ListDecimal
QTextListFormat_StyleListDiscEnum constant QTextListFormat::ListDisc
QTextListFormat_StyleListLowerAlphaEnum constant QTextListFormat::ListLowerAlpha
QTextListFormat_StyleListLowerRomanEnum constant QTextListFormat::ListLowerRoman
QTextListFormat_StyleListSquareEnum constant QTextListFormat::ListSquare
QTextListFormat_StyleListStyleUndefinedEnum constant QTextListFormat::ListStyleUndefined
QTextListFormat_StyleListUpperAlphaEnum constant QTextListFormat::ListUpperAlpha
QTextListFormat_StyleListUpperRomanEnum constant QTextListFormat::ListUpperRoman

Detailed description

[static] QTextListFormat_Style ListCircle

Description: Enum constant QTextListFormat::ListCircle

[static] QTextListFormat_Style ListDecimal

Description: Enum constant QTextListFormat::ListDecimal

[static] QTextListFormat_Style ListDisc

Description: Enum constant QTextListFormat::ListDisc

[static] QTextListFormat_Style ListLowerAlpha

Description: Enum constant QTextListFormat::ListLowerAlpha

[static] QTextListFormat_Style ListLowerRoman

Description: Enum constant QTextListFormat::ListLowerRoman

[static] QTextListFormat_Style ListSquare

Description: Enum constant QTextListFormat::ListSquare

[static] QTextListFormat_Style ListStyleUndefined

Description: Enum constant QTextListFormat::ListStyleUndefined

[static] QTextListFormat_Style ListUpperAlpha

Description: Enum constant QTextListFormat::ListUpperAlpha

[static] QTextListFormat_Style ListUpperRoman

Description: Enum constant QTextListFormat::ListUpperRoman

[const] void assign(const QTextListFormat 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.

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] QTextListFormat dup

Description: Creates a copy of self

[const] int indent

Description: Method int QTextListFormat::indent()

void indent=(int indent)

Description: Method void QTextListFormat::setIndent(int indent)

[const] bool isValid

Description: Method bool QTextListFormat::isValid()

[const] bool isValid?

Description: Method bool QTextListFormat::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.

[static] new QTextListFormat new

Description: Constructor QTextListFormat::QTextListFormat()

This method creates an object of class QTextListFormat.

void setIndent(int indent)

Description: Method void QTextListFormat::setIndent(int indent)

void setStyle(const QTextListFormat_Style style)

Description: Method void QTextListFormat::setStyle(QTextListFormat::Style style)

[const] QTextListFormat_Style style

Description: Method QTextListFormat::Style QTextListFormat::style()

void style=(const QTextListFormat_Style style)

Description: Method void QTextListFormat::setStyle(QTextListFormat::Style style)