Difference between revisions of "Development/Tutorials/Using KXmlGuiWindow"

Jump to: navigation, search
(numbering fix)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Development/Tutorials/Using_KXmlGuiWindow}}
+
 
 
{{TutorialBrowser|
 
{{TutorialBrowser|
  
Line 22: Line 22:
 
==KXmlGuiWindow==
 
==KXmlGuiWindow==
  
{{class|KXmlGuiWindow}} provides a full main window view with menubars, toolbars, a statusbar and a main area in the centre for a large widget. Most KDE applications will derive from this class as it provides an easy way to define menu and toolbar layouts through XML files (this technology is called XMLGUI). While we will not be using XMLGUI in ''this'' tutorial, we will use it in the next.
+
{{class|KXmlGuiWindow}} provides a full main window view with menubars, toolbars, a statusbar and a main area in the centre for a large widget. For example the help-menu is predefined. Most KDE applications will derive from this class as it provides an easy way to define menu and toolbar layouts through XML files (this technology is called XMLGUI). While we will not be using XMLGUI in ''this'' tutorial, we will use it in the next.
  
 
In order to have a useful KXmlGuiWindow, we must subclass it. So we create two files, a <tt>mainwindow.cpp</tt> and a <tt>mainwindow.h</tt> which will contain our code.
 
In order to have a useful KXmlGuiWindow, we must subclass it. So we create two files, a <tt>mainwindow.cpp</tt> and a <tt>mainwindow.h</tt> which will contain our code.
  
 
===mainwindow.h===
 
===mainwindow.h===
<code cppqt n>
+
<syntaxhighlight lang="cpp-qt">
 
#ifndef MAINWINDOW_H
 
#ifndef MAINWINDOW_H
 
#define MAINWINDOW_H
 
#define MAINWINDOW_H
Line 44: Line 44:
  
 
#endif
 
#endif
</code>
+
</syntaxhighlight>
 
First we Subclass KXmlGuiWindow on line 7 with <tt>class MainWindow : public KXmlGuiWindow</tt>.
 
First we Subclass KXmlGuiWindow on line 7 with <tt>class MainWindow : public KXmlGuiWindow</tt>.
  
Line 52: Line 52:
  
 
===mainwindow.cpp===
 
===mainwindow.cpp===
<code cppqt n>
+
<syntaxhighlight lang="cpp-qt">
 
#include "mainwindow.h"
 
#include "mainwindow.h"
  
Line 61: Line 61:
 
   setupGUI();
 
   setupGUI();
 
}
 
}
</code>
+
</syntaxhighlight>
 
First, of course, on line 1 we have to include the header file containing the class declaration.
 
First, of course, on line 1 we have to include the header file containing the class declaration.
  
Line 71: Line 71:
 
In order to actually run this window, we need to add a few lines in main.cpp:
 
In order to actually run this window, we need to add a few lines in main.cpp:
 
===main.cpp===
 
===main.cpp===
<code cppqt n>
+
<syntaxhighlight lang="cpp-qt">
 
#include <KApplication>
 
#include <KApplication>
 
#include <KAboutData>
 
#include <KAboutData>
Line 95: Line 95:
 
   return app.exec();
 
   return app.exec();
 
}
 
}
</code>
+
</syntaxhighlight>
 
The only new lines here (compared to Tutorial 1) are 6, 19 and 20. On line 19, we create our MainWindow object and then on line 20, we display it.
 
The only new lines here (compared to Tutorial 1) are 6, 19 and 20. On line 19, we create our MainWindow object and then on line 20, we display it.
  
Line 101: Line 101:
 
The best way to build the program is to use CMake. All that's changed since tutorial 1 is that <tt>mainwindow.cpp</tt> has been added to the sources list and any <tt>tutorial1</tt> has become <tt>tutorial2</tt>.
 
The best way to build the program is to use CMake. All that's changed since tutorial 1 is that <tt>mainwindow.cpp</tt> has been added to the sources list and any <tt>tutorial1</tt> has become <tt>tutorial2</tt>.
 
===CMakeLists.txt===
 
===CMakeLists.txt===
<code ini n>
+
<syntaxhighlight lang="cmake">
 
project (tutorial2)
 
project (tutorial2)
  
Line 114: Line 114:
 
kde4_add_executable(tutorial2 ${tutorial2_SRCS})
 
kde4_add_executable(tutorial2 ${tutorial2_SRCS})
 
target_link_libraries(tutorial2 ${KDE4_KDEUI_LIBS})
 
target_link_libraries(tutorial2 ${KDE4_KDEUI_LIBS})
</code>
+
</syntaxhighlight>
  
===Compile it===
+
=== Compile and run ===
To compile, link and run it, use:
+
To compile, link and run it, make sure you have [[Getting_Started/Build|set up a correct build environment]] and issue:
mkdir build && cd build
+
<syntaxhighlight lang="bash">
cmake ..
+
cmake . && make && ./tutorial2
make
+
</syntaxhighlight>
./tutorial2
+
  
 
==Moving On==
 
==Moving On==

Latest revision as of 13:53, 13 July 2012

How To Use KXmlGuiWindow
Tutorial Series   Beginner Tutorial
Previous   Tutorial 1 - Hello World
What's Next   Tutorial 3 - KActions and XMLGUI
Further Reading   KXmlGuiWindow

Contents

[edit] Abstract

This tutorial carries on from First Program Tutorial and will introduce the KXmlGuiWindow class.

In the previous tutorial, the program caused a dialog box to pop up but we're going to take steps towards a functioning application.

Introtokdetutorial2.png

[edit] KXmlGuiWindow

KXmlGuiWindow provides a full main window view with menubars, toolbars, a statusbar and a main area in the centre for a large widget. For example the help-menu is predefined. Most KDE applications will derive from this class as it provides an easy way to define menu and toolbar layouts through XML files (this technology is called XMLGUI). While we will not be using XMLGUI in this tutorial, we will use it in the next.

In order to have a useful KXmlGuiWindow, we must subclass it. So we create two files, a mainwindow.cpp and a mainwindow.h which will contain our code.

[edit] mainwindow.h

#ifndef MAINWINDOW_H
#define MAINWINDOW_H
 
#include <KXmlGuiWindow>
#include <KTextEdit>
 
class MainWindow : public KXmlGuiWindow
{
  public:
    MainWindow(QWidget *parent=0);
 
  private:
    KTextEdit* textArea;
};
 
#endif

First we Subclass KXmlGuiWindow on line 7 with class MainWindow : public KXmlGuiWindow.

Then we declare the constructor with MainWindow(QWidget *parent=0);.

And finally we declare a pointer to the object that will make up the bulk of our program. KTextEdit is a generic richtext editor with some KDE niceties like cursor auto-hiding.

[edit] mainwindow.cpp

#include "mainwindow.h"
 
MainWindow::MainWindow(QWidget *parent) : KXmlGuiWindow(parent)
{
  textArea = new KTextEdit();
  setCentralWidget(textArea);
  setupGUI();
}

First, of course, on line 1 we have to include the header file containing the class declaration.

On line 5, we initialise our text editor with an object. Then on line 6 we use KXmlGuiWindow's built-in setCentralWidget() function which tells the KXmlGuiWindow what should appear in the central section of the window.

Finally, KXmlGuiWindow::setupGUI() is called which does a lot of behind-the-scenes stuff and creates the default menu bars (Settings, Help).

[edit] Back to main.cpp

In order to actually run this window, we need to add a few lines in main.cpp:

[edit] main.cpp

#include <KApplication>
#include <KAboutData>
#include <KCmdLineArgs>
#include <KLocale>
 
#include "mainwindow.h"
 
int main (int argc, char *argv[])
{
  KAboutData aboutData( "tutorial2", 0,
      ki18n("Tutorial 2"), "1.0",
      ki18n("A simple text area"),
      KAboutData::License_GPL,
      ki18n("Copyright (c) 2007 Developer") );
  KCmdLineArgs::init( argc, argv, &aboutData );
 
  KApplication app;
 
  MainWindow* window = new MainWindow();
  window->show();
 
  return app.exec();
}

The only new lines here (compared to Tutorial 1) are 6, 19 and 20. On line 19, we create our MainWindow object and then on line 20, we display it.

[edit] CMake

The best way to build the program is to use CMake. All that's changed since tutorial 1 is that mainwindow.cpp has been added to the sources list and any tutorial1 has become tutorial2.

[edit] CMakeLists.txt

project (tutorial2)
 
find_package(KDE4 REQUIRED)
include_directories(${KDE4_INCLUDES})
 
set(tutorial2_SRCS 
  main.cpp
  mainwindow.cpp
)
 
kde4_add_executable(tutorial2 ${tutorial2_SRCS})
target_link_libraries(tutorial2 ${KDE4_KDEUI_LIBS})

[edit] Compile and run

To compile, link and run it, make sure you have set up a correct build environment and issue:

cmake . && make && ./tutorial2

[edit] Moving On

Now you can move on to using KActions.


This page was last modified on 13 July 2012, at 13:53. This page has been accessed 64,464 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal