Write Qt Quick 1.1 right-to-left documentation and examples

Task-number: QTBUG-11042
Reviewed-by: Martin Jones

Change-Id: I6319992dec52a4d9252c2df39801ebe6a7dee75d

9 files changed, 390 insertions, 14 deletions

diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc
index aa9ed18..3962514 100644
--- a/doc/src/declarative/declarativeui.qdoc
+++ b/doc/src/declarative/declarativeui.qdoc
@@ -140,6 +140,7 @@ Module.
 \o \l{QML Basic Types}
 \o \l{QML Global Object}
 \o \l{QML Internationalization}
+\o \l{QML Right-to-left User Interfaces}
 \o \l{QML Security}
 \o \l{Qt Declarative Module}
 \o \l{Debugging QML}
diff --git a/doc/src/declarative/examples.qdoc b/doc/src/declarative/examples.qdoc
index be2d0c7..b359877 100644
--- a/doc/src/declarative/examples.qdoc
+++ b/doc/src/declarative/examples.qdoc
@@ -136,8 +136,7 @@ The examples can be found in Qt's \c examples/declarative directory.
 
 \section2 Positioners
 \list
-\o \l{declarative/positioners/addandremove}{Adding and Removing Items}
-\o \l{declarative/positioners/layoutdirection}{Layout Direction}
+\o \l{declarative/positioners}{Example}
 \endlist
 
 \section2 Key Interaction
@@ -198,13 +197,20 @@ The examples can be found in Qt's \c examples/declarative directory.
 \o \l{declarative/i18n}{Example}
 \endlist
 
+\section2 Right-to-left User Interfaces
+\list
+\o \l{declarative/righttoleft/layoutmirroring}{Layout mirroring}
+\o \l{declarative/righttoleft/layoutdirection}{Layout direction}
+\o \l{declarative/righttoleft/textalignment}{Text alignment}
+\endlist
+
 \section2 Threading
 \list
 \o \l{declarative/threading/threadedlistmodel}{Threaded ListModel}
 \o \l{declarative/threading/workerscript}{WorkerScript}
 \endlist
 
-\section2 Screen orientation
+\section2 Screen Orientation
 \list
 \o \l{declarative/screenorientation}{Example}
 \endlist
diff --git a/doc/src/declarative/righttoleft.qdoc b/doc/src/declarative/righttoleft.qdoc
new file mode 100644
index 0000000..710855d
--- /dev/null
+++ b/doc/src/declarative/righttoleft.qdoc
@@ -0,0 +1,186 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of this
+** file.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\page qml-righttoleft.html
+\target righttoleft
+\title QML Right-to-left User Interfaces
+
+\section1 Overview
+
+This chapter discusses different approaches and options available for implementing right-to-left
+language support for Qt Quick applications. Some common right-to-left languages include Arabic, Hebrew,
+Persian and Urdu. Most changes include making sure that text translated to right-to-left languages
+is properly aligned to the right, and horizontally ordered content in views, lists and grids flows
+correctly from the right to left.
+
+In right-to-left language speaking cultures, people naturally scan and read graphic elements and text
+from the right to left. General rule of thumb is that the content like photos, videos, maps is not
+mirrored, but positioning of the content is, like application layouts and the flow of visual elements.
+Common use cases include photos shown in chronological order should flow right-to-left, the
+low end range of the horizontal sliders should be located at the right side of the slider, and the
+text lines should should be aligned to the right side of the available area. The location of visual
+elements should not be mirrored when the position is related to a content, for example when a
+position marker is shown to indicate a location on a map. Also, there are some special cases you may
+need to take into account where the right-to-left language speakers are used to the left-to-right
+positioning, for example when using number dialers in phones and media play, pause, rewind and
+forward buttons in music players.
+
+\section1 Text Alignment
+
+Applies to \l Text, \l TextInput and \l TextEdit.
+
+When the horizontal alignment of the text item is not explicitly set, the text element will be
+automatically aligned to the natural reading direction of the text. By default left-to-right text
+like English is aligned to the left side of the text area, and right-to-left text like Arabic is
+aligned to the right side of the text area. The alignment of a text element with empty text takes
+it's alignment cue from \l QApplication::keyboardInputDirection(), which is based on the active
+system locale. Explicitly setting property \c horizontalAlignment for the text will override any
+implicit locale-based alignment. Enabling layout mirroring using attached property
+\l LayoutMirroring causes any explicit left and right horizontal alignments to be mirrored.
+Note that \c horizontalAlignment property itself will remain unchanged. The effective alignment of
+the text element that takes the mirroring into account can be read from the
+\c effectiveHorizontalAlignment property.
+
+\snippet doc/src/snippets/declarative/righttoleft.qml 0
+
+\section1 Layout direction of positioners and views
+
+Applies to \l Row, \l Grid, \l Flow, \l ListView and \l GridView
+
+From Qt Quick 1.1 onwards horizontal positioners and model views have gained a \c layoutDirection
+property for controlling the horizontal direction of the layouts. Setting \c layoutDirection to
+\c Qt.RightToLeft causes items to be laid out from the right to left. By default Qt Quick follows
+the left-to-right layout direction.
+
+Enabling application layout mirroring using attached property \c LayoutMirroring causes the effective
+\c layoutDirection of positioners and views to be mirrored. Note that actual value of \c layoutDirection
+property will remain unchanged. The effective layout direction of positioners and views that takes the mirroring into account can be read from the \c effectiveLayoutDirection property.
+
+\snippet doc/src/snippets/declarative/righttoleft.qml 1
+
+\section1 Layout mirroring
+
+Attached property \l LayoutMirroring is provided as a convenience for easily implementing right-to-left
+support for existing left-to-right Qt Quick applications. It mirrors the behavior of \l {anchor-layout}
+{Item anchors}, the layout direction of \l{Using QML Positioner and Repeater Items}{positioners} and
+model views and the explicit text alignment of QML text elements.
+
+You can enable layout mirroring for a particular Item
+
+\snippet doc/src/snippets/declarative/righttoleft.qml 2
+
+or make all children elements also inherit the layout direction
+
+\snippet doc/src/snippets/declarative/righttoleft.qml 3
+
+Mirroring does not change the return value of the layout direction and horizontal alignment properties.
+Separate read-only property \c effectiveLayoutDirection can be used to query the effective layout
+direction of positioners and model views that takes the mirroring into account. Similarly \c Text,
+\c TextInput and \c TextEdit elements have gained read-only property \c effectiveHorizontalAlignment
+for querying what is the effective visual alignment of text.
+
+\c LayoutMirroring doesn't alter application layouts and animations done by using the \l x coordinate
+directly. Adding right-to-left support to those layouts requires some code changes to your application,
+especially in views that rely on both the anchors and x coordinate-based positioning.
+
+\snippet doc/src/snippets/declarative/righttoleft.qml 4
+
+Not all the layouts should be mirrored. There are cases where the visual element is positioned to
+the right side of the screen for better one-handed use, because most people are right-handed, and not
+because of the reading direction. In the case that a child element needs to be unaffected by the mirroring, set the \c LayoutMirroring.enabled property for that element to false. Qt Quick is designed
+for developing animated, fluid user interfaces. When mirroring your application, remember to test that
+the animations and transitions continue to work as expected. If you don't have resources to add
+right-to-left support for your application, it may be better to just keep the application layouts left
+aligned and just make sure that text is translated and aligned properly.
+
+\section1 Mirroring icons
+
+Applies to \l Image, \l BorderImage, \l AnimatedImage
+
+Most images don't need mirroring, but some directional icons should be mirrored. You can mirror the
+painting of these icons with a dedicated \l mirror property introduced in Qt Quick 1.1.
+
+\snippet doc/src/snippets/declarative/righttoleft.qml 5
+
+\section1 Default layout direction
+
+Property \l Qt.application.layoutDirection can be used to query the active layout direction of the
+application. It is based on QApplication::layoutDirection(), which most commonly determines the layout
+direction from the active language translation file.
+
+To define the layout direction for a particular locale, declare the dedicated string literal
+\c QT_LAYOUT_DIRECTION in context \c QApplication as either "LTR" or "RTL".
+
+You can do this by first introducing line
+
+\code
+QT_TRANSLATE_NOOP("QApplication", "QT_LAYOUT_DIRECTION");
+\endcode
+
+somewhere in your QML source code and calling \c lupdate to generate the translation source file.
+
+\code
+lupdate myapp.qml -ts myapp.ts
+\endcode
+
+This will append following declaration to the translation file, where you can fill either "LTR" or
+"RTL" as the translation for the locale.
+
+\code
+<context>
+    <name>QApplication</name>
+    <message>
+        <location filename="myapp.qml" line="33"/>
+        <source>QT_LAYOUT_DIRECTION</source>
+        <translation type="unfinished">RTL</translation>
+    </message>
+</context>
+\endcode
+
+You can test that the layout direction works as expected by running your Qt Quick application with
+the compiled translation file.
+
+\code
+qmlviewer myapp.qml -translation myapp.qm
+\endcode
+
+You can test your application in right-to-left layout direction simply by executing qmlviewer with a
+command-line parameter "-reverse".
+
+\code
+qmlviewer myapp.qml -reverse
+\endcode
+
+Layout direction can also be set from C++ by calling static function \l QApplication::setLayoutDirection().
+
+\code
+QApplication app(argc, argv);
+app.setLayoutDirection(Qt::RightToLeft);
+\endcode
+
+*/
diff --git a/doc/src/examples/qml-examples.qdoc b/doc/src/examples/qml-examples.qdoc
index bbea19b..8f34a9f 100644
--- a/doc/src/examples/qml-examples.qdoc
+++ b/doc/src/examples/qml-examples.qdoc
@@ -270,23 +270,49 @@
 */
 
 /*!
-    \title Positioners: Adding and Removing Items Example
-    \example declarative/positioners/addandremove
+    \title Right-to-left User Interfaces: Text Alignment Example
+    \example declarative/righttoleft/textalignment
 
-    This example shows how to use the positioner elements such as \l Row, \l Column,
-    \l Grid and \l Flow, in particular how to add and remove items with appropriate transitions.
-
-    \image qml-positioners-example.png
+    This example shows how the horizontal alignment of \l Text,
+    \l TextInput and \l TextEdit is affected by the reading direction
+    of the text and by the layout mirrroring. Click on the gray buttons
+    shown at the bottom of the example to toggle between different
+    horizontal alignment options.
 */
 
 /*!
-    \title Positioners: Layout Direction Example
-    \example declarative/positioners/layoutdirection
+    \title Right-to-left User Interfaces: Layout Direction Example
+    \example declarative/righttoleft/layoutdirection
 
     This example shows how to control the horizontal layout direction of 
-    \l Row, \l Grid and \l Flow positioners.
+    \l Row, \l Grid and \l Flow positioners, and \l ListView and \l GridView
+    model views. Click on the gray buttons shown at the bottom of the example
+    to toggle the layout direction of the shown elements.
+
+    \image qml-righttoleft-layoutdirection-example.png
+*/
+
+
+/*!
+    \title Right-to-left User Interfaces: Layout Mirroring Example
+    \example declarative/righttoleft/layoutmirroring
 
-    \image qml-positioners-layoutdirection-example.png
+    This example shows how to mirror the application layouts
+    using \l LayoutMirroring attached property. Click on the grey button
+    shown at the bottom of the example to enable or disable the
+    layout mirroring.
+
+    \image qml-righttoleft-layoutmirroring-example.png
+*/
+
+/*!
+    \title Positioners Example
+    \example declarative/positioners
+
+    This example shows how to use the positioner elements such as \l Row, \l Column,
+    \l Grid and \l Flow.
+
+    \image qml-positioners-example.png
 */
 
 /*!
@@ -456,7 +482,7 @@
 
 
 /*!
-    \title Screen orientation
+    \title Screen Orientation
     \example declarative/screenorientation
 
     This example shows how to implement screen orientation support for your application.
diff --git a/doc/src/images/qml-righttoleft-layoutdirection-example.png b/doc/src/images/qml-righttoleft-layoutdirection-example.png
new file mode 100644
index 0000000..e8dd85c
--- /dev/null
+++ b/doc/src/images/qml-righttoleft-layoutdirection-example.png
diff --git a/doc/src/images/qml-righttoleft-layoutmirroring-example.png b/doc/src/images/qml-righttoleft-layoutmirroring-example.png
new file mode 100644
index 0000000..2fa82ac
--- /dev/null
+++ b/doc/src/images/qml-righttoleft-layoutmirroring-example.png
diff --git a/doc/src/snippets/declarative/arrow.png b/doc/src/snippets/declarative/arrow.png
new file mode 100644
index 0000000..f0cae21
--- /dev/null
+++ b/doc/src/snippets/declarative/arrow.png
diff --git a/doc/src/snippets/declarative/righttoleft.qml b/doc/src/snippets/declarative/righttoleft.qml
new file mode 100644
index 0000000..5d34f50
--- /dev/null
+++ b/doc/src/snippets/declarative/righttoleft.qml
@@ -0,0 +1,146 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
+**     the names of its contributors may be used to endorse or promote
+**     products derived from this software without specific prior written
+**     permission.
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 1.1
+import "righttoleft"
+
+Column {
+    width: 200
+//![0]
+// aligned to the left
+Text {
+    text: "Phone"
+    width: 200
+}
+
+// aligned to the right
+Text {
+    text: "خامل"
+    width: 200
+}
+
+// aligned to the left
+Text {
+    text: "خامل"
+    horizontalAlignment: Text.AlignLeft
+    width: 200
+}
+
+// aligned to the right
+Text {
+    text: "خامل"
+    horizontalAlignment: Text.AlignLeft
+    LayoutMirroring.enabled: true
+    width: 200
+}
+//![0]
+
+//![1]
+// by default positions child items from the left to right
+Row {
+    Child {}
+    Child {}
+}
+
+// positions child items from the right to left
+Row {
+    layoutDirection: Qt.RightToLeft
+    Child {}
+    Child {}
+}
+
+// positions child items from the left to right
+Row {
+    LayoutMirroring.enabled: true
+    layoutDirection: Qt.RightToLeft
+    Child {}
+    Child {}
+}
+//![1]
+
+//![2]
+Item {
+    // anchor left becomes right
+    height: 50; width: 150
+    LayoutMirroring.enabled: true
+    anchors.left: parent.left
+    Row {
+        // flows from the left to right
+        Child {}
+        Child {}
+        Child {}
+    }
+}
+//![2]
+
+//![3]
+Item {
+    // anchor left becomes right
+    height: 50; width: 150
+    LayoutMirroring.enabled: true
+    LayoutMirroring.childrenInherit: true
+    anchors.left: parent.left
+    Row {
+        // flows from the right to left
+        Child {}
+        Child {}
+        Child {}
+    }
+}
+//![3]
+
+//![4]
+Rectangle {
+    color: "black"
+    height: 50; width: 50
+    x: mirror(10)
+    function mirror(value) {
+        return LayoutMirroring.enabled ? (parent.width - width - value) : value;
+    }
+}
+//![4]
+
+//![5]
+Image {
+    source: "arrow.png"
+    mirror: true
+}
+//![5]
+}
\ No newline at end of file
diff --git a/doc/src/snippets/declarative/righttoleft/Child.qml b/doc/src/snippets/declarative/righttoleft/Child.qml
new file mode 100644
index 0000000..2b3564e
--- /dev/null
+++ b/doc/src/snippets/declarative/righttoleft/Child.qml
@@ -0,0 +1,11 @@
+import QtQuick 1.0
+
+Rectangle {
+    width: 50; height: 50
+    color: "black"
+    Text {
+        color: "white"
+        text: String.fromCharCode(65 + Math.floor(26*Math.random()))
+        anchors.centerIn: parent
+    }
+}
\ No newline at end of file