Basic Qt Programming Tutorial

[toc align_right="yes" depth="2"]

English 简体中文 فارسی Türkçe Español

Introduction

This tutorial will explain in detail how to take your first steps in programming with Qt using the Qt Creator integrated development environment (IDE).

If you want to learn how to make powerful GUIs with all the latest fancy technologies, this is not the tutorial for you. This is firmly intended as a gentle introduction to help beginners get up and running without scaring them.

We will begin by creating a new Qt-based project and modifying the generated code to show a very simple graphical user interface (GUI). Once our basic application project is in place and running, we will go back and modify it to do some slightly useful things.

We will start off simple and build up in complexity as you get more familiar with the widgets and other facilities at your disposal.

So, grab yourself a copy of the Qt SDK or if you are on Linux the system-provided copy of Qt and a compiler and let's get started!

Baby steps: Creating a new project

Let's try making a trivial application that has a single window that shows a QLabel and a QLineEdit. To do this follow these simple steps:

1. Start up Qt Creator.
   "Start Qt-Creator":http://gallery.theharmers.co.uk/picture.php?/22/category/7
2. Go to File->"New File or Project…" menu entry.
3. Choose Qt Gui Application and choose a name for it.
   "Select project type":http://gallery.theharmers.co.uk/picture.php?/23/category/7
4. Enter a project name, "qt-tutorial-01", say.
   "Choose project name":http://gallery.theharmers.co.uk/picture.php?/24/category/7
5. Select one or more versions of Qt to target. A desktop build is fine for this tutorial.
   "Choose Qt build to target":http://gallery.theharmers.co.uk/picture.php?/25/category/7
6. Select the base class to be QWidget (leave the class name as Widget which is the default).
   "Select project generation options":http://gallery.theharmers.co.uk/picture.php?/26/category/7
7. Check project creation options on summary and click "Finish".
   "Check project summary":http://gallery.theharmers.co.uk/picture.php?/27/category/7

The above will create you a simple project consisting of four files:

• main.cpp
• widget.h
• widget.cpp
• widget.ui

Learning to crawl: Editing the project files

We will edit the widget.ui file first so:

1. Click on that and designer will switch to design mode and open up the file. You should see a blank widget. Now do this:
   "Open designer":http://gallery.theharmers.co.uk/picture.php?/28/category/7
2. Using the toolbox on the left, drag a Label onto the widget form
   "Add label":http://gallery.theharmers.co.uk/picture.php?/29/category/7
3. Do similarly for a Line Edit and place it to the right of the Label. The exact position is not important.
   "Add line edit":http://gallery.theharmers.co.uk/picture.php?/30/category/7
4. Click on the widget background so that both of your new widgets (the label and line edit) get deselected.
   "Select parent widget":http://gallery.theharmers.co.uk/picture.php?/31/category/7
5. In the toolbar at the top click on the "Lay out Horizontally" button or press Ctrl-H to add all widgets to a horizontal layout. The layout will take care of resizing your widgets for you if the parent widget's size changes.
   "Apply horizontal layout":http://gallery.theharmers.co.uk/picture.php?/32/category/7
6. Double click on the Label and it will switch to edit mode. Change the text to "My name is:"
   "Change label text":http://gallery.theharmers.co.uk/picture.php?/33/category/7
7. Press Ctrl-S to save the form.
8. Click on the Edit mode button in the left hand panel of creator to switch back to the text editor. You will probably see the raw xml content of the UI file at this point. Just close it we are done with it for now.
   "Switch to Edit mode":http://gallery.theharmers.co.uk/picture.php?/34/category/7

Now open up the widget.h file and edit it so that it looks like this:

<br />#ifndef WIDGET_H<br />#define WIDGET_H

#include &lt;QWidget&amp;gt;

namespace Ui {<br /> class Widget;<br />}

class Widget : public QWidget<br />{<br /> Q_OBJECT

public:<br /> explicit Widget(QWidget *parent = 0);<br /> ~Widget();

void setName(const QString &amp;name);<br /> QString name() const;

private:<br /> Ui::Widget *ui;<br />};

#endif // WIDGET_H<br />

Now edit the corresponding .cpp file to look like this:

<br />#include &quot;widget.h&amp;quot;<br />#include &quot;ui_widget.h&amp;quot;

Widget::Widget(QWidget *parent) :<br /> QWidget(parent),<br /> ui(new Ui::Widget)<br />{<br /> ui-&gt;setupUi(this);<br />}

Widget::~Widget()<br />{<br /> delete ui;<br />}

void Widget::setName(const QString &amp;name)<br />{<br /> ui-&gt;lineEdit-&gt;setText(name);<br />}

QString Widget::name() const<br />{<br /> return ui-&gt;lineEdit-&gt;text();<br />}<br />

Finally edit main.cpp to this:

<br />#include &lt;QApplication&amp;gt;<br />#include &quot;widget.h&amp;quot;

int main(int argc, char '''argv[])<br />{<br /> QApplication a(argc, argv);<br /> Widget w;
<br /> w.setName(&quot;Slim Shady&amp;quot;);
<br /> w.show();
<br /> return a.exec&amp;amp;#40;&amp;#41;;<br />}<br />

h2. Up and running: Building and running the application
Now build (Hammer icon in lower left or default shortcut of Ctrl-Shift-B) and run the application (green "play" icon in lower left corner). You will see some compiler messages go past in the "Compile Output" panel at the bottom whilst building.
"Compiling the project":http://gallery.theharmers.co.uk/picture.php?/35/category/7
This is what the application looks like when it is executed:
"The running application":http://gallery.theharmers.co.uk/picture.php?/36/category/7
As you can see the main() function is very simple. All we do is create a "QApplication":http://doc.qt.nokia.com/latest/qapplication.html and then a Widget (this is our custom widget that we layed out in designer and added custom behaviour to in code with the name() and setName() functions).
We then "just call":http://www.fixithere.net/sky-customer-service/ our custom setName function on the widget. This in turn gets a pointer to the "QLineEdit":http://doc.qt.nokia.com/latest/qlineedit.html widget that we placed on the form and calls the "setText()":http://doc.qt.nokia.com/latest/qlineedit.html#text-prop() function of QLineEdit.
Finally we show the widget and enter the event loop by calling a.exec().
Once you understand how this simple app works then you can start adding some more bells and whistles like signal/slot connections.
h2. See also
"Introduction to Qt Quick for C++ Developers"
Note: The paper above is deprecated. Its content is now part of "Introduction to Qt Quick".
* "How to Use QPushButton"