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

API reference - Class QAccessibleInterface

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QAccessibleInterface

Class hierarchy: QAccessibleInterface » QAccessible

Public methods

[const]QAccessibleInterface 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)
Method QString QAccessibleInterface::actionText(int action, QAccessible::Text t, int child)
QColorbackgroundColorMethod QColor QAccessibleInterface::backgroundColor()
[const]intchildAt(int x,
int y)
Method int QAccessibleInterface::childAt(int x, int y)
[const]intchildCountMethod int QAccessibleInterface::childCount()
booldoAction(int action,
int child,
variant[] params = QVariantList())
Method bool QAccessibleInterface::doAction(int action, int child, const QList<QVariant> &params)
QColorforegroundColorMethod QColor QAccessibleInterface::foregroundColor()
[const]intindexOfChild(const QAccessibleInterface ptr arg1)Method int QAccessibleInterface::indexOfChild(const QAccessibleInterface *)
variantinvokeMethod(const QAccessible_Method method,
int child = 0,
variant[] params = QVariantList())
Method QVariant QAccessibleInterface::invokeMethod(QAccessible::Method method, int child, const QList<QVariant> &params)
[const]boolisValid?Method bool QAccessibleInterface::isValid()
[const]QObject ptrobjectMethod QObject *QAccessibleInterface::object()
[const]QRectrect(int child)Method QRect QAccessibleInterface::rect(int child)
[const]QAccessible_QFlags_RelationFlagrelationTo(int child,
const QAccessibleInterface ptr other,
int otherChild)
Method QFlags<QAccessible::RelationFlag> QAccessibleInterface::relationTo(int child, const QAccessibleInterface *other, int otherChild)
[const]QAccessible_Rolerole(int child)Method QAccessible::Role QAccessibleInterface::role(int child)
voidsetText(const QAccessible_Text t,
int child,
string text)
Method void QAccessibleInterface::setText(QAccessible::Text t, int child, const QString &text)
[const]QAccessible_QFlags_StateFlagstate(int child)Method QFlags<QAccessible::StateFlag> QAccessibleInterface::state(int child)
QAccessible_Method[]supportedMethodsMethod QSet<QAccessible::Method> QAccessibleInterface::supportedMethods()
[const]stringtext(const QAccessible_Text t,
int child)
Method QString QAccessibleInterface::text(QAccessible::Text t, int child)
[const]intuserActionCount(int child)Method int QAccessibleInterface::userActionCount(int child)

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.

_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: Method QString QAccessibleInterface::actionText(int action, QAccessible::Text t, int child)

backgroundColor

Signature: QColor backgroundColor

Description: Method QColor QAccessibleInterface::backgroundColor()

childAt

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

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

childCount

Signature: [const] int childCount

Description: Method int QAccessibleInterface::childCount()

doAction

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

Description: Method bool QAccessibleInterface::doAction(int action, int child, const QList<QVariant> &params)

foregroundColor

Signature: QColor foregroundColor

Description: Method QColor QAccessibleInterface::foregroundColor()

indexOfChild

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

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

invokeMethod

Signature: variant invokeMethod (const QAccessible_Method method, int child = 0, variant[] params = QVariantList())

Description: Method QVariant QAccessibleInterface::invokeMethod(QAccessible::Method method, int child, const QList<QVariant> &params)

isValid?

Signature: [const] bool isValid?

Description: Method bool QAccessibleInterface::isValid()

object

Signature: [const] QObject ptr object

Description: Method QObject *QAccessibleInterface::object()

rect

Signature: [const] QRect rect (int child)

Description: Method QRect QAccessibleInterface::rect(int child)

relationTo

Signature: [const] QAccessible_QFlags_RelationFlag relationTo (int child, const QAccessibleInterface ptr other, int otherChild)

Description: Method QFlags<QAccessible::RelationFlag> QAccessibleInterface::relationTo(int child, const QAccessibleInterface *other, int otherChild)

role

Signature: [const] QAccessible_Role role (int child)

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

setText

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

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

state

Signature: [const] QAccessible_QFlags_StateFlag state (int child)

Description: Method QFlags<QAccessible::StateFlag> QAccessibleInterface::state(int child)

supportedMethods

Signature: QAccessible_Method[] supportedMethods

Description: Method QSet<QAccessible::Method> QAccessibleInterface::supportedMethods()

text

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

Description: Method QString QAccessibleInterface::text(QAccessible::Text t, int child)

userActionCount

Signature: [const] int userActionCount (int child)

Description: Method int QAccessibleInterface::userActionCount(int child)