Qt Reference Documentation

QAccessibleWidget Class Reference

The QAccessibleWidget class implements the QAccessibleInterface for QWidgets. More...

 #include <QAccessibleWidget>

Inherits: QAccessibleObject.

Public Functions

QAccessibleWidget ( QWidget * w, Role role = Client, const QString & name = QString() )

Reimplemented Public Functions

virtual QString actionText ( int action, Text t, int child ) const
virtual int childAt ( int x, int y ) const
virtual int childCount () const
virtual bool doAction ( int action, int child, const QVariantList & params )
virtual int indexOfChild ( const QAccessibleInterface * child ) const
virtual int navigate ( RelationFlag relation, int entry, QAccessibleInterface ** target ) const
virtual QRect rect ( int child ) const
virtual Relation relationTo ( int child, const QAccessibleInterface * other, int otherChild ) const
virtual Role role ( int child ) const
virtual State state ( int child ) const
virtual QString text ( Text t, int child ) const
virtual int userActionCount ( int child ) const

Protected Functions

~QAccessibleWidget ()
void addControllingSignal ( const QString & signal )
QObject * parentObject () const
void setAccelerator ( const QString & accel )
void setDescription ( const QString & desc )
void setHelp ( const QString & help )
void setValue ( const QString & value )
QWidget * widget () const

Additional Inherited Members

Detailed Description

The QAccessibleWidget class implements the QAccessibleInterface for QWidgets.

This class is convenient to use as a base class for custom implementations of QAccessibleInterfaces that provide information about widget objects.

The class provides functions to retrieve the parentObject() (the widget's parent widget), and the associated widget(). Controlling signals can be added with addControllingSignal(), and setters are provided for various aspects of the interface implementation, for example setValue(), setDescription(), setAccelerator(), and setHelp().

See also QAccessible and QAccessibleObject.

Member Function Documentation

QAccessibleWidget::QAccessibleWidget ( QWidget * w, Role role = Client, const QString & name = QString() )

Creates a QAccessibleWidget object for widget w. role and name are optional parameters that set the object's role and name properties.

QAccessibleWidget::~QAccessibleWidget () [protected]

Destroys this object.

QString QAccessibleWidget::actionText ( int action, Text t, int child ) const [virtual]

Reimplemented from QAccessibleInterface::actionText().

void QAccessibleWidget::addControllingSignal ( const QString & signal ) [protected]

Registers signal as a controlling signal.

An object is a Controller to any other object connected to a controlling signal.

int QAccessibleWidget::childAt ( int x, int y ) const [virtual]

Reimplemented from QAccessibleInterface::childAt().

int QAccessibleWidget::childCount () const [virtual]

Reimplemented from QAccessibleInterface::childCount().

bool QAccessibleWidget::doAction ( int action, int child, const QVariantList & params ) [virtual]

Reimplemented from QAccessibleInterface::doAction().

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

Reimplemented from QAccessibleInterface::indexOfChild().

int QAccessibleWidget::navigate ( RelationFlag relation, int entry, QAccessibleInterface ** target ) const [virtual]

Reimplemented from QAccessibleInterface::navigate().

QObject * QAccessibleWidget::parentObject () const [protected]

Returns the associated widget's parent object, which is either the parent widget, or qApp for top-level widgets.

QRect QAccessibleWidget::rect ( int child ) const [virtual]

Reimplemented from QAccessibleInterface::rect().

Relation QAccessibleWidget::relationTo ( int child, const QAccessibleInterface * other, int otherChild ) const [virtual]

Reimplemented from QAccessibleInterface::relationTo().

Role QAccessibleWidget::role ( int child ) const [virtual]

Reimplemented from QAccessibleInterface::role().

void QAccessibleWidget::setAccelerator ( const QString & accel ) [protected]

Sets the accelerator of this interface implementation to accel.

The default implementation of text() returns the set value for the Accelerator text.

Note that the object wrapped by this interface is not modified.

void QAccessibleWidget::setDescription ( const QString & desc ) [protected]

Sets the description of this interface implementation to desc.

The default implementation of text() returns the set value for the Description text.

Note that the object wrapped by this interface is not modified.

void QAccessibleWidget::setHelp ( const QString & help ) [protected]

Sets the help of this interface implementation to help.

The default implementation of text() returns the set value for the Help text.

Note that the object wrapped by this interface is not modified.

void QAccessibleWidget::setValue ( const QString & value ) [protected]

Sets the value of this interface implementation to value.

The default implementation of text() returns the set value for the Value text.

Note that the object wrapped by this interface is not modified.

State QAccessibleWidget::state ( int child ) const [virtual]

Reimplemented from QAccessibleInterface::state().

QString QAccessibleWidget::text ( Text t, int child ) const [virtual]

Reimplemented from QAccessibleInterface::text().

int QAccessibleWidget::userActionCount ( int child ) const [virtual]

Reimplemented from QAccessibleInterface::userActionCount().

QWidget * QAccessibleWidget::widget () const [protected]

Returns the associated widget.