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

API reference - Class QAccessibleApplication

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QAccessibleApplication

Class hierarchy: QAccessibleApplication » QAccessibleObject » QAccessibleInterface » QAccessible

Public constructors

new QAccessibleApplicationnewConstructor QAccessibleApplication::QAccessibleApplication()

Public methods

[const]QAccessibleApplication 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.
[const]stringactionText(int action,
const QAccessible_Text t,
int child)
Virtual method QString QAccessibleApplication::actionText(int action, QAccessible::Text t, int child)
[const]intchildAt(int x,
int y)
Virtual method int QAccessibleApplication::childAt(int x, int y)
[const]intchildCountVirtual method int QAccessibleApplication::childCount()
booldoAction(int action,
int child,
variant[] params)
Virtual method bool QAccessibleApplication::doAction(int action, int child, const QList<QVariant> &params)
[const]intindexOfChild(const QAccessibleInterface ptr arg1)Virtual method int QAccessibleApplication::indexOfChild(const QAccessibleInterface *)
[const]boolisValidVirtual method bool QAccessibleApplication::isValid()
[const]QObject ptrobjectVirtual method QObject *QAccessibleApplication::object()
[const]QRectrect(int child)Virtual method QRect QAccessibleApplication::rect(int child)
[const]QAccessible_QFlags_RelationFlagrelationTo(int arg1,
const QAccessibleInterface ptr arg2,
int arg3)
Virtual method QFlags<QAccessible::RelationFlag> QAccessibleApplication::relationTo(int, const QAccessibleInterface *, int)
[const]QAccessible_Rolerole(int child)Virtual method QAccessible::Role QAccessibleApplication::role(int child)
voidsetText(const QAccessible_Text t,
int child,
string text)
Virtual method void QAccessibleApplication::setText(QAccessible::Text t, int child, const QString &text)
[const]QAccessible_QFlags_StateFlagstate(int child)Virtual method QFlags<QAccessible::StateFlag> QAccessibleApplication::state(int child)
[const]stringtext(const QAccessible_Text t,
int child)
Virtual method QString QAccessibleApplication::text(QAccessible::Text t, int child)
[const]intuserActionCount(int child)Virtual method int QAccessibleApplication::userActionCount(int child)

Detailed description

_const_cast

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

actionText

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

Description: Virtual method QString QAccessibleApplication::actionText(int action, QAccessible::Text t, int child)

This method can be reimplemented in a derived class.

childAt

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

Description: Virtual method int QAccessibleApplication::childAt(int x, int y)

This method can be reimplemented in a derived class.

childCount

Signature: [const] int childCount

Description: Virtual method int QAccessibleApplication::childCount()

This method can be reimplemented in a derived class.

doAction

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

Description: Virtual method bool QAccessibleApplication::doAction(int action, int child, const QList<QVariant> &params)

This method can be reimplemented in a derived class.

indexOfChild

Signature: [const] int indexOfChild (const QAccessibleInterface ptr arg1)

Description: Virtual method int QAccessibleApplication::indexOfChild(const QAccessibleInterface *)

This method can be reimplemented in a derived class.

isValid

Signature: [const] bool isValid

Description: Virtual method bool QAccessibleApplication::isValid()

This method can be reimplemented in a derived class.

new

Signature: [static] new QAccessibleApplication new

Description: Constructor QAccessibleApplication::QAccessibleApplication()

This method creates an object of class QAccessibleApplication.

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

object

Signature: [const] QObject ptr object

Description: Virtual method QObject *QAccessibleApplication::object()

This method can be reimplemented in a derived class.

rect

Signature: [const] QRect rect (int child)

Description: Virtual method QRect QAccessibleApplication::rect(int child)

This method can be reimplemented in a derived class.

relationTo

Signature: [const] QAccessible_QFlags_RelationFlag relationTo (int arg1, const QAccessibleInterface ptr arg2, int arg3)

Description: Virtual method QFlags<QAccessible::RelationFlag> QAccessibleApplication::relationTo(int, const QAccessibleInterface *, int)

This method can be reimplemented in a derived class.

role

Signature: [const] QAccessible_Role role (int child)

Description: Virtual method QAccessible::Role QAccessibleApplication::role(int child)

This method can be reimplemented in a derived class.

setText

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

Description: Virtual method void QAccessibleApplication::setText(QAccessible::Text t, int child, const QString &text)

This method can be reimplemented in a derived class.

state

Signature: [const] QAccessible_QFlags_StateFlag state (int child)

Description: Virtual method QFlags<QAccessible::StateFlag> QAccessibleApplication::state(int child)

This method can be reimplemented in a derived class.

text

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

Description: Virtual method QString QAccessibleApplication::text(QAccessible::Text t, int child)

This method can be reimplemented in a derived class.

userActionCount

Signature: [const] int userActionCount (int child)

Description: Virtual method int QAccessibleApplication::userActionCount(int child)

This method can be reimplemented in a derived class.