<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qaccessiblewidget.cpp --> <title>QAccessibleWidget Class | Qt Widgets 5.9</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.9</td><td ><a href="qtwidgets-index.html">Qt Widgets</a></td><td ><a href="qtwidgets-module.html">C++ Classes</a></td><td >QAccessibleWidget</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li> <li class="level1"><a href="#protected-functions">Protected Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QAccessibleWidget Class</h1> <!-- $$$QAccessibleWidget-brief --> <p>The <a href="qaccessiblewidget.html">QAccessibleWidget</a> class implements the <a href="../qtgui/qaccessibleinterface.html">QAccessibleInterface</a> for QWidgets. <a href="#details">More...</a></p> <!-- @@@QAccessibleWidget --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAccessibleWidget></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += widgets</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtgui/qaccessibleobject.html">QAccessibleObject</a> and <a href="../qtgui/qaccessibleactioninterface.html">QAccessibleActionInterface</a></td></tr></table></div><ul> <li><a href="qaccessiblewidget-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#QAccessibleWidget">QAccessibleWidget</a></b>(QWidget *<i>w</i>, QAccessible::Role <i>role</i> = QAccessible::Client, const QString &<i>name</i> = QString())</td></tr> </table></div> <a name="reimplemented-public-functions"></a> <h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#actionNames">actionNames</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QColor </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#backgroundColor">backgroundColor</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QAccessibleInterface *</td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#child">child</a></b>(int <i>index</i>) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#childCount">childCount</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#doAction">doAction</a></b>(const QString &<i>actionName</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QAccessibleInterface *</td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#focusChild">focusChild</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QColor </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#foregroundColor">foregroundColor</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#indexOfChild">indexOfChild</a></b>(const QAccessibleInterface *<i>child</i>) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void *</td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#interface_cast">interface_cast</a></b>(QAccessible::InterfaceType <i>t</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#isValid">isValid</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#keyBindingsForAction">keyBindingsForAction</a></b>(const QString &<i>actionName</i>) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QAccessibleInterface *</td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#parent">parent</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QRect </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#rect">rect</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QVector<QPair<QAccessibleInterface *, QAccessible::Relation> > </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#relations">relations</a></b>(QAccessible::Relation <i>match</i> = QAccessible::AllRelations) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QAccessible::Role </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#role">role</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QAccessible::State </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#state">state</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#text">text</a></b>(QAccessible::Text <i>t</i>) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QWindow *</td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#window">window</a></b>() const</td></tr> </table></div> <ul> <li class="fn">5 public functions inherited from <a href="../qtgui/qaccessibleobject.html#public-functions">QAccessibleObject</a></li> <li class="fn">5 public functions inherited from <a href="../qtgui/qaccessibleactioninterface.html#public-functions">QAccessibleActionInterface</a></li> <li class="fn">23 public functions inherited from <a href="../qtgui/qaccessibleinterface.html#public-functions">QAccessibleInterface</a></li> </ul> <a name="protected-functions"></a> <h2 id="protected-functions">Protected Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#dtor.QAccessibleWidget">~QAccessibleWidget</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#addControllingSignal">addControllingSignal</a></b>(const QString &<i>signal</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QObject *</td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#parentObject">parentObject</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QWidget *</td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#widget">widget</a></b>() const</td></tr> </table></div> <h3>Additional Inherited Members</h3> <ul> <li class="fn">12 static public members inherited from <a href="../qtgui/qaccessibleactioninterface.html#static-public-members">QAccessibleActionInterface</a></li> </ul> <a name="details"></a> <!-- $$$QAccessibleWidget-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qaccessiblewidget.html">QAccessibleWidget</a> class implements the <a href="../qtgui/qaccessibleinterface.html">QAccessibleInterface</a> for QWidgets.</p> <p>This class is part of Accessibility for QWidget Applications.</p> <p>This class is convenient to use as a base class for custom implementations of QAccessibleInterfaces that provide information about widget objects.</p> <p>The class provides functions to retrieve the <a href="qaccessiblewidget.html#parentObject">parentObject</a>() (the widget's parent widget), and the associated <a href="qaccessiblewidget.html#widget">widget</a>(). Controlling signals can be added with <a href="qaccessiblewidget.html#addControllingSignal">addControllingSignal</a>(), and setters are provided for various aspects of the interface implementation, for example setValue(), setDescription(), setAccelerator(), and setHelp().</p> </div> <p><b>See also </b><a href="../qtgui/qaccessible.html">QAccessible</a> and <a href="../qtgui/qaccessibleobject.html">QAccessibleObject</a>.</p> <!-- @@@QAccessibleWidget --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QAccessibleWidget[overload1]$$$QAccessibleWidgetQWidget*QAccessible::RoleconstQString& --> <h3 class="fn" id="QAccessibleWidget"><a name="QAccessibleWidget"></a>QAccessibleWidget::<span class="name">QAccessibleWidget</span>(<span class="type"><a href="qwidget.html">QWidget</a></span> *<i>w</i>, <span class="type"><a href="../qtgui/qaccessible.html#Role-enum">QAccessible::Role</a></span> <i>role</i> = QAccessible::Client, const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>name</i> = QString())</h3> <p>Creates a <a href="qaccessiblewidget.html">QAccessibleWidget</a> object for widget <i>w</i>. <i>role</i> and <i>name</i> are optional parameters that set the object's role and name properties.</p> <!-- @@@QAccessibleWidget --> <!-- $$$~QAccessibleWidget[overload1]$$$~QAccessibleWidget --> <h3 class="fn" id="dtor.QAccessibleWidget"><a name="dtor.QAccessibleWidget"></a><code>[protected] </code>QAccessibleWidget::<span class="name">~QAccessibleWidget</span>()</h3> <p>Destroys this object.</p> <!-- @@@~QAccessibleWidget --> <!-- $$$actionNames[overload1]$$$actionNames --> <h3 class="fn" id="actionNames"><a name="actionNames"></a><code>[virtual] </code><span class="type"><a href="../qtcore/qstringlist.html">QStringList</a></span> QAccessibleWidget::<span class="name">actionNames</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleactioninterface.html#actionNames">QAccessibleActionInterface::actionNames</a>().</p> <!-- @@@actionNames --> <!-- $$$addControllingSignal[overload1]$$$addControllingSignalconstQString& --> <h3 class="fn" id="addControllingSignal"><a name="addControllingSignal"></a><code>[protected] </code><span class="type">void</span> QAccessibleWidget::<span class="name">addControllingSignal</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>signal</i>)</h3> <p>Registers <i>signal</i> as a controlling signal.</p> <p>An object is a Controller to any other object connected to a controlling signal.</p> <!-- @@@addControllingSignal --> <!-- $$$backgroundColor[overload1]$$$backgroundColor --> <h3 class="fn" id="backgroundColor"><a name="backgroundColor"></a><code>[virtual] </code><span class="type"><a href="../qtgui/qcolor.html">QColor</a></span> QAccessibleWidget::<span class="name">backgroundColor</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#backgroundColor">QAccessibleInterface::backgroundColor</a>().</p> <!-- @@@backgroundColor --> <!-- $$$child[overload1]$$$childint --> <h3 class="fn" id="child"><a name="child"></a><code>[virtual] </code><span class="type"><a href="../qtgui/qaccessibleinterface.html">QAccessibleInterface</a></span> *QAccessibleWidget::<span class="name">child</span>(<span class="type">int</span> <i>index</i>) const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#child">QAccessibleInterface::child</a>().</p> <!-- @@@child --> <!-- $$$childCount[overload1]$$$childCount --> <h3 class="fn" id="childCount"><a name="childCount"></a><code>[virtual] </code><span class="type">int</span> QAccessibleWidget::<span class="name">childCount</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#childCount">QAccessibleInterface::childCount</a>().</p> <!-- @@@childCount --> <!-- $$$doAction[overload1]$$$doActionconstQString& --> <h3 class="fn" id="doAction"><a name="doAction"></a><code>[virtual] </code><span class="type">void</span> QAccessibleWidget::<span class="name">doAction</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>actionName</i>)</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleactioninterface.html#doAction">QAccessibleActionInterface::doAction</a>().</p> <!-- @@@doAction --> <!-- $$$focusChild[overload1]$$$focusChild --> <h3 class="fn" id="focusChild"><a name="focusChild"></a><code>[virtual] </code><span class="type"><a href="../qtgui/qaccessibleinterface.html">QAccessibleInterface</a></span> *QAccessibleWidget::<span class="name">focusChild</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#focusChild">QAccessibleInterface::focusChild</a>().</p> <!-- @@@focusChild --> <!-- $$$foregroundColor[overload1]$$$foregroundColor --> <h3 class="fn" id="foregroundColor"><a name="foregroundColor"></a><code>[virtual] </code><span class="type"><a href="../qtgui/qcolor.html">QColor</a></span> QAccessibleWidget::<span class="name">foregroundColor</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#foregroundColor">QAccessibleInterface::foregroundColor</a>().</p> <!-- @@@foregroundColor --> <!-- $$$indexOfChild[overload1]$$$indexOfChildconstQAccessibleInterface* --> <h3 class="fn" id="indexOfChild"><a name="indexOfChild"></a><code>[virtual] </code><span class="type">int</span> QAccessibleWidget::<span class="name">indexOfChild</span>(const <span class="type"><a href="../qtgui/qaccessibleinterface.html">QAccessibleInterface</a></span> *<i>child</i>) const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#indexOfChild">QAccessibleInterface::indexOfChild</a>().</p> <!-- @@@indexOfChild --> <!-- $$$interface_cast[overload1]$$$interface_castQAccessible::InterfaceType --> <h3 class="fn" id="interface_cast"><a name="interface_cast"></a><code>[virtual] </code><span class="type">void</span> *QAccessibleWidget::<span class="name">interface_cast</span>(<span class="type"><a href="../qtgui/qaccessible.html#InterfaceType-enum">QAccessible::InterfaceType</a></span> <i>t</i>)</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#interface_cast">QAccessibleInterface::interface_cast</a>().</p> <!-- @@@interface_cast --> <!-- $$$isValid[overload1]$$$isValid --> <h3 class="fn" id="isValid"><a name="isValid"></a><code>[virtual] </code><span class="type">bool</span> QAccessibleWidget::<span class="name">isValid</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#isValid">QAccessibleInterface::isValid</a>().</p> <!-- @@@isValid --> <!-- $$$keyBindingsForAction[overload1]$$$keyBindingsForActionconstQString& --> <h3 class="fn" id="keyBindingsForAction"><a name="keyBindingsForAction"></a><code>[virtual] </code><span class="type"><a href="../qtcore/qstringlist.html">QStringList</a></span> QAccessibleWidget::<span class="name">keyBindingsForAction</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>actionName</i>) const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleactioninterface.html#keyBindingsForAction">QAccessibleActionInterface::keyBindingsForAction</a>().</p> <!-- @@@keyBindingsForAction --> <!-- $$$parent[overload1]$$$parent --> <h3 class="fn" id="parent"><a name="parent"></a><code>[virtual] </code><span class="type"><a href="../qtgui/qaccessibleinterface.html">QAccessibleInterface</a></span> *QAccessibleWidget::<span class="name">parent</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#parent">QAccessibleInterface::parent</a>().</p> <!-- @@@parent --> <!-- $$$parentObject[overload1]$$$parentObject --> <h3 class="fn" id="parentObject"><a name="parentObject"></a><code>[protected] </code><span class="type"><a href="../qtcore/qobject.html">QObject</a></span> *QAccessibleWidget::<span class="name">parentObject</span>() const</h3> <p>Returns the associated widget's parent object, which is either the parent widget, or <a href="qapplication.html#qApp">qApp</a> for top-level widgets.</p> <!-- @@@parentObject --> <!-- $$$rect[overload1]$$$rect --> <h3 class="fn" id="rect"><a name="rect"></a><code>[virtual] </code><span class="type"><a href="../qtcore/qrect.html">QRect</a></span> QAccessibleWidget::<span class="name">rect</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#rect">QAccessibleInterface::rect</a>().</p> <!-- @@@rect --> <!-- $$$relations[overload1]$$$relationsQAccessible::Relation --> <h3 class="fn" id="relations"><a name="relations"></a><code>[virtual] </code><span class="type"><a href="../qtcore/qvector.html">QVector</a></span><<span class="type"><a href="../qtcore/qpair.html">QPair</a></span><<span class="type"><a href="../qtgui/qaccessibleinterface.html">QAccessibleInterface</a></span> *, <span class="type"><a href="../qtgui/qaccessible.html#RelationFlag-enum">QAccessible::Relation</a></span>> > QAccessibleWidget::<span class="name">relations</span>(<span class="type"><a href="../qtgui/qaccessible.html#RelationFlag-enum">QAccessible::Relation</a></span> <i>match</i> = QAccessible::AllRelations) const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#relations">QAccessibleInterface::relations</a>().</p> <!-- @@@relations --> <!-- $$$role[overload1]$$$role --> <h3 class="fn" id="role"><a name="role"></a><code>[virtual] </code><span class="type"><a href="../qtgui/qaccessible.html#Role-enum">QAccessible::Role</a></span> QAccessibleWidget::<span class="name">role</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#role">QAccessibleInterface::role</a>().</p> <!-- @@@role --> <!-- $$$state[overload1]$$$state --> <h3 class="fn" id="state"><a name="state"></a><code>[virtual] </code><span class="type"><a href="../qtgui/qaccessible-state.html">QAccessible::State</a></span> QAccessibleWidget::<span class="name">state</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#state">QAccessibleInterface::state</a>().</p> <!-- @@@state --> <!-- $$$text[overload1]$$$textQAccessible::Text --> <h3 class="fn" id="text"><a name="text"></a><code>[virtual] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAccessibleWidget::<span class="name">text</span>(<span class="type"><a href="../qtgui/qaccessible.html#Text-enum">QAccessible::Text</a></span> <i>t</i>) const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#text">QAccessibleInterface::text</a>().</p> <!-- @@@text --> <!-- $$$widget[overload1]$$$widget --> <h3 class="fn" id="widget"><a name="widget"></a><code>[protected] </code><span class="type"><a href="qwidget.html">QWidget</a></span> *QAccessibleWidget::<span class="name">widget</span>() const</h3> <p>Returns the associated widget.</p> <!-- @@@widget --> <!-- $$$window[overload1]$$$window --> <h3 class="fn" id="window"><a name="window"></a><code>[virtual] </code><span class="type"><a href="../qtgui/qwindow.html">QWindow</a></span> *QAccessibleWidget::<span class="name">window</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qaccessibleinterface.html#window">QAccessibleInterface::window</a>().</p> <!-- @@@window --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>