Development/Tutorials/Using KParts - Revision history

AnneW at 11:16, 15 July 2012

2012-07-15T11:16:48Z

Tstaerk: /* Introduction */

2011-09-13T10:02:21Z

‎Introduction

Tstaerk at 10:01, 13 September 2011

2011-09-13T10:01:54Z

Tstaerk: /* Introduction */

2011-09-12T19:40:06Z

‎Introduction

Nicolas17: update to new syntaxhighlighter

2011-06-29T19:37:05Z

update to new syntaxhighlighter

Frinring: /* mainwindow.cpp */

2010-11-21T17:52:26Z

‎mainwindow.cpp

Kurthindenburg: Get the slots correct to avoid messages when running.

2010-10-15T04:03:46Z

Get the slots correct to avoid messages when running.

Kurthindenburg: Correct rc name, otherwise it tries to find kpartutorial1.rc

2010-10-15T03:51:29Z

Correct rc name, otherwise it tries to find kpartutorial1.rc

PhreakOnALeash: Could we please use a seperate build directory :)

2010-04-21T17:51:29Z

Could we please use a seperate build directory :)

Aseigo: /* mainwindow.cpp */

2010-04-21T16:35:20Z

‎mainwindow.cpp

← Older revision		Revision as of 11:16, 15 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Using_KParts}}~~	+

	{{TutorialBrowser\|		{{TutorialBrowser\|

@@ Line 23: / Line 23: @@
   /root/.kde/share/kde4/services/:/usr/local/share/kde4/services/
-The first kPart we describe is KatePart, an editor representing a typical [http://api.kde.org/4.0-api/kdelibs-apidocs/kparts/html/classKParts_1_1ReadWritePart.html ReadWritePart]. A typical [http://api.kde.org/4.0-api/kdelibs-apidocs/kparts/html/classKParts_1_1ReadOnlyPart.html ReadOnlyPart] would be ]http://api.kde.org/4.5-api/kdebase-apps-apidocs/konsole/html/classKonsole_1_1Part.html konsolePart].
+The first kPart we describe is KatePart, an editor representing a typical [http://api.kde.org/4.0-api/kdelibs-apidocs/kparts/html/classKParts_1_1ReadWritePart.html ReadWritePart]. A typical [http://api.kde.org/4.0-api/kdelibs-apidocs/kparts/html/classKParts_1_1ReadOnlyPart.html ReadOnlyPart] would be [http://api.kde.org/4.5-api/kdebase-apps-apidocs/konsole/html/classKonsole_1_1Part.html konsolePart].
 == Using Katepart ==

@@ Line 22: / Line 22: @@
   # kde4-config --path services
   /root/.kde/share/kde4/services/:/usr/local/share/kde4/services/
 == Using Katepart ==

← Older revision		Revision as of 19:40, 12 September 2011
Line 18:		Line 18:

	This tutorial will show you how to use a KPart in your application, and how to create your own KPart.		This tutorial will show you how to use a KPart in your application, and how to create your own KPart.
		+
		+	KParts consist of a .desktop file describing the KPart and a .so file containing the function names and code. The .desktop file resides in KDE's services directory, you can find it out like this:
		+	# kde4-config --path services
		+	/root/.kde/share/kde4/services/:/usr/local/share/kde4/services/

	== Using Katepart ==		== Using Katepart ==

@@ Line 27: / Line 27: @@
 === main.cpp ===
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
 #include <KApplication>
 #include <KAboutData>
@@ Line 62: / Line 62: @@
+}
-</code>
+</syntaxhighlight>
 The main.cpp file is the same as that used in [[Development/Tutorials/KCmdLineArgs|Tutorial 5 - Command line arguments]].The only difference is in the details of the KAboutData.
@@ Line 68: / Line 68: @@
 === mainwindow.h ===
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
 #ifndef KPARTTUTORIAL1_H
@@ Line 118: / Line 118: @@
 #endif // KPARTTUT1_H
-</code>
+</syntaxhighlight>
 The mainwindow.h file is very simple. The important thing to notice here is that the MainWindow class inherits from KParts::MainWindow.
@@ Line 124: / Line 124: @@
 === mainwindow.cpp ===
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
 #include "mainwindow.h"
@@ Line 208: / Line 208: @@
+}
-</code>
+</syntaxhighlight>
 The mainwindow.cpp file contains the implementation of MainWindow. The constructor of this class contains all the code used to load the KPart.
@@ Line 220: / Line 220: @@
 === kparttut1ui.rc ===
-<code xml>
+<syntaxhighlight lang="xml">
 <!DOCTYPE kpartgui SYSTEM "kpartgui.dtd">
 <kpartgui name="kparttut1" version="1">
@@ Line 239: / Line 239: @@
 </ToolBar>
 </kpartgui>
-</code>
+</syntaxhighlight>
 The kparttut1ui.rc file is used to define how the actions in the part and the actions in the main window will be merged together. The <tt><Merge /></tt> element in the file menu for example indicates that any part containing actions in a file menu should list its parts after the file_open action and before the file_quit action.
@@ Line 245: / Line 245: @@
 === CMakeLists.txt ===
-<code ini>
+<syntaxhighlight lang="cmake">
 project(kparttut1)
@@ Line 265: / Line 265: @@
 install( FILES kparttut1ui.rc
      DESTINATION  ${DATA_INSTALL_DIR}/kparttut1 )
-</code>
+</syntaxhighlight>
 The CMakeLists.txt file is very simple in this case.

@@ Line 214: / Line 214: @@
 First it sets up the actions used by the main window (Open and Quit), and then sets up the gui elements to go with these items (toolbar items, menu items, keyboard shortcuts). Next is the standard code used to load the KPart. The createGUI method is responsible for merging the toolbars and menus of the KPart with the rest of the application.
-Note: although the part can also be loaded using KLibLoader, this method is depricated.
+Note: although the part can also be loaded using KPluginLoader, this method is depricated.
-     KLibFactory *factory = KLibLoader::self()->factory("katepart");
+     KPluginFactory* factory = KPluginLoader("katepart").factory();
 === kparttut1ui.rc ===

@@ Line 97: / Line 97: @@
      virtual ~MainWindow();
      /**
       * Use this method to load whatever file/URL you have
@@ Line 196: / Line 197: @@
 void MainWindow::setupActions()
+{
-     KStandardAction::open(this, SLOT(fileOpen()),
+     KStandardAction::open(this, SLOT(load()),
          actionCollection());
      KStandardAction::quit(qApp, SLOT(closeAllWindows()),

@@ Line 37: / Line 37: @@
 int main (int argc, char *argv[])
+{
-     KAboutData aboutData( "kparttutorial1", "kparttutorial1",
+     KAboutData aboutData( "kparttut1", "kparttut1",
          ki18n("KPart Tutorial 1"), "0.1",
          ki18n("A MainWindow for a KatePart."),

@@ Line 270: / Line 270: @@
 After compiling, linking and installing the application with
-  cmake . && make -j4 && make install
+  mkdir build && cd build && cmake .. && make -j4 && make install
 it can be executed with
   kparttut1 ''filename''

@@ Line 177: / Line 177: @@
          // if we couldn't find our Part, we exit since the Shell by
          // itself can't do anything useful
-         KMessageBox::error(this, "service kwordpart.desktop not found");
+         KMessageBox::error(this, "service katepart.desktop not found");
          qApp->quit();
          // we return here, cause qApp->quit() only means "exit the