src/quick/doc/src/concepts/positioning/anchors.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:FDL$
   9 ** GNU Free Documentation License
  10 ** Alternatively, this file may be used under the terms of the GNU Free
  11 ** Documentation License version 1.3 as published by the Free Software
  12 ** Foundation and appearing in the file included in the packaging of
  13 ** this file.
  14 **
  15 ** Other Usage
  16 ** Alternatively, this file may be used in accordance with the terms
  17 ** and conditions contained in a signed written agreement between you
  18 ** and Nokia.
  19 **
  20 **
  21 **
  22 **
  23 **
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27
  28 /*!
  29 \page qtquick-positioning-anchors.html
  30 \title Positioning with Anchors
  31 \brief placing items with anchor properties
  32
  33 \target anchor-layout
  34 In addition to the more traditional \l Grid, \l Row, and \l Column,
  35 Qt Quick also provides a way to layout items using the concept of \e anchors.
  36 Each item can be thought of as having a set of 7 invisible "anchor lines":
  37 \l {Item::anchors.left}{left}, \l {Item::anchors.horizontalCenter}{horizontalCenter},
  38 \l {Item::anchors.right}{right}, \l {Item::anchors.top}{top},
  39 \l {Item::anchors.verticalCenter}{verticalCenter}, \l {Item::anchors.baseline}{baseline},
  40 and \l {Item::anchors.bottom}{bottom}.
  41
  42 \image edges_qml.png
  43
  44 The baseline (not pictured above) corresponds to the imaginary line on which
  45 text would sit. For items with no text it is the same as \e top.
  46
  47 The Qt Quick anchoring system allows you to define relationships between the anchor lines of different items. For example, you can write:
  48
  49 \code
  50 Rectangle { id: rect1; ... }
  51 Rectangle { id: rect2; anchors.left: rect1.right; ... }
  52 \endcode
  53
  54 In this case, the left edge of \e rect2 is bound to the right edge of \e rect1, producing the following:
  55
  56 \image edge1.png
  57
  58
  59 You can specify multiple anchors. For example:
  60
  61 \code
  62 Rectangle { id: rect1; ... }
  63 Rectangle { id: rect2; anchors.left: rect1.right; anchors.top: rect1.bottom; ... }
  64 \endcode
  65
  66 \image edge3.png
  67
  68 By specifying multiple horizontal or vertical anchors you can control the size of an item. Below,
  69 \e rect2 is anchored to the right of \e rect1 and the left of \e rect3. If either of the blue
  70 rectangles are moved, \e rect2 will stretch and shrink as necessary:
  71
  72 \code
  73 Rectangle { id: rect1; x: 0; ... }
  74 Rectangle { id: rect2; anchors.left: rect1.right; anchors.right: rect3.left; ... }
  75 Rectangle { id: rect3; x: 150; ... }
  76 \endcode
  77
  78 \image edge4.png
  79
  80 There are also some convenience anchors. anchors.fill is a convenience that is the same as setting the left,right,top and bottom anchors
  81 to the left,right,top and bottom of the target item. anchors.centerIn is another convenience anchor, and is the same as setting the verticalCenter
  82 and horizontalCenter anchors to the verticalCenter and horizontalCenter of the target item.
  83
  84 \section1 Anchor Margins and Offsets
  85
  86 The anchoring system also allows \e margins and \e offsets to be specified for an item's anchors.
  87 Margins specify the amount of empty space to leave to the outside of an item's anchor, while
  88 offsets allow positioning to be manipulated using the center anchor lines.  An item can
  89 specify its anchor margins individually through \l {Item::anchors.leftMargin}{leftMargin},
  90 \l {Item::anchors.rightMargin}{rightMargin}, \l {Item::anchors.topMargin}{topMargin} and
  91 \l {Item::anchors.bottomMargin}{bottomMargin}, or use \l {Item::}{anchors.margins} to
  92 specify the same margin value for all four edges. Anchor offsets are specified using
  93 \l {Item::anchors.horizontalCenterOffset}{horizontalCenterOffset},
  94 \l {Item::anchors.verticalCenterOffset}{verticalCenterOffset} and
  95 \l {Item::anchors.baselineOffset}{baselineOffset}.
  96
  97 \image margins_qml.png
  98
  99 The following example specifies a left margin:
 100
 101 \code
 102 Rectangle { id: rect1; ... }
 103 Rectangle { id: rect2; anchors.left: rect1.right; anchors.leftMargin: 5; ... }
 104 \endcode
 105
 106 In this case, a margin of 5 pixels is reserved to the left of \e rect2, producing the following:
 107
 108 \image edge2.png
 109
 110 \note Anchor margins only apply to anchors; they are \e not a generic means of applying margins to an \l Item.
 111 If an anchor margin is specified for an edge but the item is not anchored to any item on that
 112 edge, the margin is not applied.
 113
 114
 115 \section1 Restrictions
 116
 117 For performance reasons, you can only anchor an item to its siblings and direct parent. For example,
 118 the following anchor is invalid and would produce a warning:
 119
 120 \badcode
 121 Item {
 122     id: group1
 123     Rectangle { id: rect1; ... }
 124 }
 125 Item {
 126     id: group2
 127     Rectangle { id: rect2; anchors.left: rect1.right; ... }    // invalid anchor!
 128 }
 129 \endcode
 130
 131 Also, anchor-based layouts cannot be mixed with absolute positioning. If an item specifies its
 132 \l {Item::}{x} position and also sets \l {Item::}{anchors.left},
 133 or anchors its left and right edges but additionally sets a \l {Item::}{width}, the
 134 result is undefined, as it would not be clear whether the item should use anchoring or absolute
 135 positioning. The same can be said for setting an item's \l {Item::}{y} and \l {Item::}{height}
 136 with \l {Item::}{anchors.top} and \l {Item::}{anchors.bottom}, or setting \l {Item::}{anchors.fill}
 137 as well as \l {Item::}{width} or \l {Item::}{height}. The same applies when using positioners
 138 such as Row and Grid, which may set the item's \l {Item::}{x} and \l {Item::}{y} properties.
 139 If you wish to change from using
 140 anchor-based to absolute positioning, you can clear an anchor value by setting it to \c undefined.
 141
 142 */