AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve docs for QWidget::accessibleName/Description

Browse Source 
Change-Id: Ie898c49ed10b9598a0482ecadb18bbadb586d7a9
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
Frederik Gladhorn 2014-06-20 10:07:01 +02:00
parent 6302d6eef7
commit 28f4f10640
1 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/widgets/kernel/qwidget.cpp
View File

@ -11310,12 +11310,21 @@ QString QWidget::whatsThis() const
\brief the widget's name as seen by assistive technologies
This property is used by accessible clients to identify, find, or announce
the widget for accessible clients.
This is the primary name by which assistive technology such as screen readers
announce this widget. For most widgets setting this property is not required.
For example for QPushButton the button's text will be used.
It is important to set this property when the widget does not provide any
text. For example a button that only contains an icon needs to set this
property to work with screen readers.
The name should be short and equivalent to the visual information conveyed
by the widget.
This property has to be \l{Internationalization with Qt}{localized}.
By default, this property contains an empty string.
\sa QAccessibleInterface::text()
\sa QWidget::accessibleDescription, QAccessibleInterface::text()
*/
void QWidget::setAccessibleName(const QString &name)
{
@ -11336,9 +11345,16 @@ QString QWidget::accessibleName() const
\brief the widget's description as seen by assistive technologies
By default, this property contains an empty string.
The accessible description of a widget should convey what a widget does.
While the \l accessibleName should be a short and consise string (e.g. \gui{Save}),
the description should give more context, such as \gui{Saves the current document}.
\sa QAccessibleInterface::text()
This property has to be \l{Internationalization with Qt}{localized}.
By default, this property contains an empty string and Qt falls back
to using the tool tip to provide this information.
\sa QWidget::accessibleName, QAccessibleInterface::text()
*/
void QWidget::setAccessibleDescription(const QString &description)
{