This is a typedef for unsigned, used by the QAccessibleInterface cache.

This is a typedef for a pointer to a method with the following signature.

The call back function receives a QString and a QObject pointer, where the QString is the key identifying the interface. The QObject is passed to the QAccessibleInterface. If the key and the QObject do not have a corresponding QAccessibleInterface a null pointer will be returned.

Installed factories are called by queryAccessibleInterface() until one provides an interface.

Typedef for QFlags<RelationFlag> which contains an OR combination of RelationFlag values.

Refer to QAccessible::RelationFlag for the enum documentation.

This enum type defines accessible event types.

The values for this enum are defined to be the same as those defined in the "AccessibleEventID.idl File Reference" (IAccessible2) and "Microsoft Active Accessibility Event Constants" (MSAA) specifications.

QAccessibleInterface supports several sub interfaces. In order to provide more information about some objects, their accessible representation should implement one or more of these interfaces. When subclassing one of these interfaces, QAccessibleInterface::interface_cast() needs to be implemented.

See also

QAccessibleInterface::interface_cast(), QAccessibleTextInterface, QAccessibleValueInterface, QAccessibleActionInterface, QAccessibleTableInterface, QAccessibleTableCellInterface.

This enum defines the relationships between objects on the screen.

This enum defines the role of an accessible object.

This enum specifies string information that an accessible object returns.

This enum describes different types of text boundaries. It follows the IAccessible2 API and is used in the QAccessibleTextInterface.

See also

QAccessibleTextInterface

Returns the QAccessibleInterface belonging to the uniqueId. Returns nullptr if the id is invalid.

Removes the interface belonging to this uniqueId from the cache and deletes it. The id becomes invalid and may be reused by the cache.

Installs the InterfaceFactory factory. The last factory added is the first one used by queryAccessibleInterface().

Installs the given handler as the function to be used by setRootObject(), and returns the previously installed handler.

Returns true if an accessibility implementation has been requested during the runtime of the application, otherwise returns false. Use this method to prevent potentially expensive notifications via updateAccessibility().

If a QAccessibleInterface implementation exists for the given object, this function returns a pointer to the implementation, otherwise it returns a nullptr.

The function calls all installed factory functions (from most recently installed to least recently installed) until one is found that provides an interface for the class of object. If no factory can provide an accessibility implementation for the class the function loads installed accessibility plugins, and tests if any of the plugins can provide the implementation.

If no implementation for the object's class is available, the function tries to find an implementation for the object's parent class, using the above strategy.

Warning

The caller is responsible for deleting the returned interface after use.

Call this method to ensure manually created interfaces are properly memory managed.

Must only be called exactly once per interface interfaceId. This is implicitly called when calling queryAccessibleInterface, calling this method is only required when QAccessibleInterfaces are instantiated with the "new" operator. This is not recommended, whenever possible use the default methods and let queryAccessibleInterface() take care of this.

When it is necessary to reimplement QAccessibleInterface::child(), call this method before returning the new child.

Removes factory from the list of installed InterfaceFactories.

Sets the root accessible object of this application to object. All other accessible objects in the application can be reached by the client using object navigation.

You should never need to call this method. CopperSpice sets the QApplication object as the root object immediately before the event loop is entered in QApplication::exec(). Use QAccessible::installRootObjectHandler() to redirect the method to a customized handler function.

See also

queryAccessibleInterface()

Returns the unique ID for the QAccessibleInterface interfaceId.

Notifies about a change which might be relevant for accessibility clients. The event provides details about the change. These include the source of the change and the nature of the change. The event should contain enough information to give meaningful notifications. For example, the type ValueChange indicates that the position of a slider has been changed.

Call this method whenever the state of your accessible object or one of its sub-elements has been changed either programmatically, by calling a method such as QLabel::setText(), or by user interaction.

If there are no accessibility tools listening to this event, the performance penalty for calling this method is small, but if determining the parameters of the call is expensive you can test isActive() to avoid unnecessary computations.