The QAccessibleObject class implements parts of the QAccessibleInterface for QObjects. More...

#include <qaccessibleobject.h>

Inheritance diagram for QAccessibleObject:

Public Functions
QString	actionText (int action, Text t, int child) const
	Reimplemented Function More...

bool	doAction (int action, int child, const QVariantList &params)
	Reimplemented Function More...

bool	isValid () const
	Reimplemented Function More...

QObject *	object () const
	Reimplemented Function More...

	QAccessibleObject (QObject *object)
	Creates a QAccessibleObject for object. More...

QRect	rect (int child) const
	Reimplemented Function More...

void	setText (Text t, int child, const QString &text)
	Reimplemented Function More...

int	userActionCount (int child) const
	Reimplemented Function More...

Public Functions inherited from QAccessibleInterface
QAccessibleActionInterface *	actionInterface ()

QColor	backgroundColor ()

virtual int	childAt (int x, int y) const =0
	Returns the 1-based index of the child that contains the screen coordinates (x, y). More...

virtual int	childCount () const =0
	Returns the number of children that belong to this object. More...

QAccessibleEditableTextInterface *	editableTextInterface ()

QColor	foregroundColor ()

QAccessibleImageInterface *	imageInterface ()

virtual int	indexOfChild (const QAccessibleInterface *) const =0
	Returns the 1-based index of the object child in this object's children list, or -1 if child is not a child of this object. More...

QVariant	invokeMethod (Method method, int child=0, const QVariantList &params=QVariantList())
	Invokes a method on child with the given parameters params and returns the result of the operation as QVariant. More...

virtual int	navigate (RelationFlag relation, int index, QAccessibleInterface **iface) const =0
	Navigates from this object to an object that has a relationship relation to this object, and returns the respective object in target. More...

virtual Relation	relationTo (int child, const QAccessibleInterface *other, int otherChild) const =0
	Returns the relationship between this object's \a child and the \a other object's \a otherChild. More...

virtual Role	role (int child) const =0
	Returns the role of the object, or of the object's child if child is not 0. More...

virtual State	state (int child) const =0
	Returns the current state of the object, or of the object's child if child is not 0. More...

QSet< Method >	supportedMethods ()
	Returns a QSet of QAccessible::Method that are supported by this accessible interface. More...

QAccessibleTable2Interface *	table2Interface ()

QAccessibleTableInterface *	tableInterface ()

virtual QString	text (Text t, int child) const =0
	Returns the value of the text property t of the object, or of the object's child if child is not 0. More...

QAccessibleTextInterface *	textInterface ()

QAccessibleValueInterface *	valueInterface ()

virtual	~QAccessibleInterface ()
	Destroys the object. More...

Protected Functions
virtual	~QAccessibleObject ()
	Destroys the QAccessibleObject. More...

Properties
QAccessibleObjectPrivate *	d

Friends
class	QAccessibleObjectEx

Additional Inherited Members
Public Types inherited from QAccessible
enum	Action { DefaultAction = 0, Press = -1, FirstStandardAction = Press, SetFocus = -2, Increase = -3, Decrease = -4, Accept = -5, Cancel = -6, Select = -7, ClearSelection = -8, RemoveSelection = -9, ExtendSelection = -10, AddToSelection = -11, LastStandardAction = AddToSelection }
	This enum describes the possible types of action that can occur. More...

enum	Event { SoundPlayed = 0x0001, Alert = 0x0002, ForegroundChanged = 0x0003, MenuStart = 0x0004, MenuEnd = 0x0005, PopupMenuStart = 0x0006, PopupMenuEnd = 0x0007, ContextHelpStart = 0x000C, ContextHelpEnd = 0x000D, DragDropStart = 0x000E, DragDropEnd = 0x000F, DialogStart = 0x0010, DialogEnd = 0x0011, ScrollingStart = 0x0012, ScrollingEnd = 0x0013, MenuCommand = 0x0018, ActionChanged = 0x0101, ActiveDescendantChanged = 0x0102, AttributeChanged = 0x0103, DocumentContentChanged = 0x0104, DocumentLoadComplete = 0x0105, DocumentLoadStopped = 0x0106, DocumentReload = 0x0107, HyperlinkEndIndexChanged = 0x0108, HyperlinkNumberOfAnchorsChanged = 0x0109, HyperlinkSelectedLinkChanged = 0x010A, HypertextLinkActivated = 0x010B, HypertextLinkSelected = 0x010C, HyperlinkStartIndexChanged = 0x010D, HypertextChanged = 0x010E, HypertextNLinksChanged = 0x010F, ObjectAttributeChanged = 0x0110, PageChanged = 0x0111, SectionChanged = 0x0112, TableCaptionChanged = 0x0113, TableColumnDescriptionChanged = 0x0114, TableColumnHeaderChanged = 0x0115, TableModelChanged = 0x0116, TableRowDescriptionChanged = 0x0117, TableRowHeaderChanged = 0x0118, TableSummaryChanged = 0x0119, TextAttributeChanged = 0x011A, TextCaretMoved = 0x011B, TextColumnChanged = 0x011D, TextInserted = 0x011E, TextRemoved = 0x011F, TextUpdated = 0x0120, TextSelectionChanged = 0x0121, VisibleDataChanged = 0x0122, ObjectCreated = 0x8000, ObjectDestroyed = 0x8001, ObjectShow = 0x8002, ObjectHide = 0x8003, ObjectReorder = 0x8004, Focus = 0x8005, Selection = 0x8006, SelectionAdd = 0x8007, SelectionRemove = 0x8008, SelectionWithin = 0x8009, StateChanged = 0x800A, LocationChanged = 0x800B, NameChanged = 0x800C, DescriptionChanged = 0x800D, ValueChanged = 0x800E, ParentChanged = 0x800F, HelpChanged = 0x80A0, DefaultActionChanged = 0x80B0, AcceleratorChanged = 0x80C0 }
	This enum type defines accessible event types. More...

typedef QAccessibleInterface (	InterfaceFactory) (const QString &key, QObject *)
	This is a typedef for a pointer to a function with the following signature: More...

enum	Method { ListSupportedMethods = 0, SetCursorPosition = 1, GetCursorPosition = 2, ForegroundColor = 3, BackgroundColor = 4 }
	This enum describes the possible types of methods that can be invoked on an accessible object. More...

enum	RelationFlag { Unrelated = 0x00000000, Self = 0x00000001, Ancestor = 0x00000002, Child = 0x00000004, Descendent = 0x00000008, Sibling = 0x00000010, HierarchyMask = 0x000000ff, Up = 0x00000100, Down = 0x00000200, Left = 0x00000400, Right = 0x00000800, Covers = 0x00001000, Covered = 0x00002000, GeometryMask = 0x0000ff00, FocusChild = 0x00010000, Label = 0x00020000, Labelled = 0x00040000, Controller = 0x00080000, Controlled = 0x00100000, LogicalMask = 0x00ff0000 }
	This enum type defines bit flags that can be combined to indicate the relationship between two accessible objects. More...

enum	Role { NoRole = 0x00000000, TitleBar = 0x00000001, MenuBar = 0x00000002, ScrollBar = 0x00000003, Grip = 0x00000004, Sound = 0x00000005, Cursor = 0x00000006, Caret = 0x00000007, AlertMessage = 0x00000008, Window = 0x00000009, Client = 0x0000000A, PopupMenu = 0x0000000B, MenuItem = 0x0000000C, ToolTip = 0x0000000D, Application = 0x0000000E, Document = 0x0000000F, Pane = 0x00000010, Chart = 0x00000011, Dialog = 0x00000012, Border = 0x00000013, Grouping = 0x00000014, Separator = 0x00000015, ToolBar = 0x00000016, StatusBar = 0x00000017, Table = 0x00000018, ColumnHeader = 0x00000019, RowHeader = 0x0000001A, Column = 0x0000001B, Row = 0x0000001C, Cell = 0x0000001D, Link = 0x0000001E, HelpBalloon = 0x0000001F, Assistant = 0x00000020, List = 0x00000021, ListItem = 0x00000022, Tree = 0x00000023, TreeItem = 0x00000024, PageTab = 0x00000025, PropertyPage = 0x00000026, Indicator = 0x00000027, Graphic = 0x00000028, StaticText = 0x00000029, EditableText = 0x0000002A, PushButton = 0x0000002B, CheckBox = 0x0000002C, RadioButton = 0x0000002D, ComboBox = 0x0000002E, ProgressBar = 0x00000030, Dial = 0x00000031, HotkeyField = 0x00000032, Slider = 0x00000033, SpinBox = 0x00000034, Canvas = 0x00000035, Animation = 0x00000036, Equation = 0x00000037, ButtonDropDown = 0x00000038, ButtonMenu = 0x00000039, ButtonDropGrid = 0x0000003A, Whitespace = 0x0000003B, PageTabList = 0x0000003C, Clock = 0x0000003D, Splitter = 0x0000003E, LayeredPane = 0x0000003F, Terminal = 0x00000040, Desktop = 0x00000041, UserRole = 0x0000ffff }
	This enum defines the role of an accessible object. More...

typedef void(*	RootObjectHandler) (QObject *)
	A function pointer type. More...

enum	StateFlag { Normal = 0x00000000, Unavailable = 0x00000001, Selected = 0x00000002, Focused = 0x00000004, Pressed = 0x00000008, Checked = 0x00000010, Mixed = 0x00000020, ReadOnly = 0x00000040, HotTracked = 0x00000080, DefaultButton = 0x00000100, Expanded = 0x00000200, Collapsed = 0x00000400, Busy = 0x00000800, Marqueed = 0x00002000, Animated = 0x00004000, Invisible = 0x00008000, Offscreen = 0x00010000, Sizeable = 0x00020000, Movable = 0x00040000, SelfVoicing = 0x00080000, Focusable = 0x00100000, Selectable = 0x00200000, Linked = 0x00400000, Traversed = 0x00800000, MultiSelectable = 0x01000000, ExtSelectable = 0x02000000, Protected = 0x20000000, HasPopup = 0x40000000, Modal = 0x80000000, HasInvokeExtension = 0x10000000 }
	This enum type defines bit flags that can be combined to indicate the state of an accessible object. More...

enum	Text { Name = 0, Description, Value, Help, Accelerator, UserText = 0x0000ffff }
	This enum specifies string information that an accessible object returns. More...

typedef void(*	UpdateHandler) (QObject *, int who, Event reason)
	A function pointer type. More...

Static Public Functions inherited from QAccessible
static void	cleanup ()

static void	initialize ()

static void	installFactory (InterfaceFactory)
	Installs the InterfaceFactory factory. More...

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

static UpdateHandler	installUpdateHandler (UpdateHandler)
	Installs the given handler as the function to be used by updateAccessibility(), and returns the previously installed handler. More...

static bool	isActive ()
	Returns true if an accessibility implementation has been requested during the runtime of the application; otherwise returns false. More...

static QAccessibleInterface *	queryAccessibleInterface (QObject *)
	If a QAccessibleInterface implementation exists for the given object, this function returns a pointer to the implementation; otherwise it returns 0. More...

static void	removeFactory (InterfaceFactory)
	Removes factory from the list of installed InterfaceFactories. More...

static void	setRootObject (QObject *)
	Sets the root accessible object of this application to object. More...

static void	updateAccessibility (QObject *, int who, Event reason)
	Notifies accessibility clients about a change in object's accessibility information. More...

Detailed Description

The QAccessibleObject class implements parts of the QAccessibleInterface for QObjects.

This class is mainly provided for convenience. All subclasses of the QAccessibleInterface that provide implementations of non-widget objects should use this class as their base class.

See also: QAccessible, QAccessibleWidget

Definition at line 58 of file qaccessibleobject.h.

Constructors and Destructors

◆ QAccessibleObject()

QAccessibleObject::QAccessibleObject ( QObject * object )

explicit

Creates a QAccessibleObject for object.

Definition at line 111 of file qaccessibleobject.cpp.

 {
     d = new QAccessibleObjectPrivate;
     d->object = object;
 }

◆ ~QAccessibleObject()

QAccessibleObject::~QAccessibleObject ( )

protectedvirtual

Destroys the QAccessibleObject.

This only happens when a call to release() decrements the internal reference counter to zero.

Definition at line 123 of file qaccessibleobject.cpp.

 {
     delete d;
 }

Functions

◆ actionText()

QString QAccessibleObject::actionText	(	int	action,
		Text	t,
		int	child
	)		const

virtual

Reimplemented Function

Implements QAccessibleInterface.

Reimplemented in QAccessibleApplication, and QAccessibleWidget.

Definition at line 188 of file qaccessibleobject.cpp.

Referenced by QAccessibleWidget::actionText(), QAccessibleObjectEx::actionText(), and QAccessibleApplication::actionText().

 {
     if (child || action > FirstStandardAction || action < LastStandardAction || t > Accelerator)
         return QString();
 
     return QString::fromLatin1(action_text[-(action - FirstStandardAction)][t]);
 }

◆ doAction()

bool QAccessibleObject::doAction	(	int	action,
		int	child,
		const QVariantList &	params
	)

virtual

Reimplemented Function

Implements QAccessibleInterface.

Reimplemented in QAccessibleApplication, and QAccessibleWidget.

Definition at line 166 of file qaccessibleobject.cpp.

Referenced by QAccessibleWidget::doAction(), QAccessibleObjectEx::doAction(), and QAccessibleApplication::doAction().

 {
     return false;
 }

◆ isValid()

bool QAccessibleObject::isValid ( ) const

virtual

Reimplemented Function

Implements QAccessibleInterface.

Definition at line 143 of file qaccessibleobject.cpp.

Referenced by QAccessibleObjectEx::isValid().

 {
     return !d->object.isNull();
 }

◆ object()

QObject * QAccessibleObject::object ( ) const

virtual

Reimplemented Function

Implements QAccessibleInterface.

Definition at line 131 of file qaccessibleobject.cpp.

Referenced by QAccessibleWidget::addControllingSignal(), QAccessibleWidget::navigate(), QAccessibleApplication::navigate(), QAccessibleObjectEx::object(), QAccessibleWidget::parentObject(), QAccessibleObjectEx::QAccessibleObjectEx(), QAccessibleWidget::relationTo(), QAccessibleWidget::widget(), and QAccessibleWidgetStack::widgetStack().

 {
 #ifndef QT_NO_DEBUG
     if (!d->object)
         qWarning("QAccessibleInterface is invalid. Crash pending...");
 #endif
     return d->object;
 }