API reference - Class QAccessibleWidget

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QAccessibleWidget

Class hierarchy: QAccessibleWidget » QAccessibleObject » QAccessibleInterface

Sub-classes:

Public constructors

new QAccessibleWidgetnew(QWidget ptr o,
const QAccessible_Role r = QAccessible::Client,
string name = QString())
Constructor QAccessibleWidget::QAccessibleWidget(QWidget *o, QAccessible::Role r, const QString &name)

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]string[]actionNamesMethod QStringList QAccessibleWidget::actionNames()
[const]const QAccessibleActionInterface ptrasConstQAccessibleActionInterfaceDelivers the base class interface QAccessibleActionInterface of QAccessibleWidget
[const]const QAccessibleObject ptrasConstQAccessibleObjectDelivers the base class interface QAccessibleObject of QAccessibleWidget
QAccessibleActionInterface ptrasQAccessibleActionInterfaceDelivers the base class interface QAccessibleActionInterface of QAccessibleWidget
QAccessibleObject ptrasQAccessibleObjectDelivers the base class interface QAccessibleObject of QAccessibleWidget
[const]QColorbackgroundColorMethod QColor QAccessibleWidget::backgroundColor()
[const]QAccessibleInterface ptrchild(int index)Method QAccessibleInterface *QAccessibleWidget::child(int index)
[const]intchildCountMethod int QAccessibleWidget::childCount()
voiddoAction(string actionName)Method void QAccessibleWidget::doAction(const QString &actionName)
[const]QAccessibleInterface ptrfocusChildMethod QAccessibleInterface *QAccessibleWidget::focusChild()
[const]QColorforegroundColorMethod QColor QAccessibleWidget::foregroundColor()
[const]intindexOfChild(const QAccessibleInterface ptr child)Method int QAccessibleWidget::indexOfChild(const QAccessibleInterface *child)
void *interface_cast(const QAccessible_InterfaceType t)Method void *QAccessibleWidget::interface_cast(QAccessible::InterfaceType t)
[const]boolisValid?Method bool QAccessibleWidget::isValid()
[const]string[]keyBindingsForAction(string actionName)Method QStringList QAccessibleWidget::keyBindingsForAction(const QString &actionName)
[const]QAccessibleInterface ptrparentMethod QAccessibleInterface *QAccessibleWidget::parent()
[const]QRectrectMethod QRect QAccessibleWidget::rect()
[const]QPair_QAccessibleInterfacePtr_QAccessible_Relation[]relations(QAccessible_QFlags_RelationFlag match = QAccessible::AllRelations)Method QVector<QPair<QAccessibleInterface*, QAccessible::Relation> > QAccessibleWidget::relations(QFlags<QAccessible::RelationFlag> match)
[const]QAccessible_RoleroleMethod QAccessible::Role QAccessibleWidget::role()
[const]QAccessible_StatestateMethod QAccessible::State QAccessibleWidget::state()
[const]stringtext(const QAccessible_Text t)Method QString QAccessibleWidget::text(QAccessible::Text t)
[const]QWindow ptrwindowMethod QWindow *QAccessibleWidget::window()

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.

actionNames

Signature: [const] string[] actionNames

Description: Method QStringList QAccessibleWidget::actionNames()

This is a reimplementation of QAccessibleActionInterface::actionNames

asConstQAccessibleActionInterface

Signature: [const] const QAccessibleActionInterface ptr asConstQAccessibleActionInterface

Description: Delivers the base class interface QAccessibleActionInterface of QAccessibleWidget

Class QAccessibleWidget is derived from multiple base classes. This method delivers the QAccessibleActionInterface base class aspect.

Use this version if you have a const reference.

asConstQAccessibleObject

Signature: [const] const QAccessibleObject ptr asConstQAccessibleObject

Description: Delivers the base class interface QAccessibleObject of QAccessibleWidget

Class QAccessibleWidget is derived from multiple base classes. This method delivers the QAccessibleObject base class aspect.

Use this version if you have a const reference.

asQAccessibleActionInterface

Signature: QAccessibleActionInterface ptr asQAccessibleActionInterface

Description: Delivers the base class interface QAccessibleActionInterface of QAccessibleWidget

Class QAccessibleWidget is derived from multiple base classes. This method delivers the QAccessibleActionInterface base class aspect.

asQAccessibleObject

Signature: QAccessibleObject ptr asQAccessibleObject

Description: Delivers the base class interface QAccessibleObject of QAccessibleWidget

Class QAccessibleWidget is derived from multiple base classes. This method delivers the QAccessibleObject base class aspect.

backgroundColor

Signature: [const] QColor backgroundColor

Description: Method QColor QAccessibleWidget::backgroundColor()

This is a reimplementation of QAccessibleInterface::backgroundColor

child

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

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

This is a reimplementation of QAccessibleInterface::child

childCount

Signature: [const] int childCount

Description: Method int QAccessibleWidget::childCount()

This is a reimplementation of QAccessibleInterface::childCount

doAction

Signature: void doAction (string actionName)

Description: Method void QAccessibleWidget::doAction(const QString &actionName)

This is a reimplementation of QAccessibleActionInterface::doAction

focusChild

Signature: [const] QAccessibleInterface ptr focusChild

Description: Method QAccessibleInterface *QAccessibleWidget::focusChild()

This is a reimplementation of QAccessibleInterface::focusChild

foregroundColor

Signature: [const] QColor foregroundColor

Description: Method QColor QAccessibleWidget::foregroundColor()

This is a reimplementation of QAccessibleInterface::foregroundColor

indexOfChild

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

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

This is a reimplementation of QAccessibleInterface::indexOfChild

interface_cast

Signature: void * interface_cast (const QAccessible_InterfaceType t)

Description: Method void *QAccessibleWidget::interface_cast(QAccessible::InterfaceType t)

This is a reimplementation of QAccessibleInterface::interface_cast

isValid?

Signature: [const] bool isValid?

Description: Method bool QAccessibleWidget::isValid()

This is a reimplementation of QAccessibleObject::isValid

keyBindingsForAction

Signature: [const] string[] keyBindingsForAction (string actionName)

Description: Method QStringList QAccessibleWidget::keyBindingsForAction(const QString &actionName)

This is a reimplementation of QAccessibleActionInterface::keyBindingsForAction

new

Signature: [static] new QAccessibleWidget new (QWidget ptr o, const QAccessible_Role r = QAccessible::Client, string name = QString())

Description: Constructor QAccessibleWidget::QAccessibleWidget(QWidget *o, QAccessible::Role r, const QString &name)

This method creates an object of class QAccessibleWidget.

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

parent

Signature: [const] QAccessibleInterface ptr parent

Description: Method QAccessibleInterface *QAccessibleWidget::parent()

This is a reimplementation of QAccessibleInterface::parent

rect

Signature: [const] QRect rect

Description: Method QRect QAccessibleWidget::rect()

This is a reimplementation of QAccessibleObject::rect

relations

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

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

This is a reimplementation of QAccessibleInterface::relations

role

Signature: [const] QAccessible_Role role

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

This is a reimplementation of QAccessibleInterface::role

state

Signature: [const] QAccessible_State state

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

This is a reimplementation of QAccessibleInterface::state

text

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

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

This is a reimplementation of QAccessibleInterface::text

window

Signature: [const] QWindow ptr window

Description: Method QWindow *QAccessibleWidget::window()

This is a reimplementation of QAccessibleInterface::window