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

API reference - Class QStaticText

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QStaticText

Sub-classes: PerformanceHint, QFlags_PerformanceHint

Public constructors

new QStaticTextnewConstructor QStaticText::QStaticText()
new QStaticTextnew(string text)Constructor QStaticText::QStaticText(const QString &text)
new QStaticTextnew(const QStaticText other)Constructor QStaticText::QStaticText(const QStaticText &other)

Public methods

[const]bool!=(const QStaticText arg1)Method bool QStaticText::operator!=(const QStaticText &)
[const]bool==(const QStaticText arg1)Method bool QStaticText::operator==(const QStaticText &)
void_assign(const QStaticText other)Assigns another object to self
[const]QStaticText 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]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.
QStaticTextassign(const QStaticText arg1)Method QStaticText &QStaticText::operator=(const QStaticText &)
[const]new QStaticText ptrdupCreates a copy of self
[const]QStaticText_PerformanceHintperformanceHintMethod QStaticText::PerformanceHint QStaticText::performanceHint()
voidperformanceHint=(const QStaticText_PerformanceHint performanceHint)Method void QStaticText::setPerformanceHint(QStaticText::PerformanceHint performanceHint)
voidprepare(const QTransform matrix = QTransform(),
const QFont font = QFont())
Method void QStaticText::prepare(const QTransform &matrix, const QFont &font)
voidsetPerformanceHint(const QStaticText_PerformanceHint performanceHint)Method void QStaticText::setPerformanceHint(QStaticText::PerformanceHint performanceHint)
voidsetText(string text)Method void QStaticText::setText(const QString &text)
voidsetTextFormat(const Qt_TextFormat textFormat)Method void QStaticText::setTextFormat(Qt::TextFormat textFormat)
voidsetTextOption(const QTextOption textOption)Method void QStaticText::setTextOption(const QTextOption &textOption)
voidsetTextWidth(double textWidth)Method void QStaticText::setTextWidth(double textWidth)
[const]QSizeFsizeMethod QSizeF QStaticText::size()
voidswap(QStaticText other)Method void QStaticText::swap(QStaticText &other)
[const]stringtextMethod QString QStaticText::text()
voidtext=(string text)Method void QStaticText::setText(const QString &text)
[const]Qt_TextFormattextFormatMethod Qt::TextFormat QStaticText::textFormat()
voidtextFormat=(const Qt_TextFormat textFormat)Method void QStaticText::setTextFormat(Qt::TextFormat textFormat)
[const]QTextOptiontextOptionMethod QTextOption QStaticText::textOption()
voidtextOption=(const QTextOption textOption)Method void QStaticText::setTextOption(const QTextOption &textOption)
[const]doubletextWidthMethod double QStaticText::textWidth()
voidtextWidth=(double textWidth)Method void QStaticText::setTextWidth(double textWidth)

Public static methods and constants

[static,const]QStaticText_PerformanceHintAggressiveCachingEnum constant QStaticText::AggressiveCaching
[static,const]QStaticText_PerformanceHintModerateCachingEnum constant QStaticText::ModerateCaching

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QStaticText arg1)

Description: Method bool QStaticText::operator!=(const QStaticText &)

==

Signature: [const] bool == (const QStaticText arg1)

Description: Method bool QStaticText::operator==(const QStaticText &)

AggressiveCaching

Signature: [static,const] QStaticText_PerformanceHint AggressiveCaching

Description: Enum constant QStaticText::AggressiveCaching

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

ModerateCaching

Signature: [static,const] QStaticText_PerformanceHint ModerateCaching

Description: Enum constant QStaticText::ModerateCaching

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

_assign

Signature: void _assign (const QStaticText other)

Description: Assigns another object to self

_const_cast

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

_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.

assign

Signature: QStaticText assign (const QStaticText arg1)

Description: Method QStaticText &QStaticText::operator=(const QStaticText &)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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 QStaticText ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

new

(1) Signature: [static] new QStaticText new

Description: Constructor QStaticText::QStaticText()

This method creates an object of class QStaticText.

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

(2) Signature: [static] new QStaticText new (string text)

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

This method creates an object of class QStaticText.

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

(3) Signature: [static] new QStaticText new (const QStaticText other)

Description: Constructor QStaticText::QStaticText(const QStaticText &other)

This method creates an object of class QStaticText.

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

performanceHint

Signature: [const] QStaticText_PerformanceHint performanceHint

Description: Method QStaticText::PerformanceHint QStaticText::performanceHint()

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

performanceHint=

Signature: void performanceHint= (const QStaticText_PerformanceHint performanceHint)

Description: Method void QStaticText::setPerformanceHint(QStaticText::PerformanceHint performanceHint)

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

prepare

Signature: void prepare (const QTransform matrix = QTransform(), const QFont font = QFont())

Description: Method void QStaticText::prepare(const QTransform &matrix, const QFont &font)

setPerformanceHint

Signature: void setPerformanceHint (const QStaticText_PerformanceHint performanceHint)

Description: Method void QStaticText::setPerformanceHint(QStaticText::PerformanceHint performanceHint)

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

setText

Signature: void setText (string text)

Description: Method void QStaticText::setText(const QString &text)

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

setTextFormat

Signature: void setTextFormat (const Qt_TextFormat textFormat)

Description: Method void QStaticText::setTextFormat(Qt::TextFormat textFormat)

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

setTextOption

Signature: void setTextOption (const QTextOption textOption)

Description: Method void QStaticText::setTextOption(const QTextOption &textOption)

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

setTextWidth

Signature: void setTextWidth (double textWidth)

Description: Method void QStaticText::setTextWidth(double textWidth)

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

size

Signature: [const] QSizeF size

Description: Method QSizeF QStaticText::size()

Python specific notes:
This method is also available as 'len(object)'.

swap

Signature: void swap (QStaticText other)

Description: Method void QStaticText::swap(QStaticText &other)

text

Signature: [const] string text

Description: Method QString QStaticText::text()

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

text=

Signature: void text= (string text)

Description: Method void QStaticText::setText(const QString &text)

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

textFormat

Signature: [const] Qt_TextFormat textFormat

Description: Method Qt::TextFormat QStaticText::textFormat()

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

textFormat=

Signature: void textFormat= (const Qt_TextFormat textFormat)

Description: Method void QStaticText::setTextFormat(Qt::TextFormat textFormat)

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

textOption

Signature: [const] QTextOption textOption

Description: Method QTextOption QStaticText::textOption()

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

textOption=

Signature: void textOption= (const QTextOption textOption)

Description: Method void QStaticText::setTextOption(const QTextOption &textOption)

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

textWidth

Signature: [const] double textWidth

Description: Method double QStaticText::textWidth()

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

textWidth=

Signature: void textWidth= (double textWidth)

Description: Method void QStaticText::setTextWidth(double textWidth)

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