doc/src/declarative/righttoleft.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the documentation of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:FDL$
  10 ** GNU Free Documentation License
  11 ** Alternatively, this file may be used under the terms of the GNU Free
  12 ** Documentation License version 1.3 as published by the Free Software
  13 ** Foundation and appearing in the file included in the packaging of
  14 ** this file.
  15 **
  16 ** Other Usage
  17 ** Alternatively, this file may be used in accordance with the terms
  18 ** and conditions contained in a signed written agreement between you
  19 ** and Nokia.
  20 **
  21 **
  22 **
  23 **
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27
  28 /*!
  29 \page qml-righttoleft.html
  30 \title QML Right-to-left User Interfaces
  31
  32 \section1 Overview
  33
  34 This chapter discusses different approaches and options available for implementing right-to-left
  35 language support for Qt Quick applications. Some common right-to-left languages include Arabic, Hebrew,
  36 Persian and Urdu. Most changes include making sure that text translated to right-to-left languages
  37 is properly aligned to the right, and horizontally ordered content in views, lists and grids flows
  38 correctly from the right to left.
  39
  40 In right-to-left language speaking cultures, people naturally scan and read graphic elements and text
  41 from the right to left. The general rule of thumb is that content (like photos, videos and maps) is not
  42 mirrored, but positioning of the content (like application layouts and the flow of visual elements) is
  43 mirrored. For example, photos shown in chronological order should flow from right to left, the
  44 low end range of the horizontal sliders should be located at the right side of the slider, and
  45 text lines should should be aligned to the right side of the available text area. The location of visual
  46 elements should not be mirrored when the position is related to a content; for example, when a
  47 position marker is shown to indicate a location on a map. Also, there are some special cases you may
  48 need to take into account where right-to-left language speakers are used to left-to-right
  49 positioning, for example when using number dialers in phones and media play, pause, rewind and
  50 forward buttons in music players.
  51
  52 \section1 Text Alignment
  53
  54 (This applies to the \l Text, \l TextInput and \l TextEdit elements.)
  55
  56 When the horizontal alignment of a text item is not explicitly set, the text element is
  57 automatically aligned to the natural reading direction of the text. By default left-to-right text
  58 like English is aligned to the left side of the text area, and right-to-left text like Arabic is
  59 aligned to the right side of the text area. The alignment of a text element with empty text takes
  60 its alignment cue from \l QApplication::keyboardInputDirection(), which is based on the active
  61 system locale.
  62
  63 This default locale-based alignment can be overriden by setting the \c horizontalAlignment
  64 property for the text element, or by enabling layout mirroring using the \l LayoutMirroring attached
  65 property, which causes any explicit left and right horizontal alignments to be mirrored.
  66 Note that when \l LayoutMirroring is set, the \c horizontalAlignment property value remains unchanged;
  67 the effective alignment of the text element that takes the mirroring into account can be read from the
  68 \c effectiveHorizontalAlignment property.
  69
  70 \snippet doc/src/snippets/declarative/righttoleft.qml 0
  71
  72 \section1 Layout direction of positioners and views
  73
  74 (This applies to the \l Row, \l Grid, \l Flow, \l ListView and \l GridView elements.)
  75
  76 From Qt Quick 1.1 onwards, elements used for horizontal positioning and model views have gained a \c layoutDirection
  77 property for controlling the horizontal direction of the layouts. Setting \c layoutDirection to
  78 \c Qt.RightToLeft causes items to be laid out from the right to left. By default Qt Quick follows
  79 the left-to-right layout direction.
  80
  81 The horizontal layout direction can also be reversed through the \l LayoutMirroring attached property.
  82 This causes the effective \c layoutDirection of positioners and views to be mirrored. Note the actual value
  83 of the \c layoutDirection property will remain unchanged; the effective layout direction of positioners and
  84 views that takes the mirroring into account can be read from the \c effectiveLayoutDirection property.
  85
  86 \snippet doc/src/snippets/declarative/righttoleft.qml 1
  87
  88 \section1 Layout mirroring
  89
  90 The attached property \l LayoutMirroring is provided as a convenience for easily implementing right-to-left
  91 support for existing left-to-right Qt Quick applications. It mirrors the behavior of \l {anchor-layout}
  92 {Item anchors}, the layout direction of \l{Using QML Positioner and Repeater Items}{positioners} and
  93 model views, and the explicit text alignment of QML text elements.
  94
  95 You can enable layout mirroring for a particular \l Item:
  96
  97 \snippet doc/src/snippets/declarative/righttoleft.qml 2
  98
  99 Or set all child elements to also inherit the layout direction:
 100
 101 \snippet doc/src/snippets/declarative/righttoleft.qml 3
 102
 103 Applying mirroring in this manner does not change the actual value of the relevant anchor,
 104 \c layoutDirection or \c horizontalAlignment properties. The separate read-only property
 105 \c effectiveLayoutDirection can be used to query the effective layout
 106 direction of positioners and model views that takes the mirroring into account. Similarly the \l Text,
 107 \l TextInput and \l TextEdit elements have gained the read-only property \c effectiveHorizontalAlignment
 108 for querying the effective visual alignment of text. For anchors, the read only
 109 \l {Item::anchors.top}{anchors.mirrored} property reflects whether anchors have been mirrored.
 110
 111 Note that application layouts and animations that are defined using \l {Item::}{x} property values (as
 112 opposed to anchors or positioner elements) are not affected by the \l LayoutMirroring attached property.
 113 Therefore, adding right-to-left support to these types of layouts may require some code changes to your application,
 114 especially in views that rely on both the anchors and x coordinate-based positioning. Here is one way to use
 115 the \l LayoutMirroring attached property to apply mirroring to an item that is positioned using \l {Item::}{x}
 116 coordinates:
 117
 118 \snippet doc/src/snippets/declarative/righttoleft.qml 4
 119
 120 Not all layouts should necessarily be mirrored. There are cases where a visual element is positioned to
 121 the right side of the screen for improved one-handed use, because most people are right-handed, and not
 122 because of the reading direction. In the case that a child element should not be affected by mirroring,
 123 set the \l {LayoutMirroring::enabled}{LayoutMirroring.enabled} property for that element to false.
 124
 125 Qt Quick is designed for developing animated, fluid user interfaces. When mirroring your application, remember to test that
 126 the animations and transitions continue to work as expected. If you do not have the resources to add
 127 right-to-left support for your application, it may be better to just keep the application layouts left
 128 aligned and just make sure that text is translated and aligned properly.
 129
 130 \section1 Mirroring icons
 131
 132 (This applies to \l Image, \l BorderImage and \l AnimatedImage elements.)
 133
 134 Most images do not need to be mirrored, but some directional icons, such as arrows, may need to be mirrored.
 135 The painting of these icons can be mirrored with a dedicated \c mirror property introduced in Qt Quick 1.1:
 136
 137 \snippet doc/src/snippets/declarative/righttoleft.qml 5
 138
 139 \section1 Default layout direction
 140
 141 The \l {QML:Qt::application}{Qt.application.layoutDirection} property can be used to query the active layout direction of the
 142 application. It is based on QApplication::layoutDirection(), which most commonly determines the layout
 143 direction from the active language translation file.
 144
 145 To define the layout direction for a particular locale, declare the dedicated string literal
 146 \c QT_LAYOUT_DIRECTION in context \c QApplication as either "LTR" or "RTL".
 147
 148 You can do this by first introducing this line
 149
 150 \code
 151 QT_TRANSLATE_NOOP("QApplication", "QT_LAYOUT_DIRECTION");
 152 \endcode
 153
 154 somewhere in your QML source code and calling \c lupdate to generate the translation source file.
 155
 156 \code
 157 lupdate myapp.qml -ts myapp.ts
 158 \endcode
 159
 160 This will append the following declaration to the translation file, where you can fill in either "LTR" or
 161 "RTL" as the translation for the locale.
 162
 163 \code
 164 <context>
 165     <name>QApplication</name>
 166     <message>
 167         <location filename="myapp.qml" line="33"/>
 168         <source>QT_LAYOUT_DIRECTION</source>
 169         <translation type="unfinished">RTL</translation>
 170     </message>
 171 </context>
 172 \endcode
 173
 174 You can test that the layout direction works as expected by running your Qt Quick application with
 175 the compiled translation file:
 176
 177 \code
 178 qmlviewer myapp.qml -translation myapp.qm
 179 \endcode
 180
 181 You can test your application in right-to-left layout direction simply by executing qmlviewer with a
 182 command-line parameter "-reverse":
 183
 184 \code
 185 qmlviewer myapp.qml -reverse
 186 \endcode
 187
 188 The layout direction can also be set from C++ by calling the static function \l QApplication::setLayoutDirection():
 189
 190 \code
 191 QApplication app(argc, argv);
 192 app.setLayoutDirection(Qt::RightToLeft);
 193 \endcode
 194
 195 */