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

API reference - Class QAccessibleInterface

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QAccessibleInterface

Public constructors

new QAccessibleInterface ptrnewCreates a new object of this class

Public methods

[const]QAccessibleInterface 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]QColorbackgroundColorMethod QColor QAccessibleInterface::backgroundColor()
[const]QAccessibleInterface ptrchild(int index)Method QAccessibleInterface *QAccessibleInterface::child(int index)
[const]QAccessibleInterface ptrchildAt(int x,
int y)
Method QAccessibleInterface *QAccessibleInterface::childAt(int x, int y)
[const]intchildCountMethod int QAccessibleInterface::childCount()
[const]QAccessibleInterface ptrfocusChildMethod QAccessibleInterface *QAccessibleInterface::focusChild()
[const]QColorforegroundColorMethod QColor QAccessibleInterface::foregroundColor()
[const]intindexOfChild(const QAccessibleInterface ptr arg1)Method int QAccessibleInterface::indexOfChild(const QAccessibleInterface *)
void *interface_cast(const QAccessible_InterfaceType arg1)Method void *QAccessibleInterface::interface_cast(QAccessible::InterfaceType)
[const]boolisValid?Method bool QAccessibleInterface::isValid()
[const]QObject ptrobjectMethod QObject *QAccessibleInterface::object()
[const]QAccessibleInterface ptrparentMethod QAccessibleInterface *QAccessibleInterface::parent()
[const]QRectrectMethod QRect QAccessibleInterface::rect()
[const]QPair_QAccessibleInterfacePtr_QAccessible_Relation[]relations(QAccessible_QFlags_RelationFlag match = QAccessible::AllRelations)Method QVector<QPair<QAccessibleInterface*, QAccessible::Relation> > QAccessibleInterface::relations(QFlags<QAccessible::RelationFlag> match)
[const]QAccessible_RoleroleMethod QAccessible::Role QAccessibleInterface::role()
voidsetText(const QAccessible_Text t,
string text)
Method void QAccessibleInterface::setText(QAccessible::Text t, const QString &text)
[const]QAccessible_StatestateMethod QAccessible::State QAccessibleInterface::state()
QAccessibleTableCellInterface ptrtableCellInterfaceMethod QAccessibleTableCellInterface *QAccessibleInterface::tableCellInterface()
[const]stringtext(const QAccessible_Text t)Method QString QAccessibleInterface::text(QAccessible::Text t)
voidvirtual_hook(int id,
void * data)
Method void QAccessibleInterface::virtual_hook(int id, void *data)
[const]QWindow ptrwindowMethod QWindow *QAccessibleInterface::window()

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

_const_cast

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

backgroundColor

Signature: [const] QColor backgroundColor

Description: Method QColor QAccessibleInterface::backgroundColor()

child

Signature: [const] QAccessibleInterface ptr child (int index)

Description: Method QAccessibleInterface *QAccessibleInterface::child(int index)

childAt

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

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

childCount

Signature: [const] int childCount

Description: Method int QAccessibleInterface::childCount()

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.

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.

focusChild

Signature: [const] QAccessibleInterface ptr focusChild

Description: Method QAccessibleInterface *QAccessibleInterface::focusChild()

foregroundColor

Signature: [const] QColor foregroundColor

Description: Method QColor QAccessibleInterface::foregroundColor()

indexOfChild

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

Description: Method int QAccessibleInterface::indexOfChild(const QAccessibleInterface *)

interface_cast

Signature: void * interface_cast (const QAccessible_InterfaceType arg1)

Description: Method void *QAccessibleInterface::interface_cast(QAccessible::InterfaceType)

isValid?

Signature: [const] bool isValid?

Description: Method bool 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

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

new

Signature: [static] new QAccessibleInterface 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 QObject *QAccessibleInterface::object()

parent

Signature: [const] QAccessibleInterface ptr parent

Description: Method QAccessibleInterface *QAccessibleInterface::parent()

rect

Signature: [const] QRect rect

Description: Method QRect QAccessibleInterface::rect()

relations

Signature: [const] QPair_QAccessibleInterfacePtr_QAccessible_Relation[] relations (QAccessible_QFlags_RelationFlag match = QAccessible::AllRelations)

Description: Method QVector<QPair<QAccessibleInterface*, QAccessible::Relation> > QAccessibleInterface::relations(QFlags<QAccessible::RelationFlag> match)

role

Signature: [const] QAccessible_Role role

Description: Method QAccessible::Role QAccessibleInterface::role()

setText

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

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

state

Signature: [const] QAccessible_State state

Description: Method QAccessible::State QAccessibleInterface::state()

tableCellInterface

Signature: QAccessibleTableCellInterface ptr tableCellInterface

Description: Method QAccessibleTableCellInterface *QAccessibleInterface::tableCellInterface()

text

Signature: [const] string text (const QAccessible_Text t)

Description: Method QString QAccessibleInterface::text(QAccessible::Text t)

virtual_hook

Signature: void virtual_hook (int id, void * data)

Description: Method void QAccessibleInterface::virtual_hook(int id, void *data)

window

Signature: [const] QWindow ptr window

Description: Method QWindow *QAccessibleInterface::window()