CopperSpice API  1.7.2
QAccessibleWidget Class Reference

Implements the QAccessibleInterface for QWidgets. More...

Inheritance diagram for QAccessibleWidget:
QAccessibleObject QAccessibleActionInterface QAccessibleInterface

Public Methods

 QAccessibleWidget (QWidget *widget, QAccessible::Role role=QAccessible::Client, const QString &name=QString ())
 
QStringList actionNames () const override
 
QColor backgroundColor () const override
 
QAccessibleInterfacechild (int index) const override
 
int childCount () const override
 
void doAction (const QString &actionName) override
 
QAccessibleInterfacefocusChild () const override
 
QColor foregroundColor () const override
 
int indexOfChild (const QAccessibleInterface *child) const override
 
void * interface_cast (QAccessible::InterfaceType type) override
 
bool isValid () const override
 
QStringList keyBindingsForAction (const QString &actionName) const override
 
QAccessibleInterfaceparent () const override
 
QRect rect () const override
 
QVector< QPair< QAccessibleInterface *, QAccessible::Relation > > relations (QAccessible::Relation match=QAccessible::AllRelations) const override
 
QAccessible::Role role () const override
 
QAccessible::State state () const override
 
QString text (QAccessible::Text text) const override
 
QWindowwindow () const override
 
- Public Methods inherited from QAccessibleObject
 QAccessibleObject (QObject *object)
 
QAccessibleInterfacechildAt (int x, int y) const override
 
bool isValid () const override
 
QObjectobject () const override
 
QRect rect () const override
 
void setText (QAccessible::Text text, const QString &str) override
 
- Public Methods inherited from QAccessibleInterface
QAccessibleActionInterfaceactionInterface ()
 
virtual QColor backgroundColor () const
 
virtual QAccessibleInterface * child (int index) const = 0
 
virtual QAccessibleInterface * childAt (int x, int y) const = 0
 
virtual int childCount () const = 0
 
virtual QAccessibleInterface * focusChild () const
 
virtual QColor foregroundColor () const
 
virtual int indexOfChild (const QAccessibleInterface *child) const = 0
 
virtual void * interface_cast (QAccessible::InterfaceType type)
 
virtual bool isValid () const = 0
 
virtual QObjectobject () const = 0
 
virtual QAccessibleInterface * parent () const = 0
 
virtual QRect rect () const = 0
 
virtual QVector< QPair< QAccessibleInterface *, QAccessible::Relation > > relations (QAccessible::Relation match=QAccessible::AllRelations) const
 
virtual QAccessible::Role role () const = 0
 
virtual void setText (QAccessible::Text t, const QString &text) = 0
 
virtual QAccessible::State state () const = 0
 
QAccessibleTableCellInterfacetableCellInterface ()
 
QAccessibleTableInterfacetableInterface ()
 
virtual QString text (QAccessible::Text t) const = 0
 
QAccessibleTextInterfacetextInterface ()
 
QAccessibleValueInterfacevalueInterface ()
 
virtual QWindowwindow () const
 
- Public Methods inherited from QAccessibleActionInterface
virtual ~QAccessibleActionInterface ()
 

Protected Methods

 ~QAccessibleWidget ()
 
void addControllingSignal (const QString &signal)
 
QObjectparentObject () const
 
QWidgetwidget () const
 
- Protected Methods inherited from QAccessibleObject
virtual ~QAccessibleObject ()
 
- Protected Methods inherited from QAccessibleInterface
virtual ~QAccessibleInterface ()
 

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, QAccessibleObject

Constructor & Destructor Documentation

QAccessibleWidget::QAccessibleWidget ( QWidget widget,
QAccessible::Role  role = QAccessible::Client,
const QString name = QString() 
)
explicit

Creates a QAccessibleWidget object for widget widget. The parameters for role and name are optional.

QAccessibleWidget::~QAccessibleWidget ( )
protected

Destroys this object.

Method Documentation

QStringList QAccessibleWidget::actionNames ( ) const
overridevirtual

Reimplements QAccessibleActionInterface::actionNames().

Implements QAccessibleActionInterface.

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.

QColor QAccessibleWidget::backgroundColor ( ) const
override
QAccessibleInterface * QAccessibleWidget::child ( int  index) const
override

Reimplements QAccessibleInterface::child(int index).

int QAccessibleWidget::childCount ( ) const
override
void QAccessibleWidget::doAction ( const QString actionName)
overridevirtual

Reimplemented from QAccessibleInterface::doAction().

Implements QAccessibleActionInterface.

QAccessibleInterface * QAccessibleWidget::focusChild ( ) const
override
QColor QAccessibleWidget::foregroundColor ( ) const
override
int QAccessibleWidget::indexOfChild ( const QAccessibleInterface child) const
override
void * QAccessibleWidget::interface_cast ( QAccessible::InterfaceType  type)
override
bool QAccessibleWidget::isValid ( ) const
override

Reimplemented from QAccessibleInterface::isValid().

QStringList QAccessibleWidget::keyBindingsForAction ( const QString actionName) const
overridevirtual

Reimplements QAccessibleActionInterface::keyBindingsForAction(const QString &actionName).

Implements QAccessibleActionInterface.

QAccessibleInterface * QAccessibleWidget::parent ( ) const
override
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 ( ) const
override

Reimplemented from QAccessibleInterface::rect().

QVector< QPair< QAccessibleInterface *, QAccessible::Relation > > QAccessibleWidget::relations ( QAccessible::Relation  match = QAccessible::AllRelations) const
override

Reimplements QAccessibleInterface::relations(QAccessible::Relation match) .

QAccessible::Role QAccessibleWidget::role ( ) const
override

Reimplemented from QAccessibleInterface::role().

QAccessible::State QAccessibleWidget::state ( ) const
override

Reimplemented from QAccessibleInterface::state().

QString QAccessibleWidget::text ( QAccessible::Text  text) const
override

Reimplemented from QAccessibleInterface::text().

QWidget * QAccessibleWidget::widget ( ) const
protected

Returns the associated widget.

QWindow * QAccessibleWidget::window ( ) const
override

Reimplemented from QAccessibleInterface::window().