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

Jump to: navigation, search
m (Categorise)
 
(62 intermediate revisions by 22 users not shown)
Line 1: Line 1:
 +
 +
{{TutorialBrowser|
 +
 +
series=Beginner Tutorial|
 +
 +
name=How To Use KXmlGuiWindow|
 +
 +
pre=[[Development/Tutorials/First_program|Tutorial 1 - Hello World]]|
 +
 +
next=[[Development/Tutorials/Using_KActions|Tutorial 3 - KActions and XMLGUI]]|
 +
 +
reading={{class|KXmlGuiWindow}}
 +
}}
 +
 
==Abstract==
 
==Abstract==
This tutorial carries on from [[Development/Tutorials/Programming_Tutorial_KDE_4/First_program|First Program Tutorial]] and will introduce the {{class|KMainWindow}} class.
+
This tutorial carries on from [[Development/Tutorials/First_program|First Program Tutorial]] and will introduce the {{class|KXmlGuiWindow}} class.
  
In the previous tutorial, the program caused a dialog box to pop up but were going to take steps towards a functioning application.
+
In the previous tutorial, the program caused a dialog box to pop up but we're going to take steps towards a functioning application.
  
 
[[image:introtokdetutorial2.png|frame|center]]
 
[[image:introtokdetutorial2.png|frame|center]]
  
In order to have a useful KMainWindow, we must sub class it. So we create two files, a <tt>MainWindow.cpp</tt> and a <tt>MainWindow.h</tt> which will contain our code.
+
==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. 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.
  
==Prerequisites==
+
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.
* [[Development/Tutorials/Programming_Tutorial_KDE_4/First_program|Hello World Tutorial]]
+
  
==MainWindow Class==
+
===mainwindow.h===
===MainWindow.h===
+
<syntaxhighlight lang="cpp-qt">
<code cppqt n>
+
 
#ifndef MAINWINDOW_H
 
#ifndef MAINWINDOW_H
 
#define MAINWINDOW_H
 
#define MAINWINDOW_H
  
#include <KMainWindow>
+
#include <KXmlGuiWindow>
 
#include <KTextEdit>
 
#include <KTextEdit>
  
class MainWindow : public KMainWindow
+
class MainWindow : public KXmlGuiWindow
 
{
 
{
 
   public:
 
   public:
Line 30: Line 44:
  
 
#endif
 
#endif
</code>
+
</syntaxhighlight>
First we Subclass KMainWindow on line 7 with with <tt>class MainWindow : public KMainWindow</tt>.
+
First we Subclass KXmlGuiWindow on line 7 with <tt>class MainWindow : public KXmlGuiWindow</tt>.
  
The we declare the constructor with <tt>MainWindow(QWidget *parent=0);</tt>.
+
Then we declare the constructor with <tt>MainWindow(QWidget *parent=0);</tt>.
  
And finally we declare a ponter to the object that will make up the bulk of our program. {{class|KTextEdit}} is a generic richtext editor with some KDE niceties like cursor auto-hiding.
+
And finally we declare a pointer to the object that will make up the bulk of our program. {{class|KTextEdit}} is a generic richtext editor with some KDE niceties like cursor auto-hiding.
===MainWindow.cpp===
+
 
<code cppqt n>
+
===mainwindow.cpp===
 +
<syntaxhighlight lang="cpp-qt">
 
#include "mainwindow.h"
 
#include "mainwindow.h"
  
MainWindow::MainWindow(QWidget *parent) : KMainWindow(parent)
+
MainWindow::MainWindow(QWidget *parent) : KXmlGuiWindow(parent)
 
{
 
{
   textArea = new KTextEdit;
+
   textArea = new KTextEdit();
 
   setCentralWidget(textArea);
 
   setCentralWidget(textArea);
 
   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.
  
On line 5, we initialise our text editor with an object. Then on line 6 we use the built-in setCentralWidget() function which tells the KMainWindow what should appear in the central section of the window.
+
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).
  
Finally, KMainWindow::setupGUI() is called which does a lot of behind the scene's stuff and creates the default menu bars (Settings, Help).
 
 
==Back to main.cpp==
 
==Back to main.cpp==
 
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>
 
#include <KCmdLineArgs>
 
#include <KCmdLineArgs>
 +
#include <KLocale>
  
 
#include "mainwindow.h"
 
#include "mainwindow.h"
Line 64: Line 81:
 
int main (int argc, char *argv[])
 
int main (int argc, char *argv[])
 
{
 
{
   KAboutData aboutData( "tutorial2",  
+
   KAboutData aboutData( "tutorial2", 0,
       "Tutorial2", "1.0", "A simple text area",
+
       ki18n("Tutorial 2"), "1.0",
       KAboutData::License_GPL, "(c) 2006" );
+
      ki18n("A simple text area"),
 +
       KAboutData::License_GPL,
 +
      ki18n("Copyright (c) 2007 Developer") );
 
   KCmdLineArgs::init( argc, argv, &aboutData );
 
   KCmdLineArgs::init( argc, argv, &aboutData );
 
    
 
    
Line 76: Line 95:
 
   return app.exec();
 
   return app.exec();
 
}
 
}
</code>
+
</syntaxhighlight>
The only new lines here (compared to Tutorial 1) are 16 and 17. On line 16, we create our MainWindow object and then on line 17, 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.
  
 
==CMake==
 
==CMake==
 
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)
 +
 
find_package(KDE4 REQUIRED)
 
find_package(KDE4 REQUIRED)
include_directories( ${KDE4_INCLUDES} )
+
include_directories(${KDE4_INCLUDES})
 +
 
 
set(tutorial2_SRCS  
 
set(tutorial2_SRCS  
main.cpp
+
  main.cpp
mainwindow.cpp
+
  mainwindow.cpp
 
)
 
)
 +
 
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 and run ===
 +
To compile, link and run it, make sure you have [[Getting_Started/Build|set up a correct build environment]] and issue:
 +
<syntaxhighlight lang="bash">
 +
cmake . && make && ./tutorial2
 +
</syntaxhighlight>
 +
 
 
==Moving On==
 
==Moving On==
Now you can move on to [[Development/Tutorials/Programming_Tutorial_KDE_4/Using_KActions|using KActions]].
+
Now you can move on to [[Development/Tutorials/Using_KActions|using KActions]].
{{KDE4}}
+
 
[[Category:Tutorial]]
+
[[Category:C++]]

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,181 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