<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- layouts.qdoc -->
<title>Use Case - Positioners and Layouts In QML | Qt 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td ><a href="index.html">Qt 5.9</a></td><td >Use Case - Positioners and Layouts In QML</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#manual-positioning">Manual Positioning</a></li>
<li class="level1"><a href="#anchors">Anchors</a></li>
<li class="level1"><a href="#positioners">Positioners</a></li>
<li class="level1"><a href="#layout-types">Layout Types</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Use Case - Positioners and Layouts In QML</h1>
<span class="subtitle"></span>
<!-- $$$qtquick-usecase-layouts.html-description -->
<div class="descr"> <a name="details"></a>
<p>There are several ways to position items in QML.</p>
<p>Below is a brief overview. For more details, see Important Concepts In Qt Quick - Positioning.</p>
<a name="manual-positioning"></a>
<h2 id="manual-positioning">Manual Positioning</h2>
<p>Items can be placed at specific x,y coordinates on the screen by setting their x,y properties. This will setup their position relative to the top left corner of their parent, according to the visual coordinate system rules.</p>
<p>Combined with using bindings instead of constant values for these properties, relative positioning is also easily accomplished by setting the x and y coordinates to the appropriate bindings.</p>
<pre class="qml">
import QtQuick 2.3
<span class="type">Item</span> {
<span class="name">width</span>: <span class="number">100</span>; <span class="name">height</span>: <span class="number">100</span>
<span class="type">Rectangle</span> {
<span class="comment">// Manually positioned at 20,20</span>
<span class="name">x</span>: <span class="number">20</span>
<span class="name">y</span>: <span class="number">20</span>
<span class="name">width</span>: <span class="number">80</span>
<span class="name">height</span>: <span class="number">80</span>
<span class="name">color</span>: <span class="string">"red"</span>
}
}
</pre>
<p class="centerAlign"><img src="images/qml-uses-layouts-direct.png" alt="" /></p><a name="anchors"></a>
<h2 id="anchors">Anchors</h2>
<p>The <code>Item</code> type provides the abilitiy to anchor to other Item types. There are seven anchor lines for each item: <i>left</i>, <i>right</i>, <i>vertical center</i>, <i>top</i>, <i>bottom</i>, <i>baseline</i> and <i>horizontal center</i>. The three vertical anchor lines can be anchored to any of the three vertical anchor lines of another item, and the four horizontal anchor lines can be anchored to the horizontal anchor lines of another item.</p>
<p>For full details, see Positioning with Anchors and the documentation of the anchors property.</p>
<pre class="qml">
import QtQuick 2.3
<span class="type">Item</span> {
<span class="name">width</span>: <span class="number">200</span>; <span class="name">height</span>: <span class="number">200</span>
<span class="type">Rectangle</span> {
<span class="comment">// Anchored to 20px off the top right corner of the parent</span>
<span class="name">anchors</span>.right: <span class="name">parent</span>.<span class="name">right</span>
<span class="name">anchors</span>.top: <span class="name">parent</span>.<span class="name">top</span>
<span class="name">anchors</span>.margins: <span class="number">20</span> <span class="comment">// Sets all margins at once</span>
<span class="name">width</span>: <span class="number">80</span>
<span class="name">height</span>: <span class="number">80</span>
<span class="name">color</span>: <span class="string">"orange"</span>
}
<span class="type">Rectangle</span> {
<span class="comment">// Anchored to 20px off the top center corner of the parent.</span>
<span class="comment">// Notice the different group property syntax for 'anchors' compared to</span>
<span class="comment">// the previous Rectangle. Both are valid.</span>
<span class="type">anchors</span> { <span class="name">horizontalCenter</span>: <span class="name">parent</span>.<span class="name">horizontalCenter</span>; <span class="name">top</span>: <span class="name">parent</span>.<span class="name">top</span>; <span class="name">topMargin</span>: <span class="number">20</span> }
<span class="name">width</span>: <span class="number">80</span>
<span class="name">height</span>: <span class="number">80</span>
<span class="name">color</span>: <span class="string">"green"</span>
}
}
</pre>
<p class="centerAlign"><img src="images/qml-uses-layouts-anchors.png" alt="" /></p><a name="positioners"></a>
<h2 id="positioners">Positioners</h2>
<p>For the common case of wanting to <i>position</i> a set of types in a regular pattern, Qt Quick provides some positioner types. Items placed in a positioner are automatically positioned in some way; for example, a Row positions items to be horizontally adjacent (forming a row).</p>
<p>For full details see Item Positioners and the documentation for the positioner types.</p>
<pre class="qml">
import QtQuick 2.3
<span class="type">Item</span> {
<span class="name">width</span>: <span class="number">300</span>; <span class="name">height</span>: <span class="number">100</span>
<span class="type">Row</span> { <span class="comment">// The "Row" type lays out its child items in a horizontal line</span>
<span class="name">spacing</span>: <span class="number">20</span> <span class="comment">// Places 20px of space between items</span>
<span class="type">Rectangle</span> { <span class="name">width</span>: <span class="number">80</span>; <span class="name">height</span>: <span class="number">80</span>; <span class="name">color</span>: <span class="string">"red"</span> }
<span class="type">Rectangle</span> { <span class="name">width</span>: <span class="number">80</span>; <span class="name">height</span>: <span class="number">80</span>; <span class="name">color</span>: <span class="string">"green"</span> }
<span class="type">Rectangle</span> { <span class="name">width</span>: <span class="number">80</span>; <span class="name">height</span>: <span class="number">80</span>; <span class="name">color</span>: <span class="string">"blue"</span> }
}
}
</pre>
<p class="centerAlign"><img src="images/qml-uses-layouts-positioners.png" alt="" /></p><a name="layout-types"></a>
<h2 id="layout-types">Layout Types</h2>
<p><i>Layout types</i> function in a similar way as positioners but allow further refinement or restrictions to the layout. Specifically, the layout types allow you to:</p>
<ul>
<li>set the alignment of text and other items</li>
<li>resize and fill the allotted application areas automatically</li>
<li>set size constraints such as minimum or maximum dimensions</li>
<li>set the spacing between items within the layout</li>
</ul>
<pre class="qml">
<span class="type">GroupBox</span> {
<span class="name">id</span>: <span class="name">gridBox</span>
<span class="name">title</span>: <span class="string">"Grid layout"</span>
<span class="name">Layout</span>.fillWidth: <span class="number">true</span>
<span class="type">GridLayout</span> {
<span class="name">id</span>: <span class="name">gridLayout</span>
<span class="name">rows</span>: <span class="number">3</span>
<span class="name">flow</span>: <span class="name">GridLayout</span>.<span class="name">TopToBottom</span>
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="type">Label</span> { <span class="name">text</span>: <span class="string">"Line 1"</span> }
<span class="type">Label</span> { <span class="name">text</span>: <span class="string">"Line 2"</span> }
<span class="type">Label</span> { <span class="name">text</span>: <span class="string">"Line 3"</span> }
<span class="type">TextField</span> { }
<span class="type">TextField</span> { }
<span class="type">TextField</span> { }
<span class="type">TextArea</span> {
<span class="name">text</span>: <span class="string">"This widget spans over three rows in the GridLayout.\n"</span>
<span class="operator">+</span> <span class="string">"All items in the GridLayout are implicitly positioned from top to bottom."</span>
<span class="name">Layout</span>.rowSpan: <span class="number">3</span>
<span class="name">Layout</span>.fillHeight: <span class="number">true</span>
<span class="name">Layout</span>.fillWidth: <span class="number">true</span>
}
}
}
</pre>
<p>The snippet above comes from the Basic Layouts example. The snippet shows the simplicity of adding various fields and items in a layout. The GridLayout can be resized and its format are customizable through various properties.</p>
<p>For more information about the layout types, visit:</p>
<ul>
<li>Qt Quick Layouts Overview</li>
<li>Basic Layouts example</li>
</ul>
<p><b>Note: </b>Qt Quick Layouts was introduced in Qt 5.1 and requires Qt Quick 2.1.</p></div>
<!-- @@@qtquick-usecase-layouts.html -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
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> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
