API reference - Class QAccessibleObject

Notation used in Ruby API documentation

Description: Binding of QAccessibleObject

Class hierarchy: QAccessibleObject » QAccessibleInterface » QAccessible

Public constructors

new QAccessibleObject ptrnewCreates a new object of this class

Public methods

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]stringactionText(int action,
const QAccessible_Text t,
int child)
Method (int, QAccessible::Text, int) const
booldoAction(int action,
int child,
variant[] params)
Method (int, int, const QList<QVariant> &)
[const]boolisValid?Method () const
[const]QObject ptrobjectMethod () const
[const]QRectrect(int child)Method (int) const
voidsetText(const QAccessible_Text t,
int child,
string text)
Method (QAccessible::Text, int, const QString &)
[const]intuserActionCount(int child)Method (int) const

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

voidcreateUse of this method is deprecated. Use _create 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

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

actionText

Signature: [const] string actionText (int action,const QAccessible_Text t,int child)

Description: Method (int, QAccessible::Text, int) const

This is a reimplementation of QAccessibleInterface::actionText

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

doAction

Signature: bool doAction (int action,int child,variant[] params)

Description: Method (int, int, const QList<QVariant> &)

This is a reimplementation of QAccessibleInterface::doAction

isValid?

Signature: [const] bool isValid?

Description: Method () const

This is a reimplementation of QAccessibleInterface::isValid

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

new

Signature: [static] new QAccessibleObject ptr new

Description: Creates a new object of this class

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

object

Signature: [const] QObject ptr object

Description: Method () const

This is a reimplementation of QAccessibleInterface::object

rect

Signature: [const] QRect rect (int child)

Description: Method (int) const

This is a reimplementation of QAccessibleInterface::rect

setText

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

Description: Method (QAccessible::Text, int, const QString &)

This is a reimplementation of QAccessibleInterface::setText

userActionCount

Signature: [const] int userActionCount (int child)

Description: Method (int) const

This is a reimplementation of QAccessibleInterface::userActionCount