Qt wiki will be updated on October 12th 2023 starting at 11:30 AM (EEST) and the maintenance will last around 2-3 hours. During the maintenance the site will be unavailable.
Qt Quick Tutorial Basics
[toc align_right="yes" depth="3"]
English ["French":http://qt-devnet.developpez.com/tutoriels/qt-quick/tutoriel/module-1/bases/]
Qt Quick Tutorial: Module 1 - Basics
Components and Properties
No, we won't start with a QML program printing "Hello world!". We'll start with something much more exciting: a QML program that draws a blue rectangle of 300x300 pixels.
<br />// File: BasicSteps_1.qml
import QtQuick 1.0
Rectangle {<br /> width: 300<br /> height: 300<br /> color: "blue&quot;<br />}<br />
We run QML viewer to see the result of our work:
> qmlviewer BasicSteps_1.qml &amp;<code>
Yes, the above QML code, indeed, produces a blue rectangle. A self-contained piece of QML code as the one above is called a '''QML document''' (see also "QML Documents&quot;:http://doc.qt.nokia.com/4.7-snapshot/qdeclarativedocuments.html). A QML document is a piece of QML code that contains at least one <code&gt;import&lt;/code&gt; statement and exactly one top-level component. In our example, <code&gt;Rectangle&lt;/code&gt; is the single top-level component. Generally, a QML document corresponds to a file, but it could also be text stored in a string or a URL pointing to QML document stored on a remote server.
The statement <code&gt;import Qt 4.7&lt;/code&gt; makes all the QML components of Qt 4.7 available to our QML document. Qt 4.7 comes with built-in components like Rectangle, Text, ListView, WebView, Flipable, Animation and many more (see "QML Elements&quot;:http://doc.qt.nokia.com/4.7-snapshot/qdeclarativeelements.html for a complete list).
'''Components''' are the QML equivalents of C++ classes. They have properties, methods (member functions), signals and slots. The occurrence of <code&gt;Rectangle&lt;/code&gt; in lines 5-9 is an instance of a <code&gt;Rectangle&lt;/code&gt; component: a blue 300x300 pixel instance of a <code&gt;Rectangle&lt;/code&gt; component. In the Qt documentation, '''element''' is often used as a synonym for component. Components with a visual representation like a Rectangle or Text are called '''items'''. Component names always start with an uppercase letter followed by zero or more letters, digits and underscores.
An instance of a component is characterized by its '''properties''', which are name-value pairs. The <code&gt;Rectangle&lt;/code&gt; instance above has three properties <code&gt;width&lt;/code&gt;, <code&gt;height&lt;/code&gt; and <code&gt;color&lt;/code&gt; with the values <code&gt;300&lt;/code&gt;, <code&gt;300&lt;/code&gt; and <code&gt;blue&lt;/code&gt;, respectively. Property names always start with a lowercase letter followed by zero or more letters, digits and underscores. Properties are type-safe, however, the line
width: "Oslo"
would be illegal, because the <code>width</code> property expects a number of type real. QML supports the following basic types: bool, color, date, font, int, list, point, real, rect, size, string, time, url.
Several properties can be written in one line separated by semicolon:
<br />width: 300; height: 300<br />color: "blue&quot;<br />
The order of properties is irrelevant. We could rewrite the <code>Rectangle</code> as
<br />Rectangle {<br /> color: "blue&quot;<br /> height: 300<br /> width: 300<br />}<br />
and the result would be the same.
Comments are marked in QML in the same way as in C++. Comments to the end of the line start with <code>//</code>. Line 1 of our example contains such a comment. Multi-line comments start with <code>/*</code> and end with <code>/</code>.
h2. Composition of Components
The excitement about our blue rectangle is wearing off by now, isn't it? So, let us turn the blue rectangle into a photo frame with a photo in the center, a title below the photo and a cornsilk colored frame. We position a QML <code>Image</code> component for the photo and a <code>Text</code> component for the title on the <code>Rectangle</code> component and change the color of the rectangle into the RGB value <code>#FFF8DC</code> for cornsilk.
<br />// File: BasicSteps_2.qml<br />import QtQuick 1.0
<br />Rectangle {<br /> width: 300<br /> height: 300<br /> color: "#FFF8DC&quot; // cornsilk
<br /> Image {<br /> x: 10; y: 45<br /> source: "voringsfossen1.jpg&quot;<br /> }
<br /> Text {<br /> x: 10; y: 265<br /> text: "Voringsfossen&quot;<br /> }<br />}<br />
The <code>Image</code> component is a child of the <code>Rectangle</code> and is located at x-position 10 and y-position 45 relative to the <code>Rectangle</code>'s origin (10 pixels to the right and 45 pixels down from the top left corner of the rectangle). As the image is 280x210 pixels, this position centers the image horizontally and vertically within the rectangle. The <code>source</code> property tells the QML runtime where to look for the image, which is stored in the file <code>"voringsfossen1.jpg"</code>. The image file is located in the same directory as the QML file <code>BasicSteps.qml</code>. In general, the <code>source</code> property takes a URL. The image could be located anywhere in the Internet or our local file system.
The <code>Text</code> is positioned at 10 pixels to the right and 265 pixels down from the top left corner of the rectangle. The displayed text is "Voringsfossen", which is the name of Norway's most famous and highest waterfall. Again, <code>Text</code> is a child of <code>Rectangle</code> .
This simple example of a photo frame shows how to compose basic components into a more complex components. The components or strictly speaking the component instances are arranged in a tree. In our example, the <code>Rectangle</code> is the root of the tree and <code>Image</code> and <code>Text</code> are the root's children. The children could again have children of their own and so on. These instance trees mirror the instance trees of Qt's graphics items or widgets.
The result won't win us a design prize, but it is a good first shot. Let us improve it step by step. As the title shouldn't look crammed into the frame below the photo, we move the photo 20 pixels up. We just change <code>Image</code>'s property <code>y</code> to <code>25</code>.
<br /> Image {<br /> x: 10; y: 25<br /> source: "voringsfossen1.jpg&quot;<br /> }<br />
We want the title to be a bit bigger - say 20 pixels (line 4) - and want it to be centered both horizontally (line 5) and vertically (line 6) in the area below the photo.
<br /> Text {<br /> x: 0; y: 235<br /> text: "Voringsfossen&quot;<br /> font.pixelSize: 20<br /> width: 300; horizontalAlignment: Text.AlignHCenter<br /> height: 65; verticalAlignment: Text.AlignVCenter<br /> }<br />
It is important to note that the property <code>horizontalAlignment</code> only has an effect if a width is specified. Without a width, the QML runtime wouldn't know where to position the text (just try it out). The same is true for the property <code>verticalAlignment</code>. So, whenever we use <code>horizontalAlignment</code> and <code>verticalAlignment</code>, we must give <code>width</code> and <code>height</code>, respectively.
h2. Custom Properties
Before we create our own properties, we create a real need for them. Our next goal is to show three photos side by side. We achieve this by simply instantiating the photo from <code>BasicSteps_2.qml</code> three times and by enclosing these three rectangles by a big rectangle (see BasicSteps_3.qml for the complete source code).
<br />// File: BasicSteps_3.qml<br />import QtQuick 1.0
<br />Rectangle {<br /> width: 3''' 300; height: 300
// Photo 1<br /> Rectangle {<br /> x: 0; y: 0<br /> …<br /> }
// Photo 2<br /> Rectangle {<br /> x: 300; y: 0<br /> …<br /> }
// Photo 3<br /> Rectangle {<br /> x: 2 * 300; y: 0<br /> …<br /> }<br />}<br />
Photo 1, 2 and 3 are identical copies of the <code>Rectangle</code> from <code>BasicSteps_2.qml</code> - except for the properties <code>x</code> and <code>y</code>. The position of the photo rectangles are relative to the enclosing rectangle, which has three times the width of a single photo rectangle and the same height. The photos are placed at the x-positions 0, 300 and 600 and at y-position 0 such that they appear side by side. As we see in lines 5 and 21, we can use arbitrary JavaScript expressions for the property values. In the example, we use the expressions <code>3 * 300</code> and <code>2 * 300</code>.
With these changes, we see the same photo three times. By changing the properties <code>source</code> and <code>text</code>, we can easily change the image and the title of the photos.
The code isn't well written and smells of heavy code duplication. We'll fix the duplication from the three almost identical photo rectangles in the next module Components. We'll fix the duplication from the magical numbers like 300, 25, 65 or 20 right way - by introducing properties.
The worst offender is the magic number 300, which occurs 13 times. So, if we want to change the size of our photo frames to, say, 400, we must perform 13 changes - and will typically forget to change at least one occurrence. The solution is to introduce a property <code>frameSize</code> at the beginning of the big rectangle and replace every occurrence of 300 by <code>frameSize</code>. Similarly, we eliminate the magic numbers 10, 25 and 65 by introducing the properties <code>leftMargin</code>, <code>topMargin</code> and <code>bottomMargin</code>, respectively, and by replacing every occurrence of these magic numbers by its properties. We also spot that <code>235 = 300 - 65 = frameSize - bottomMargin</code> and replace every occurrence of 235 by the expression <code>frameSize - bottomMargin</code>. While we are on a roll, we also replace the RGB value <code>"#FFF8DC"</code> by the property <code>frameColor</code>. After all these modifications, the code for the enclosing rectangle and photo 3 looks as follows (see BasicSteps_4.qml for the complete code):
<br />Rectangle {<br /> property int frameSize: 300<br /> property int leftMargin: 10<br /> property int topMargin: 25<br /> property int bottomMargin: 65<br /> property int fontSize: 20<br /> property color frameColor: "#FFF8DC&quot; // cornsilk
width: 3 * frameSize; height: frameSize
…
// Photo 3<br /> Rectangle {<br /> x: 2 * frameSize; y: 0<br /> width: frameSize; height: frameSize<br /> color: frameColor
Image {<br /> x: leftMargin; y: topMargin<br /> source: "cotton_grass.jpg&quot;<br /> }
Text {<br /> x: 0; y: frameSize - bottomMargin<br /> text: "Cotton Grass&quot;<br /> font.pixelSize: fontSize<br /> width: frameSize; horizontalAlignment: Text.AlignHCenter<br /> height: bottomMargin; verticalAlignment: Text.AlignVCenter<br /> }<br /> }<br />
The general syntax for a custom property is
<br /> property <type&gt; <name&gt;[: <value&gt;]<br />
The <code>property</code> keyword is followed by the name of the type, <code><type&#62;</code>, and the name of the property, <code><name&#62;</code>. The default value, <code><value&#62;</code>, for the property is optional. For example, the line
<br /> property int frameSize: 300<br />
defines a property with name <code>frameSize</code>, which is of integer type and which has the default value 300.
So far, we've glossed over the scoping rules for properties, because they worked as expected. The properties of a parent instance are accessible by the child instances, the grandchild instances and so on all the way down the instance tree. This is why, for example, the <code>leftMargin</code> property can be used in the grandchild <code>Image</code> of the outermost <code>Rectangle</code>, where it is defined. For the moment, we can live with this scoping rule, which we'll amend when needed.
"Module 2 - Components":http://developer.qt.nokia.com/wiki/Qt_Quick_Tutorial_Components
"Tutorial Main Page":http://developer.qt.nokia.com/wiki/Qt_Quick_Tutorial