summaryrefslogtreecommitdiff
path: root/doc/src/portingcppapps_toqt5.qdoc
blob: e1b5dbe636309e70c2eb715b2082e07c6d9e949b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page portingcppapp.html
\title Porting C++ Applications to Qt 5
\brief Provides instructions to migrate a Qt 4 C++ application to Qt 5.

This topic talks about the Qt Widgets changes in Qt 5. The
following step-by-step instructions take you through the changes required to
port the \l{Animated Tiles Example}{Animated Tiles} application to Qt 5:

\list 1
   \li Open the Animated Tiles project using Qt Creator.
   \li Edit \c {main.cpp} and replace the \c {#include <QtGui>} instance with
       \c {#include <QtWidgets>}.
       The Perl-script \c fixqt4headers.pl can be used to scan the source files
       of a project and perform the replacements.
   \li Edit the \c {animatedtiles.pro} and add \c {QT += widgets} towards the
       end of the file.
       \note \l{Qt GUI} is included by default in all Qt applications unless excluded using the \c {QT -= gui} directive in the \c{qmake} project file.
   \li Save the changes and run the application.
\endlist

Once you see the application running, check whether it behaves as expected.

\image animatedtiles_snapshot.png "A snapshot of the \c animatedtiles application running on Ubuntu v12.04"

It is also possible to keep the project compiling with Qt 4 and Qt 5. This requires:

\list 1
   \li Omitting the module name from all includes by running the
       \c fixqt4headers.pl script with the \c --strip-modules option.
   \li Adding scopes depending on the version of Qt to the \c{.pro} files:
       \code
       greaterThan(QT_MAJOR_VERSION, 4): QT += widgets
       \endcode
   \li Introducing \c #if scopes around code using modified API:
       \code
       #if QT_VERSION >= 0x050000
           headerView->setSectionResizeMode(QHeaderView::ResizeToContents);
       #else
           headerView->setResizeMode(QHeaderView::ResizeToContents);
       #endif
       \endcode
\endlist

if you are using Qt WebKit, see
\l{Porting from Qt WebKit to Qt WebEngine}{Qt WebKit to Qt WebEngine} porting
instructions.

\section1 Related Topics
\list
\li \l {C++ API Changes}
\li \l {Porting QML Applications to Qt 5 Example}
\li \l {Qt Examples And Tutorials}
\endlist
*/