/usr/share/qt5/doc/qtquick/qml-qtquick-accessible.html is in qtdeclarative5-doc-html 5.2.1-3ubuntu15.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickaccessibleattached.cpp -->
<title>Accessible | QtQuick 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtquick-index.html">Qt Quick</a></li>
<li><a href="qtquick-qmltypereference.html">QML Types</a></li>
<li>Accessible</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Accessible</h1>
<span class="subtitle"></span>
<!-- $$$Accessible-brief -->
<p>Enables accessibility of QML items <a href="#details">More...</a></p>
<!-- @@@Accessible -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> </b><tt>import QtQuick 2.2</tt></td></tr></table><ul>
<li><a href="qml-qtquick-accessible-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-accessible.html#description-prop">description</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-accessible.html#name-prop">name</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-accessible.html#role-prop">role</a></b></b> : enumeration</li>
</ul>
<!-- $$$Accessible-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>This class is part of Accessibility for Qt Quick Applications.</p>
<p>Items the user interacts with or that give information to the user need to expose their information in a semantic way. Then assistive tools can make use of that information to enable users to interact with the application in various ways.</p>
<p>This enables Qt Quick applications to be used with screen-readers for example.</p>
<p>The most important properties to set are <a href="qml-qtquick-accessible.html#name-prop">name</a> and <a href="qml-qtquick-accessible.html#role-prop">role</a>.</p>
<p><b>See also </b>Accessibility.</p>
<!-- @@@Accessible -->
<h2>Property Documentation</h2>
<!-- $$$description -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="description-prop"></a><span class="name">description</span> : <span class="type">string</span></p></td></tr></table></div><div class="qmldoc"><p>This property sets an accessible description. Similar to the name it describes the item. The description can be a little more verbose and tell what the item does, for example the functionallity of the button it describes.</p>
</div></div><!-- @@@description -->
<br/>
<!-- $$$name -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr></table></div><div class="qmldoc"><p>This property sets an accessible name. For a button for example, this should have a binding to its text. In general this property should be set to a simple and concise but human readable name. Do not include the type of control you want to represent but just the name.</p>
</div></div><!-- @@@name -->
<br/>
<!-- $$$role -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="role-prop"></a><span class="name">role</span> : <span class="type">enumeration</span></p></td></tr></table></div><div class="qmldoc"><p>This flags sets the semantic type of the widget. A button for example would have "Button" as type. The value must be one of QAccessible::Role . Example:</p>
<pre class="qml"><span class="type"><a href="qml-qtquick-item.html">Item</a></span> {
<span class="name">id</span>: <span class="name">myButton</span>
<span class="type"><a href="qml-qtquick-text.html">Text</a></span> {
<span class="name">id</span>: <span class="name">label</span>
<span class="comment">// ...</span>
}
<span class="name">Accessible</span>.name: <span class="name">label</span>.<span class="name">text</span>
<span class="name">Accessible</span>.role: <span class="name">Accessible</span>.<span class="name">Button</span>
<span class="keyword">function</span> <span class="name">accessiblePressAction</span>() {
<span class="comment">//...</span>
}
}</pre>
<p>Some roles have special semantics. In order to implement check boxes for example a "checked" property is expected.</p>
<table class="generic">
<thead><tr class="qt-style"><th ><b>Role</b></th><th ><b>Expected property</b></th><th ></th></tr></thead>
<tr valign="top" class="odd"><td >Button</td><td >function accessiblePressAction</td><td >Called when the button receives a press action. The implementation should visually simulate a button click and perform the button action.</td></tr>
<tr valign="top" class="even"><td >CheckBox, Radiobutton</td><td >checked</td><td >The check state of the check box. Updated on Press, Check and Uncheck actions.</td></tr>
<tr valign="top" class="odd"><td >Slider, SpinBox, Dial, ScrollBar</td><td >value, minimumValue, maximumValue, stepSize</td><td >value will be updated on increase and decrase actions, in accordance with the other properties</td></tr>
</table>
</div></div><!-- @@@role -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|