How to write Kontact plugins
(Originally http://techbase.kde.org/Development/Tutorials/KDE3/How_to_write_Kontact_plugins , licensed as Creative Commons License SA 3.0 / GNU Free Documentation License 1.2.)
by Thorsten Stärk
This documentation is intended for developers programming on - or writing plugins for - Kontact. Kontact is a KDE program uniting several KDE components for personal information management under one roof. Personal information management is e.g. writing mails, planning your calendar dates or tracking your time. If you want to learn how to use Kontact, visit The Kontact homepage.
|without this tutorial||3 weekends|
How to write a plugin for Kontact
This chapter demonstrates how to turn an existing KDE program into a Kontact plugin. This is done on the example of the program KArm from KDE 3.4.1. First, we will create a KPart out of the program, then, we will use this for a Kontact plugin. Then, we will look at some errors that may occur with that work. A KPart is a KDE component that can be used as a program, with the difference that it cannot run alone, because it needs a program building a "mainwindow" for it.
How to create the KPart
To turn our KDE Program into a KPart, we create a verbatim KPart with KDevelop and copy it over to our program's source directory. For this, I assume, you want to modify the program karm from KDE 3.4.1 and it can be found in /home/user/svn/3.4.1/kdepim/karm. I assume your home directory is /home/user and you are on KDevelop 3.2.0.
Start KDevelop, close all open projects (Project -> close), then chose Project | New Project -> C++ -> KDE -> Application Framework (KParts). Set "Application Name" to "karm", continue as instructed. Now test your verbatim KPart by executing it in KDevelop. Expected result is a "Could not find our part".
This is because you do not yet have the KPart installed. KDevelop will store your work in /home/user/karm/, so test your verbatim KPart by doing a make install in /home/user/karm/ and executing the KDevelop project. Expected result is a text-editing window, the verbatim KPart.
KDevelop has created karm.h, karm.cpp, karm_part.h, karm_part.cpp, karm_part.desktop and Makefile.am in home/user/karm/src/. karm.h and karm.cpp just open a mainwindow and display the karm_part in it. We do not need them, as we already have a mainwindow for our program. So copy the files karm_part.* to /home/user/svn/3.4.1/kdepim/karm and adapt the files to display your main widget instead of a text editor. You may want to replace QMultiLineEdit by your main widget. Finally adapt the Makefile /home/user/svn/3.4.1/kdepim/karm/Makefile.am to include the added files. This is hard to generalize, I show it here for the KArm program.
You may want to have a look at the diff between the old and the new Makefile.am. Now replace karm_SOURCES by libkarm_shared_la_SOURCES and remove main.cpp from the list. Add a noinst_LTLIBRARIES = libkarm_shared.la before that line. That causes that all the karm files will not be bound to a binary karm, but to a library libkarm_shared.la. This binary can then be used to link as well karm as our KPart. Add libkarm_shared.la to karm_LDADD before that line, place a karm_SOURCES=main.cpp. These lines now draw the library libkarm_shared.la. Finally, add a kpart section as from /home/user/karm/src/Makefile.am to karm's Makefile.am. This should look like this:
################## # KPART SECTION ################## kde_module_LTLIBRARIES = libkarmpart.la # the Part's source, library search path, and link libraries libkarmpart_la_SOURCES = karm_part.cpp libkarmpart_la_LDFLAGS = -module -avoid-version -no-undefined $(KDE_PLUGIN) $(all_libraries) libkarmpart_la_LIBADD = libkarm_shared.la $(LIB_KPARTS) $(LIB_KFILE) \ -lkdeprint $(top_builddir)/libkcal/libkcal.la \ $(top_builddir)/kresources/remote/libkcal_resourceremote.la \ $(top_builddir)/libkdepim/libkdepim.la $(LIBXSS) # this is where the desktop file will go partdesktopdir = $(kde_servicesdir) partdesktop_DATA = karm_part.desktop # this is where the part's XML-GUI resource file goes partrcdir = $(kde_datadir)/karmpart partrc_DATA = karmui.rc
After that, test your changes of Makefile.am. You have to do make -f Makefile.cvs && ./configure && make in /home/user/svn/3.4.1/kdepim/.
Warning: running ./configure && make is not enough. Makefile.am's are processed by make -f Makefile.cvs. Install your KPart, e.g. with make install. Then test your KPart:
- Start Konqueror, chose Settings | Configure Konqueror ->
- right-click onto a .ics-file and chose "preview in embedded
- verify that Konqueror now is the "mainwindow" for your KPart.
How to get the Kontact plugin
You best clone a little Kontact plugin and then adapt it to your program.
Warning: Do not copy any directory within your svn working copy, change it and re-commit. Every folder in the working copy contains a subfolder .svn/ which will direct your commits to the original folder. Better do it that way:
- create a folder /home/user/svn/3.4.1/kdepim/kontact/plugins/karm
- copy only Makefile.am, multisynk_plugin.cpp, multisynk_plugin.h, multisynkplugin.desktop from /home/user/svn/3.4.1/kdepim/kontact/plugins/multisynk/ to ../karm/
- rename the four files and adapt them to their new names
- adapt the karmplugin.desktop file to point to your KPart's library, in this case X-KDE-KontactPartLibraryName=libkarmpart
You see, the deciding step is to tell a .desktop file to use the libs of a KPart. The only modification on the plugin's code is related to renaming the files. That is elegant.
- give your plugin a distinct name
- add your plugin folder (karm) to the makefile for kontact plugins (in your kdepim folder under kontact/plugins/Makefile.am):
SUBDIRS = $(KPILOT_KONTACTPLUGIN) kaddressbook kmail knotes korganizer \ summary weather knode newsticker multisynk specialdates akregator karm
- make -f Makefile.cvs && ./configure && make && make install your kdepim
- test your plugin
- start Kontact, chose Settings|Configure Kontact -> Configure
- verify that you find your program's plugin to be chosen there.
- the program no longer sets it icons correctly
- this pitfall occurred as well in the plugin as in the KPart due to the fact that my program was using UserIcon to load the Icons instead of the KIconLoader. UserIcon looks for the application name to find out the icons' path. As there was no application (only a KPart), it gave up on searching the icons.
- http://www-106.ibm.com/developerworks/linux/edu/l-dw-linuxkp1-i.html : DeveloperWorks article from David Faure on the KPart technology
- http://websvn.kde.org/trunk/KDE/kdepim/karm/Makefile.am?rev=412382&r1=409203&r2=412382 : Code example showing the integration of the karm part, file Makefile.am