QAccessibleInterface Class

Member Function Documentation

[virtual protected] QAccessibleInterface::~QAccessibleInterface()

Destroys the QAccessibleInterface.

QAccessibleActionInterface *QAccessibleInterface::actionInterface()

[virtual] QColor QAccessibleInterface::backgroundColor() const

Returns the accessible's background color if applicable or an invalid QColor.

See also foregroundColor().

[pure virtual] QAccessibleInterface *QAccessibleInterface::child(int index) const

Returns the accessible child with index index. 0-based index. The number of children of an object can be checked with childCount.

Returns 0 when asking for an invalid child (e.g. when the child became invalid in the meantime).

See also childCount() and parent().

[pure virtual] QAccessibleInterface *QAccessibleInterface::childAt(int x, int y) const

Returns the QAccessibleInterface of a child that contains the screen coordinates (x, y). If there are no children at this position this function returns 0. The returned accessible must be a child, but not necessarily a direct child.

This function is only relyable for visible objects (invisible object might not be laid out correctly).

All visual objects provide this information.

A default implementation is provided for objects inheriting QAccessibleObject. This will iterate over all children. If the widget manages its children (e.g. a table) it will be more efficient to write a specialized implementation.

See also rect().

[pure virtual] int QAccessibleInterface::childCount() const

Returns the number of children that belong to this object. A child can provide accessibility information on its own (e.g. a child widget), or be a sub-element of this accessible object.

All objects provide this information.

See also indexOfChild().

[virtual] QAccessibleInterface *QAccessibleInterface::focusChild() const

Returns the object that has the keyboard focus.

The object returned can be any descendant, including itself.

[virtual] QColor QAccessibleInterface::foregroundColor() const

Returns the accessible's foreground color if applicable or an invalid QColor.

See also backgroundColor().

[pure virtual] int QAccessibleInterface::indexOfChild(const QAccessibleInterface *child) const

Returns the 0-based index of the object child in this object's children list, or -1 if child is not a child of this object.

All objects provide this information about their children.

See also childCount().

[virtual] void *QAccessibleInterface::interface_cast(QAccessible::InterfaceType type)

Returns a specialized accessibility interface type from the generic QAccessibleInterface.

This function must be reimplemented when providing more information about a widget or object through the specialized interfaces. For example a line edit should implement the QAccessibleTextInterface.

Qt's QLineEdit for example has its accessibility support implemented in QAccessibleLineEdit.

  void *QAccessibleLineEdit::interface_cast(QAccessible::InterfaceType t)
  {
      if (t == QAccessible::TextInterface)
          return static_cast<QAccessibleTextInterface*>(this);
      return QAccessibleWidget::interface_cast(t);
  }

See also QAccessible::InterfaceType, QAccessibleTextInterface, QAccessibleValueInterface, QAccessibleActionInterface, QAccessibleTableInterface, and QAccessibleTableCellInterface.

[pure virtual] bool QAccessibleInterface::isValid() const

Returns true if all the data necessary to use this interface implementation is valid (e.g. all pointers are non-null); otherwise returns false.

See also object().

[pure virtual] QObject *QAccessibleInterface::object() const

Returns a pointer to the QObject this interface implementation provides information for.

See also isValid().

[pure virtual] QAccessibleInterface *QAccessibleInterface::parent() const

Returns the QAccessibleInterface of the parent in the accessible object hierarchy.

Returns 0 if no parent exists (e.g. for the top level application object).

See also child().

[pure virtual] QRect QAccessibleInterface::rect() const

Returns the geometry of the object. The geometry is in screen coordinates.

This function is only reliable for visible objects (invisible objects might not be laid out correctly).

All visual objects provide this information.

See also childAt().

[virtual] QVector<QPair<QAccessibleInterface *, QAccessible::Relation> > QAccessibleInterface::relations(QAccessible::Relation match = QAccessible::AllRelations) const

Returns the meaningful relations to other widgets. Usually this will not return parent/child relations, unless they are handled in a specific way such as in tree views. It will typically return the labelled-by and label relations.

It is possible to filter the relations by using match. It should never return itself.

See also parent() and child().

[pure virtual] QAccessible::Role QAccessibleInterface::role() const

Returns the role of the object. The role of an object is usually static.

All accessible objects have a role.

See also text() and state().

[pure virtual] void QAccessibleInterface::setText(QAccessible::Text t, const QString &text)

Sets the text property t of the object to text.

Note that the text properties of most objects are read-only so calling this function might have no effect.

See also text().

[pure virtual] QAccessible::State QAccessibleInterface::state() const

Returns the current state of the object. The returned value is a combination of the flags in the QAccessible::StateFlag enumeration.

All accessible objects have a state.

See also text() and role().

QAccessibleTableCellInterface *QAccessibleInterface::tableCellInterface()

QAccessibleTableInterface *QAccessibleInterface::tableInterface()

[pure virtual] QString QAccessibleInterface::text(QAccessible::Text t) const

Returns the value of the text property t of the object.

The QAccessible::Name is a string used by clients to identify, find, or announce an accessible object for the user. All objects must have a name that is unique within their container. The name can be used differently by clients, so the name should both give a short description of the object and be unique.

An accessible object's QAccessible::Description provides textual information about an object's visual appearance. The description is primarily used to provide greater context for vision-impaired users, but is also used for context searching or other applications. Not all objects have a description. An "OK" button would not need a description, but a tool button that shows a picture of a smiley would.

The QAccessible::Value of an accessible object represents visual information contained by the object, e.g. the text in a line edit. Usually, the value can be modified by the user. Not all objects have a value, e.g. static text labels don't, and some objects have a state that already is the value, e.g. toggle buttons.

The QAccessible::Help text provides information about the function and usage of an accessible object. Not all objects provide this information.

The QAccessible::Accelerator is a keyboard shortcut that activates the object's default action. A keyboard shortcut is the underlined character in the text of a menu, menu item or widget, and is either the character itself, or a combination of this character and a modifier key like Alt, Ctrl or Shift. Command controls like tool buttons also have shortcut keys and usually display them in their tooltip.

All objects provide a string for QAccessible::Name.

See also setText(), role(), and state().

QAccessibleTextInterface *QAccessibleInterface::textInterface()

QAccessibleValueInterface *QAccessibleInterface::valueInterface()

[virtual] QWindow *QAccessibleInterface::window() const

Returns the window associated with the underlying object. For instance, QAccessibleWidget reimplements this and returns the windowHandle() of the QWidget.

It is used on some platforms to be able to notify the AT client about state changes. The backend will traverse up all ancestors until it finds a window. (This means that at least one interface among the ancestors should return a valid QWindow pointer).

The default implementation returns 0.