Difference between revisions of "Development/Tutorials/KDE4 Porting Guide"

Jump to: navigation, search
(Added some D-Bus stuff)
(add a section on convert designer '.ui' files)
Line 1: Line 1:
 
Porting a KDE3 based application needn't be a difficult process. Already, there are many scripts and sources of documentation which can help.
 
Porting a KDE3 based application needn't be a difficult process. Already, there are many scripts and sources of documentation which can help.
 +
 +
For the instructions in this tutorial we use the following shorthand:
 +
$SVN is the fullpath to the location of your KDE subversion checkout
  
 
==CMake==
 
==CMake==
Line 8: Line 11:
  
 
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 <tt>kdelibs</tt> 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 [http://websvn.kde.org/*checkout*/trunk/KDE/kdelibs/KDE4PORTING.html KDE4PORTING.html] file in the <tt>kdelibs</tt> module.
 +
 +
==Qt Designer UI Files==
 +
Qt designer ".ui" files created using Qt3 must be converted to the new Qt4 format.  This can be done using the <tt>uic3</tt> program available from your Qt4 installation.
 +
 +
<code>
 +
% $SVN/trunk/qt-copy/bin/uic3 -convert file.ui > foo.ui
 +
% mv foo.ui file.ui
 +
</code>
 +
 +
Or, if you prefer a graphical tool, you can use Qt4's designer program
 +
 +
<code>
 +
% $SVN/trunk/qt-copy/bin/designer file.ui
 +
# then save the file back over top itself
 +
</code>
 +
 +
Note: 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 <tt>fixuifiles</tt> program from the <tt>kdesdk</tt> package:
 +
<code>
 +
% $SVN/trunk/KDE/kdesdk/scripts/fixuifiles
 +
</code>
  
 
==D-Bus==
 
==D-Bus==

Revision as of 15:15, 24 February 2007

Porting a KDE3 based application needn't be a difficult process. Already, there are many scripts and sources of documentation which can help.

For the instructions in this tutorial we use the following shorthand: $SVN is the fullpath to the location of your KDE subversion checkout

Contents

CMake

Unlike KDE3, KDE4 applications will be build with the help of CMake. The easiest way to port your autotools system to CMake is with the help of the am2cmake script which can be found in the cmake/scripts directory of the kdesdk module. This will create a series of CMakeLists.txt files alongside your old buildsystem files.

KDE4 API

A portion porting your code to KDE4 is simply renaming of class names and header files. Since it would be rather tedious to change all these by hand, there is a handy script in the scripts/qt4 directory of kdesdk called adapt-to-kde4-api.pl. This will scan all your files and create a diff output which can then be used to patch your code.

Once that simple code substitution has been done, you will still have to go through your code to port to, for example, the new KAction API. Documentation about all API changes is kept in the KDE4PORTING.html file in the kdelibs module.

Qt Designer UI Files

Qt designer ".ui" files created using Qt3 must be converted to the new Qt4 format. This can be done using the uic3 program available from your Qt4 installation.

% $SVN/trunk/qt-copy/bin/uic3 -convert file.ui > foo.ui % mv foo.ui file.ui

Or, if you prefer a graphical tool, you can use Qt4's designer program

% $SVN/trunk/qt-copy/bin/designer file.ui

  1. then save the file back over top itself

Note: 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 fixuifiles program from the kdesdk package: % $SVN/trunk/KDE/kdesdk/scripts/fixuifiles

D-Bus

Instead of DCOP in KDE3, KDE4 now uses D-Bus for its interprocess communication.

A guide on how to port the DCOP parts to D-Bus is available in the PORTING-TO-DBUS.txt file in the kdelibs module.

Several D-Bus tutorials are located in the Tutorials section.


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal