Basic Qt Programming Tutorial: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 22: Line 22:


# Start up Qt Creator.
# Start up Qt Creator.
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152033-f24040e3.jpg|Start Qt-Creator]]":http://gallery.theharmers.co.uk/picture.php?/22/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152033-f24040e3.jpg
[http://gallery.theharmers.co.uk/picture.php?/22/category/7 larger image]
 
# Go to File->"New File or Project…" menu entry.
# Go to File->"New File or Project…" menu entry.
# Choose Qt Gui Application and choose a name for it.
# Choose Qt Gui Application and choose a name for it.
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-ea9bb58a.jpg|Select project type]]":http://gallery.theharmers.co.uk/picture.php?/23/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-ea9bb58a.jpg
[http://gallery.theharmers.co.uk/picture.php?/23/category/7 larger image]
 
# Enter a project name, "qt-tutorial-01", say.
# Enter a project name, "qt-tutorial-01", say.
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-8dabd337.jpg|Choose project name]]":http://gallery.theharmers.co.uk/picture.php?/24/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-8dabd337.jpg
[http://gallery.theharmers.co.uk/picture.php?/24/category/7 larger image]
 
# Select one or more versions of Qt to target. A desktop build is fine for this tutorial.
# Select one or more versions of Qt to target. A desktop build is fine for this tutorial.
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-35f9e7cb.jpg|Choose Qt build to target]]":http://gallery.theharmers.co.uk/picture.php?/25/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-35f9e7cb.jpg
[http://gallery.theharmers.co.uk/picture.php?/25/category/7 larger image]
 
# Select the base class to be QWidget (leave the class name as Widget which is the default).
# Select the base class to be QWidget (leave the class name as Widget which is the default).
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-26f92911.jpg|Select project generation options]]":http://gallery.theharmers.co.uk/picture.php?/26/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-26f92911.jpg
[http://gallery.theharmers.co.uk/picture.php?/26/category/7 larger image]
 
# Check project creation options on summary and click "Finish".
# Check project creation options on summary and click "Finish".
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-95ce9f30.jpg|Check project summary]]":http://gallery.theharmers.co.uk/picture.php?/27/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503152034-95ce9f30.jpg
[http://gallery.theharmers.co.uk/picture.php?/27/category/7 larger image]


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


# Click on that and designer will switch to design mode and open up the file. You should see a blank widget. Now do this:
# Click on that and designer will switch to design mode and open up the file. You should see a blank widget. Now do this:
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-af1ea190.jpg|Open designer]]":http://gallery.theharmers.co.uk/picture.php?/28/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-af1ea190.jpg
[http://gallery.theharmers.co.uk/picture.php?/28/category/7 larger image]
 
 
# Using the toolbox on the left, drag a Label onto the widget form
# Using the toolbox on the left, drag a Label onto the widget form
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-661b1ceb.jpg|Add label]]":http://gallery.theharmers.co.uk/picture.php?/29/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-661b1ceb.jpg
[http://gallery.theharmers.co.uk/picture.php?/29/category/7 larger image]
 
# Do similarly for a Line Edit and place it to the right of the Label. The exact position is not important.
# Do similarly for a Line Edit and place it to the right of the Label. The exact position is not important.
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-8c16787b.jpg|Add line edit]]":http://gallery.theharmers.co.uk/picture.php?/30/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-8c16787b.jpg
[http://gallery.theharmers.co.uk/picture.php?/30/category/7 larger image]
 
# Click on the widget background so that both of your new widgets (the label and line edit) get deselected.
# Click on the widget background so that both of your new widgets (the label and line edit) get deselected.
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-5084f96c.jpg|Select parent widget]]":http://gallery.theharmers.co.uk/picture.php?/31/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-5084f96c.jpg
[http://gallery.theharmers.co.uk/picture.php?/31/category/7 larger image]
 
# 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.
# 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.
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-01e7e207.jpg|Apply horizontal layout]]":http://gallery.theharmers.co.uk/picture.php?/32/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-01e7e207.jpg
[http://gallery.theharmers.co.uk/picture.php?/32/category/7 larger image]
 
# Double click on the Label and it will switch to edit mode. Change the text to "My name is:"
# Double click on the Label and it will switch to edit mode. Change the text to "My name is:"
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-4e8b7939.jpg|Change label text]]":http://gallery.theharmers.co.uk/picture.php?/33/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-4e8b7939.jpg
[http://gallery.theharmers.co.uk/picture.php?/33/category/7 larger image]
 
# Press Ctrl-S to save the form.
# Press Ctrl-S to save the form.
# 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.
# 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.
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-abad6378.jpg|Switch to Edit mode]]":http://gallery.theharmers.co.uk/picture.php?/34/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503154826-abad6378.jpg
[http://gallery.theharmers.co.uk/picture.php?/34/category/7 larger image]


Now open up the widget.h file and edit it so that it looks like this:
Now open up the widget.h file and edit it so that it looks like this:
Line 67: Line 94:
  #ifndef WIDGET_H
  #ifndef WIDGET_H
  #define WIDGET_H  
  #define WIDGET_H  
 
  #include <QWidget>
  #include <QWidget>
   
   
Line 81: Line 108:
   explicit Widget(QWidget *parent = 0);
   explicit Widget(QWidget *parent = 0);
   ~Widget();
   ~Widget();
 
  void setName(const QString &amp;name);
  void setName(const QString &amp;name);
   QString name() const;
   QString name() const;
 
  private:
  private:
   Ui::Widget *ui;
   Ui::Widget *ui;
  };
  };
 
  #endif // WIDGET_H
  #endif // WIDGET_H
</code>
</code>
Line 109: Line 136:
   delete ui;
   delete ui;
  }
  }
 
  void Widget::setName(const QString &amp;name)
  void Widget::setName(const QString &amp;name)
  {
  {
Line 143: Line 170:


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.
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.
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503160137-3e61f249.jpg|Compiling the project]]":http://gallery.theharmers.co.uk/picture.php?/35/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503160137-3e61f249.jpg
[http://gallery.theharmers.co.uk/picture.php?/35/category/7 larger image]


This is what the application looks like when it is executed:
This is what the application looks like when it is executed:
"[[Image:http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503160137-aac48922.jpg|The running application]]":http://gallery.theharmers.co.uk/picture.php?/36/category/7
http://gallery.theharmers.co.uk/upload/2011/05/03/thumbnail/TN-20110503160137-aac48922.jpg
[http://gallery.theharmers.co.uk/picture.php?/36/category/7 larger image]


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).
As you can see the main() function is very simple. All we do is create a [http://doc.qt.nokia.com/latest/qapplication.html QApplication] 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.
We then [http://www.fixithere.net/sky-customer-service/ just call] our custom setName function on the widget. This in turn gets a pointer to the [http://doc.qt.nokia.com/latest/qlineedit.html QLineEdit] widget that we placed on the form and calls the [http://doc.qt.nokia.com/latest/qlineedit.html#text-prop() setText()] function of QLineEdit.


Finally we show the widget and enter the event loop by calling a.exec().
Finally we show the widget and enter the event loop by calling a.exec().

Revision as of 09:16, 26 February 2015


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.

TN-20110503152033-f24040e3.jpg larger image

  1. Go to File->"New File or Project…" menu entry.
  1. Choose Qt Gui Application and choose a name for it.

TN-20110503152034-ea9bb58a.jpg larger image

  1. Enter a project name, "qt-tutorial-01", say.

TN-20110503152034-8dabd337.jpg larger image

  1. Select one or more versions of Qt to target. A desktop build is fine for this tutorial.

TN-20110503152034-35f9e7cb.jpg larger image

  1. Select the base class to be QWidget (leave the class name as Widget which is the default).

TN-20110503152034-26f92911.jpg larger image

  1. Check project creation options on summary and click "Finish".

TN-20110503152034-95ce9f30.jpg larger image

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:

TN-20110503154826-af1ea190.jpg larger image


  1. Using the toolbox on the left, drag a Label onto the widget form

TN-20110503154826-661b1ceb.jpg larger image

  1. Do similarly for a Line Edit and place it to the right of the Label. The exact position is not important.

TN-20110503154826-8c16787b.jpg larger image

  1. Click on the widget background so that both of your new widgets (the label and line edit) get deselected.

TN-20110503154826-5084f96c.jpg larger image

  1. 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.

TN-20110503154826-01e7e207.jpg larger image

  1. Double click on the Label and it will switch to edit mode. Change the text to "My name is:"

TN-20110503154826-4e8b7939.jpg larger image

  1. Press Ctrl-S to save the form.
  1. 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.

TN-20110503154826-abad6378.jpg larger image

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

 #ifndef WIDGET_H
 #define WIDGET_H 
 
 #include <QWidget>
 
 namespace Ui {
  class Widget;
 }
 
 class Widget : public QWidget
 {
  Q_OBJECT
 
 public:
  explicit Widget(QWidget *parent = 0);
  ~Widget();
 
 void setName(const QString &amp;name);
  QString name() const;
 
 private:
  Ui::Widget *ui;
 };
 
 #endif // WIDGET_H

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

 #include "widget.h"
 #include "ui_widget.h"
 
 Widget::Widget(QWidget *parent) :
  QWidget(parent),
  ui(new Ui::Widget)
 {
  ui->setupUi(this);
 }
 
 Widget::~Widget()
 {
  delete ui;
 }
 
 void Widget::setName(const QString &amp;name)
 {
  ui->lineEdit->setText(name);
 }
 
 QString Widget::name() const
 {
  return ui->lineEdit->text();
 }

Finally edit main.cpp to this:

 #include <QApplication>
 #include "widget.h" 
 
 int main(int argc, char '''argv[])
 {
  QApplication a(argc, argv);
  Widget w;
 
  w.setName("Slim Shady");
 
  w.show();
 
  return a.exec();
 }

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. TN-20110503160137-3e61f249.jpg larger image

This is what the application looks like when it is executed: TN-20110503160137-aac48922.jpg larger image

As you can see the main() function is very simple. All we do is create a QApplication 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 our custom setName function on the widget. This in turn gets a pointer to the QLineEdit widget that we placed on the form and calls the setText() 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.

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".