Development/Tutorials/KDE4 Porting Guide - Revision history

Fengchao: Add missing applications page link.

2012-12-23T13:40:11Z

Add missing applications page link.

AnneW at 15:35, 13 July 2012

2012-07-13T15:35:37Z

UlFie: /* Documentation */ Link updated

2011-06-27T14:57:04Z

‎Documentation: Link updated

Icwiener: Fix syntax highlighting.

2011-06-27T12:55:00Z

Fix syntax highlighting.

Icwiener: /* CMake */ Fix syntax highlighting.

2011-06-27T12:48:43Z

‎CMake: Fix syntax highlighting.

UlFie: Stuff after code tag needs to be indented to get formatting right (stopped working without it June 26th, 2011)

2011-06-27T12:24:25Z

Stuff after code tag needs to be indented to get formatting right (stopped working without it June 26th, 2011)

UlFie: /* Qt4 API */ Fix links

2011-06-25T22:56:23Z

‎Qt4 API: Fix links

Odysseus: /* Documentation */

2011-04-15T21:22:51Z

‎Documentation

Odysseus at 21:20, 15 April 2011

2011-04-15T21:20:50Z

Dhaumann: /* Other Help */

2008-12-29T15:14:48Z

‎Other Help

@@ Line 4: / Line 4: @@
 ==Introduction==
 A tutorial intended to help developers port their Qt3/KDE3 based applications to Qt4/KDE4.  Porting a KDE3 based application needn't be a difficult process. Already, there are many scripts and sources of documentation which can help.
 ==Conventions==

← Older revision		Revision as of 15:35, 13 July 2012
Line 1:		Line 1:
	{{warning\|This page is yet to be reviewed for changes required by the migration to Git. Information and commands on this page may no longer be valid and should be used with care. Please see the [[Development/Git\|KDE Git hub page]] for more details. }}		{{warning\|This page is yet to be reviewed for changes required by the migration to Git. Information and commands on this page may no longer be valid and should be used with care. Please see the [[Development/Git\|KDE Git hub page]] for more details. }}

−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/KDE4_Porting_Guide}}~~

	==Introduction==		==Introduction==

@@ Line 128: / Line 128: @@
 ===Documentation===
 * [http://doc.trolltech.com/4.3 Qt4.3 Reference]
-* [http://developer.kde.org/documentation/library/svn-api.php KDE4 API Reference]
+* [http://api.kde.org/ KDE4 API Reference]
 * [http://www.cmake.org/HTML/Documentation.html CMake Cross Platform Make]
 * [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/raw/KDE4PORTING.html KDE4PORTING.html]

@@ Line 41: / Line 41: @@
 These documents describe a tool provided by Trolltech called {{program|qt3to4}} that can help port the Qt parts of your code from Qt3 to Qt4, using compatibility functions.  Run {{program|qt3to4}} as follows:
-<code bash>
+<syntaxhighlight lang="bash">
- % $SVN/trunk/qt-copy/bin/qt3to4 [options] <Infile>, [Infile], ...
+$SVN/trunk/qt-copy/bin/qt3to4 [options] <Infile>, [Infile], ...
-</code>
+</syntaxhighlight>
 Infile can be a source file or a project file. If you specify a project file, ending with '.pro' or '.pri', {{program|qt3to4}} will port all files specified in that project.
-For more information, run {{program|qt3to4}} with the "--help" option or visit
+For more information, run {{program|qt3to4}} with the <tt>--help</tt> option or visit
 the [http://doc.qt.nokia.com/latest/qt3to4.html "qt3to4-The Qt 3 to 4 Porting Tool"] page.
 Additionally, there is a program called {{program|remove-qt3-support.pl}} in the {{module|kdesdk}} module that will search and replace lots of deprecated Qt3 stuff for you. Simply run this program without any options in the source directory.
-<code bash>
+<syntaxhighlight lang="bash">
- % $SVN/trunk/KDE/kdesdk/scripts/qt4/remove-qt3-support.pl
+$SVN/trunk/KDE/kdesdk/scripts/qt4/remove-qt3-support.pl
-</code>
+</syntaxhighlight>
 Chances are that some Qt3 classes will still remain in the code, so make sure your top-level CMakeLists.txt file defines the QT3_SUPPORT and QT3_SUPPORT_WARNINGS macros for the Qt headers, like so:
-<code>
+<pre>
- add_definitions (-DQT3_SUPPORT -DQT3_SUPPORT_WARNINGS)
+add_definitions (-DQT3_SUPPORT -DQT3_SUPPORT_WARNINGS)
-</code>
+</pre>
 ==KDE4 API==
@@ Line 67: / Line 67: @@
 Qt designer ".ui" files created using Qt3 must be converted to the new Qt4 format.  This can be done using the {{program|uic3}} program available from your Qt4 installation.
-<code bash>
+<syntaxhighlight lang="bash">
- % $SVN/trunk/qt-copy/bin/uic3 -convert file.ui > foo.ui
+$SVN/trunk/qt-copy/bin/uic3 -convert file.ui > foo.ui
- % mv foo.ui file.ui
+mv foo.ui file.ui
-</code>
+</syntaxhighlight>
 Or, if you prefer a graphical tool, you can use Qt4's designer program
-<code bash>
+<syntaxhighlight lang="bash">
- % $SVN/trunk/qt-copy/bin/designer file.ui
+$SVN/trunk/qt-copy/bin/designer file.ui #you can save file.ui over top itself, or save to a new file
- (you can save file.ui over top itself, or save to a new file)
+</syntaxhighlight>
-</code>
 {{Warning|Beware, the conversion process loses any custom slots, table columns, etc.  So, you may need to put some stuff back by hand.}}
 You should also run the {{program|fixuifiles}} program from the {{module|kdesdk}} module, it performs cleanups and sanity checks:
-<code bash>
+<syntaxhighlight lang="cpp-qt">
- % $SVN/trunk/KDE/kdesdk/scripts/fixuifiles
+$SVN/trunk/KDE/kdesdk/scripts/fixuifiles
-</code>
+</syntaxhighlight>
 ==D-Bus==
@@ Line 102: / Line 101: @@
 For example, the 'messages' creation rule:
-<code>
+<pre>
- messages: rc.cpp
+messages: rc.cpp
          rm -f tips.cpp
          $(PREPARETIPS) > tips.cpp
          $(XGETTEXT) -ktranslate *.cpp *.h -o $(podir)/kmail.pot
          rm -f tips.cpp
-</code>
+</pre>
 becomes the following {{path|Messages.sh}} script:
-<code bash>
+<syntaxhighlight lang="bash">
- #! /usr/bin/env bash
+#! /usr/bin/env bash
- $PREPARETIPS > tips.cpp
+$PREPARETIPS > tips.cpp
- $XGETTEXT -ktranslate:1,1t -ktranslate:1c,2,2t *.cpp *.h -o $podir/kmail.pot
+$XGETTEXT -ktranslate:1,1t -ktranslate:1c,2,2t *.cpp *.h -o $podir/kmail.pot
- rm -f tips.cpp
+rm -f tips.cpp
-</code>
+</syntaxhighlight>
 ==Do's and Don'ts==

@@ Line 17: / Line 17: @@
 For example, if your source code is located in {{path|/path/to/src}} then:
-<code bash>
+<syntaxhighlight lang="bash">
- % cd /path/to/src
+cd /path/to/src
- % $SVN/trunk/KDE/kdesdk/cmake/scripts/am2cmake --kde4
+$SVN/trunk/KDE/kdesdk/cmake/scripts/am2cmake --kde4
-</code>
+</syntaxhighlight>
-Run <tt> am2cmake --help</tt> to check whether you need the <tt>--kde4</tt> flag.
+Run <tt>am2cmake --help</tt> to check whether you need the <tt>--kde4</tt> flag.
 There is also a tool that looks in your resulting {{path|CMakeList.txt}} files for potential problems.  This tool called {{program|cmakelint.pl}} is located in {{path|$SVN/trunk/kde/kdesdk/scripts}}.  Use it like so:
-<code bash>
+<syntaxhighlight lang="bash">
- % cd /path/to/src
+cd /path/to/src
- % $SVN/trunk/KDE/kdesdk/scripts/cmakelint.pl CMakeLists.txt
+$SVN/trunk/KDE/kdesdk/scripts/cmakelint.pl CMakeLists.txt
-</code>
+</syntaxhighlight>
 Or, to run it over your entire source directory:
-<code bash>
+<syntaxhighlight lang="bash">
- % cd /path/to/src
+cd /path/to/src
- % find . -name CMakeLists.txt | \
+find . -name CMakeLists.txt | xargs $SVN/trunk/KDE/kdesdk/scripts/cmakelint.pl
-   xargs $SVN/trunk/KDE/kdesdk/scripts/cmakelint.pl
+</syntaxhighlight>
-</code>
 ==Qt4 API==

@@ Line 37: / Line 37: @@
 ==Qt4 API==
 An overview of the Qt3 to Qt4 transition is provided in Trolltech's
-[http://www.trolltech.com/products/qt/whatsnew/porting "Moving from Qt 3 to Qt 4"] paper.  This document provides an excellent overview into the major functionality changes with Qt4 and is highly recommended.
+[http://doc.qt.nokia.com/latest/porting4-overview.html "Moving from Qt 3 to Qt 4"] paper.  This document provides an excellent overview into the major functionality changes with Qt4 and is highly recommended.
-The follow-on [http://doc.trolltech.com/latest/porting4.html "Porting to Qt 4"] page gives an amazingly detailed description of the porting process, along with a list of the changes in the classes and functions.
+The follow-on [http://doc.qt.nokia.com/latest/porting4.html "Porting to Qt 4"] page gives an amazingly detailed description of the porting process, along with a list of the changes in the classes and functions.
 These documents describe a tool provided by Trolltech called {{program|qt3to4}} that can help port the Qt parts of your code from Qt3 to Qt4, using compatibility functions.  Run {{program|qt3to4}} as follows:
@@ Line 48: / Line 48: @@
 For more information, run {{program|qt3to4}} with the "--help" option or visit
-the [http://doc.trolltech.com/latest/qt3to4.html "qt3to4-The Qt 3 to 4 Porting Tool"] page.
+the [http://doc.qt.nokia.com/latest/qt3to4.html "qt3to4-The Qt 3 to 4 Porting Tool"] page.
 Additionally, there is a program called {{program|remove-qt3-support.pl}} in the {{module|kdesdk}} module that will search and replace lots of deprecated Qt3 stuff for you. Simply run this program without any options in the source directory.

@@ Line 1: / Line 1: @@
 {{Template:I18n/Language Navigation Bar|Development/Tutorials/KDE4_Porting_Guide}}
@@ Line 61: / Line 63: @@
 Much of the porting effort consists of simply renaming class names and header files. Since it would be rather tedious to change all these by hand, there is a handy script in the {{path|scripts/qt4}} directory of {{module|kdesdk}} called {{program|adapt-to-kde4-api.pl}}. This will update all your files and output a {{program|diff}} so you can see what changes were made.
-Once that simple code substitution has been done, you will still have to go through your code to port to, for example, the new <tt>KAction</tt> API. Documentation about all API changes is kept in the [http://websvn.kde.org/*checkout*/trunk/KDE/kdelibs/KDE4PORTING.html KDE4PORTING.html] file in the {{module|kdelibs}} module.
+Once that simple code substitution has been done, you will still have to go through your code to port to, for example, the new <tt>KAction</tt> API. Documentation about all API changes is kept in the [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/raw/KDE4PORTING.html KDE4PORTING.html] file in the {{module|kdelibs}} module.
 ==Qt Designer UI Files==

@@ Line 133: / Line 133: @@
 ===Other Help===
-* #kde4-devel on irc.freenode.net
+* #kde-devel on irc.freenode.net
 [[Category:KDE4]]