KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QAccessibleObject

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QAccessibleObject

Class hierarchy: QAccessibleObject » QAccessibleInterface

Public methods

[const]QAccessibleObject ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
[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.
[const]QAccessibleInterface ptrchildAt(int x,
int y)
Method QAccessibleInterface *QAccessibleObject::childAt(int x, int y)
[const]boolisValid?Method bool QAccessibleObject::isValid()
[const]QObject ptrobjectMethod QObject *QAccessibleObject::object()
[const]QRectrectMethod QRect QAccessibleObject::rect()
voidsetText(const QAccessible_Text t,
string text)
Method void QAccessibleObject::setText(QAccessible::Text t, const QString &text)

Detailed description

_const_cast

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

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

childAt

Signature: [const] QAccessibleInterface ptr childAt (int x, int y)

Description: Method QAccessibleInterface *QAccessibleObject::childAt(int x, int y)

This is a reimplementation of QAccessibleInterface::childAt

isValid?

Signature: [const] bool isValid?

Description: Method bool QAccessibleObject::isValid()

This is a reimplementation of QAccessibleInterface::isValid

object

Signature: [const] QObject ptr object

Description: Method QObject *QAccessibleObject::object()

This is a reimplementation of QAccessibleInterface::object

rect

Signature: [const] QRect rect

Description: Method QRect QAccessibleObject::rect()

This is a reimplementation of QAccessibleInterface::rect

setText

Signature: void setText (const QAccessible_Text t, string text)

Description: Method void QAccessibleObject::setText(QAccessible::Text t, const QString &text)

This is a reimplementation of QAccessibleInterface::setText