Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions

QAccessible Class Reference

The QAccessible class provides enums and static functions relating to accessibility. More...

#include <qaccessible.h>

Inherited by QAccessibleInterface.

List of all member functions.

Public Members

Static Public Members


Detailed Description

The QAccessible class provides enums and static functions relating to accessibility.

Accessibility clients use implementations of the QAccessibleInterface to read information an accessible object exposes, or to call methods to maniuplate the accessible object. Qt provides implementations of the QAccessibleInterface for most widget classes in a plugin. This plugin is located in the accessibility subdirectory of QTDIR/plugins. Calling queryAccessibleInterface( QObject *object, QAccessibleInterface **iface ) will ask all plugins located in this directory for an implementation that exposes the information for objects of the class of object.

To make a Qt application accessible you have to distribute the accessibility plugin provded with Qt together with your application. Simply add the plugins created in QTDIR/plugins/accessibility to your distribution process. Use QApplication::addLibraryPath() to specify a plugin directory for your application, and copy the files into an accessibility subdirectory of one of those plugin directories. Qt's accessibility framework will load the plugins upon request and use the implementations provided to expose an object's accessibility information.

See the plugin documentation for more details about how to redistribute Qt plugins.

See also Miscellaneous Classes.


Member Type Documentation

QAccessible::Event

This enum type defines event types when the state of the accessible object has changed. Event types are

QAccessible::NavDirection

This enum specifies to which item to move when navigating.

QAccessible::Role

This enum defines a number of roles an accessible object can have. Roles are

QAccessible::State

This enum type defines bitflags that can be combined to indicate the state of the accessible object. Defined values are

QAccessible::Text

This enum specifies string information that an accessible object returns.

Member Function Documentation

QRESULT QAccessible::queryAccessibleInterface ( QObject * object, QAccessibleInterface ** iface ) [static]

Sets iface to point to the implementation of the QAccessibleInterface for object, and returns QS_OK if successfull, or sets iface to 0 and returns QE_NOCOMPONENT if no accessibility implementation for object exists.

The function uses the classname of object to find a suitable implementation. If no implementation for the object's class is available the function tries to find an implementation for the object's parent class.

This function is called to answer an accessibility client's request for object information. You should never need to call this function yourself.

void QAccessible::updateAccessibility ( QObject * object, int control, Event reason ) [static]

Notifies accessibility clients about a change of the accessibility information of object.

reason designates the cause of this change, e.g. ValueChange when the position of e.g. a slider has been changed. control is the ID of the child element that has changed. When control is null, the object itself has changed.

Call this function whenever the state of your accessible object or one of it's subelements has been changed either programmatically (e.g. by calling QLabel::setText() ) or by user interaction.

If there are no accessibility tools listening to this event, the performance penalty for calling this function is minor.


This file is part of the Qt toolkit, copyright © 1995-2001 Trolltech, all rights reserved.


Copyright © 2001 TrolltechTrademarks
Qt version 3.0.0-beta6