KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QTextListFormat

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QTextListFormat

Class hierarchy: QTextListFormat » QTextFormat

Sub-classes: Style, QFlags_Style

Public constructors

new QTextListFormatnewConstructor QTextListFormat::QTextListFormat()

Public methods

void_assign(const QTextListFormat other)Assigns another object to self
[const]QTextListFormat ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]new QTextListFormat ptr_dupCreates a copy of self
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]intindentMethod int QTextListFormat::indent()
voidindent=(int indent)Method void QTextListFormat::setIndent(int indent)
[const]boolisValid?Method bool QTextListFormat::isValid()
[const]stringnumberPrefixMethod QString QTextListFormat::numberPrefix()
voidnumberPrefix=(string numberPrefix)Method void QTextListFormat::setNumberPrefix(const QString &numberPrefix)
[const]stringnumberSuffixMethod QString QTextListFormat::numberSuffix()
voidnumberSuffix=(string numberSuffix)Method void QTextListFormat::setNumberSuffix(const QString &numberSuffix)
voidsetIndent(int indent)Method void QTextListFormat::setIndent(int indent)
voidsetNumberPrefix(string numberPrefix)Method void QTextListFormat::setNumberPrefix(const QString &numberPrefix)
voidsetNumberSuffix(string numberSuffix)Method void QTextListFormat::setNumberSuffix(const QString &numberSuffix)
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

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

Detailed description

ListCircle

Signature: [static,const] QTextListFormat_Style ListCircle

Description: Enum constant QTextListFormat::ListCircle

Python specific notes:
The object exposes a readable attribute 'ListCircle'. This is the getter.

ListDecimal

Signature: [static,const] QTextListFormat_Style ListDecimal

Description: Enum constant QTextListFormat::ListDecimal

Python specific notes:
The object exposes a readable attribute 'ListDecimal'. This is the getter.

ListDisc

Signature: [static,const] QTextListFormat_Style ListDisc

Description: Enum constant QTextListFormat::ListDisc

Python specific notes:
The object exposes a readable attribute 'ListDisc'. This is the getter.

ListLowerAlpha

Signature: [static,const] QTextListFormat_Style ListLowerAlpha

Description: Enum constant QTextListFormat::ListLowerAlpha

Python specific notes:
The object exposes a readable attribute 'ListLowerAlpha'. This is the getter.

ListLowerRoman

Signature: [static,const] QTextListFormat_Style ListLowerRoman

Description: Enum constant QTextListFormat::ListLowerRoman

Python specific notes:
The object exposes a readable attribute 'ListLowerRoman'. This is the getter.

ListSquare

Signature: [static,const] QTextListFormat_Style ListSquare

Description: Enum constant QTextListFormat::ListSquare

Python specific notes:
The object exposes a readable attribute 'ListSquare'. This is the getter.

ListStyleUndefined

Signature: [static,const] QTextListFormat_Style ListStyleUndefined

Description: Enum constant QTextListFormat::ListStyleUndefined

Python specific notes:
The object exposes a readable attribute 'ListStyleUndefined'. This is the getter.

ListUpperAlpha

Signature: [static,const] QTextListFormat_Style ListUpperAlpha

Description: Enum constant QTextListFormat::ListUpperAlpha

Python specific notes:
The object exposes a readable attribute 'ListUpperAlpha'. This is the getter.

ListUpperRoman

Signature: [static,const] QTextListFormat_Style ListUpperRoman

Description: Enum constant QTextListFormat::ListUpperRoman

Python specific notes:
The object exposes a readable attribute 'ListUpperRoman'. This is the getter.

_assign

Signature: void _assign (const QTextListFormat other)

Description: Assigns another object to self

_const_cast

Signature: [const] QTextListFormat ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: 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.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

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

_destroyed?

Signature: [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.

_dup

Signature: [const] new QTextListFormat ptr _dup

Description: Creates a copy of self

_is_const_object?

Signature: [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.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

indent

Signature: [const] int indent

Description: Method int QTextListFormat::indent()

Python specific notes:
The object exposes a readable attribute 'indent'. This is the getter.

indent=

Signature: void indent= (int indent)

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

Python specific notes:
The object exposes a writable attribute 'indent'. This is the setter.

isValid?

Signature: [const] bool isValid?

Description: Method bool QTextListFormat::isValid()

new

Signature: [static] new QTextListFormat new

Description: Constructor QTextListFormat::QTextListFormat()

This method creates an object of class QTextListFormat.

Python specific notes:
This method is the default initializer of the object.

numberPrefix

Signature: [const] string numberPrefix

Description: Method QString QTextListFormat::numberPrefix()

Python specific notes:
The object exposes a readable attribute 'numberPrefix'. This is the getter.

numberPrefix=

Signature: void numberPrefix= (string numberPrefix)

Description: Method void QTextListFormat::setNumberPrefix(const QString &numberPrefix)

Python specific notes:
The object exposes a writable attribute 'numberPrefix'. This is the setter.

numberSuffix

Signature: [const] string numberSuffix

Description: Method QString QTextListFormat::numberSuffix()

Python specific notes:
The object exposes a readable attribute 'numberSuffix'. This is the getter.

numberSuffix=

Signature: void numberSuffix= (string numberSuffix)

Description: Method void QTextListFormat::setNumberSuffix(const QString &numberSuffix)

Python specific notes:
The object exposes a writable attribute 'numberSuffix'. This is the setter.

setIndent

Signature: void setIndent (int indent)

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

Python specific notes:
The object exposes a writable attribute 'indent'. This is the setter.

setNumberPrefix

Signature: void setNumberPrefix (string numberPrefix)

Description: Method void QTextListFormat::setNumberPrefix(const QString &numberPrefix)

Python specific notes:
The object exposes a writable attribute 'numberPrefix'. This is the setter.

setNumberSuffix

Signature: void setNumberSuffix (string numberSuffix)

Description: Method void QTextListFormat::setNumberSuffix(const QString &numberSuffix)

Python specific notes:
The object exposes a writable attribute 'numberSuffix'. This is the setter.

setStyle

Signature: void setStyle (const QTextListFormat_Style style)

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

Python specific notes:
The object exposes a writable attribute 'style'. This is the setter.

style

Signature: [const] QTextListFormat_Style style

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

Python specific notes:
The object exposes a readable attribute 'style'. This is the getter.

style=

Signature: void style= (const QTextListFormat_Style style)

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

Python specific notes:
The object exposes a writable attribute 'style'. This is the setter.