aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/accessibility
diff options
context:
space:
mode:
authorAlan Alpert <alan.alpert@nokia.com>2012-04-20 21:01:04 +1000
committerQt by Nokia <qt-info@nokia.com>2012-04-26 03:33:13 +0200
commit1d0368335d25b70d3cecbbcea224feb9ac0d6e59 (patch)
tree02940762dd4079bdd0a7d857443cef1527330118 /examples/quick/accessibility
parent669ba098e44080991e0d17827622ecb8928650df (diff)
Flesh out examples documentation
Change-Id: I4f7a1ce6b9957f43e442947dc6b319e919ec9cf7 Reviewed-by: Yann Bodson <yann.bodson@nokia.com>
Diffstat (limited to 'examples/quick/accessibility')
-rw-r--r--examples/quick/accessibility/accessibility.qml9
-rw-r--r--examples/quick/accessibility/content/Button.qml2
2 files changed, 11 insertions, 0 deletions
diff --git a/examples/quick/accessibility/accessibility.qml b/examples/quick/accessibility/accessibility.qml
index 5e4b0f8dcd..b8e929e007 100644
--- a/examples/quick/accessibility/accessibility.qml
+++ b/examples/quick/accessibility/accessibility.qml
@@ -47,6 +47,13 @@ import "content"
\example quick/accessibility
\brief This example has accessible buttons.
+ Elements in this example are augmented with meta-data for accessiblity systems.
+
+ For example, the button identifies itself and its functionality to the accessibility system:
+ \snippet examples/quick/accessibility/content/Button.qml button
+
+ As do Text elements inside the example:
+ \snippet examples/quick/accessibility/accessibility.qml text
*/
Rectangle {
@@ -74,8 +81,10 @@ Rectangle {
height: column.h
Text {
id: subjectLabel
+ //! [text]
Accessible.role: Accessible.StaticText
Accessible.name: text
+ //! [text]
text: "Subject:"
}
Rectangle {
diff --git a/examples/quick/accessibility/content/Button.qml b/examples/quick/accessibility/content/Button.qml
index 3d5086f741..f9eb5b4fab 100644
--- a/examples/quick/accessibility/content/Button.qml
+++ b/examples/quick/accessibility/content/Button.qml
@@ -46,12 +46,14 @@ Rectangle {
property bool checked: false
property alias text : buttonText.text
+ //! [button]
Accessible.name: text
Accessible.description: "This button does " + text
Accessible.role: Accessible.Button
function accessiblePressAction() {
button.clicked()
}
+ //! [button]
signal clicked