Development/Tutorials/Using KXmlGuiWindow/KF5: Difference between revisions

From KDE TechBase
(Rough draft)
 
m (Remove use of ECM_KDE_MODULE_DIR, part of ECM_MODULE_PATH)
 
(10 intermediate revisions by 2 users not shown)
Line 6: Line 6:
name=How To Use KXmlGuiWindow|
name=How To Use KXmlGuiWindow|


pre=[[Development/Tutorials/First_program|Tutorial 1 - Hello World]]|
pre=[[Development/Tutorials/First_program/KF5|Tutorial 1 - Hello World]]|


next=[[Development/Tutorials/Using_KActions|Tutorial 3 - KActions and XMLGUI]]|  
next=[[Development/Tutorials/Using_KActions/KF5|Tutorial 3 - KActions and XMLGUI]]|  


reading={{class|KXmlGuiWindow}}
reading={{class|KXmlGuiWindow}}
Line 15: Line 15:
==Abstract==
==Abstract==


Rough draft of port to KDE Frameworks 5
This tutorial carries on from [[Development/Tutorials/First_program/KF5|First Program Tutorial]] and will introduce the {{class|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.
 
 
[[image:tutorial2-kf5.png|frame|center]]


==KXmlGuiWindow==
==KXmlGuiWindow==


Now found in the KF5::XmlGui framework
{{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 and is part of the KF5::XmlGui framework). 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.


===mainwindow.h===
===mainwindow.h===
Line 42: Line 49:
#endif
#endif
</syntaxhighlight>
</syntaxhighlight>
First we Subclass KXmlGuiWindow on line 8 with <tt>class MainWindow : public KXmlGuiWindow</tt>.


====Notes====
Then we declare the constructor with <tt>MainWindow(QWidget *parent=0);</tt>.


* Use class forwarding instead of direct include.
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 niceties like cursor auto-hiding.


===mainwindow.cpp===
===mainwindow.cpp===
Line 61: Line 69:
}
}
</syntaxhighlight>
</syntaxhighlight>
First, of course, on line 1 we have to include the header file containing the class declaration.


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


* Include KTextEdit from here.
Finally, KXmlGuiWindow::setupGUI() is called which does a lot of behind-the-scenes stuff and creates the default menu bars (Settings, Help).
 
==Back to main.cpp==
In order to actually run this window, we need to add a few lines in main.cpp:


===main.cpp===
===main.cpp===
Line 81: Line 93:
int main (int argc, char *argv[])
int main (int argc, char *argv[])
{
{
    // 1
     QApplication app(argc, argv);
     QApplication app(argc, argv);
    KLocalizedString::setApplicationDomain("tutorial2");
      
      
    // 2
    KLocalizedString::setApplicationDomain("tutorial1");
   
    // 3
     KAboutData aboutData(
     KAboutData aboutData(
                         // The program name used internally. (componentName)
                         // The program name used internally. (componentName)
                         QStringLiteral("tutorial2"),
                         QStringLiteral("tutorial2"),
                         // A displayable program name string. (displayName)
                         // A displayable program name string. (displayName)
                        // 4
                         i18n("Tutorial 2"),
                         i18n("Tutorial 2"),
                         // The program version string. (version)
                         // The program version string. (version)
Line 99: Line 106:
                         i18n("A simple text area"),
                         i18n("A simple text area"),
                         // The license this code is released under
                         // The license this code is released under
                        // 5
                         KAboutLicense::GPL,
                         KAboutLicense::GPL,
                         // Copyright Statement (copyrightStatement = QString())
                         // Copyright Statement (copyrightStatement = QString())
Line 108: Line 114:
                         // The program homepage string. (homePageAddress = QString())
                         // The program homepage string. (homePageAddress = QString())
                         QStringLiteral("http://example.com/"),
                         QStringLiteral("http://example.com/"),
                         // The bug report email address (bugsEmailAddress = QLatin1String("[email protected]")
                         // The bug report email address
                        // (bugsEmailAddress = QLatin1String("[email protected]")
                         QStringLiteral("[email protected]"));
                         QStringLiteral("[email protected]"));
   
     aboutData.addAuthor(i18n("Name"), i18n("Task"), QStringLiteral("[email protected]"),
     aboutData.addAuthor(i18n("Name"), i18n("Task"), QStringLiteral("[email protected]"), QStringLiteral("http://your.website.com"), QStringLiteral("OSC Username"));
                        QStringLiteral("http://your.website.com"), QStringLiteral("OSC Username"));
   
    // 6
     KAboutData::setApplicationData(aboutData);
     KAboutData::setApplicationData(aboutData);
   
   
    // 7
     QCommandLineParser parser;
     QCommandLineParser parser;
     parser.addHelpOption();
     parser.addHelpOption();
Line 130: Line 134:
}
}
</syntaxhighlight>
</syntaxhighlight>
The only new lines here (compared to Tutorial 1) are 9, 49 and 50. On line 49, we create our MainWindow object and then on line 50, we display it.


====Notes====
==CMake==
 
The best way to build the program is to use CMake. We add <tt>mainwindow.cpp</tt> to the sources list, include the XmlGui and TextEdit frameworks, and replace all <tt>tutorial1</tt> text to <tt>tutorial2</tt>.
# no more KApplication https://community.kde.org/Frameworks/Porting_Notes#Application
# no more KAboutAdata catalogName https://community.kde.org/Frameworks/Porting_Notes#KAboutData
# new KAboutData constructor http://api.kde.org/frameworks-api/frameworks5-apidocs/kcoreaddons/html/classKAboutData.html
# use i18n for general and immediate cases, ki18n for special KF5 Cookbook https://books.kde.org/frameworks5/KDE-Frameworks-Cookbook.html#writing-messages
# license keys http://api.kde.org/frameworks-api/frameworks5-apidocs/kcoreaddons/html/classKAboutLicense.html#a29386ce80267871552aedd21d9ce6bbb
# Set about data https://mail.kde.org/pipermail/kde-frameworks-devel/2015-June/024983.html
# new way to parse command line arguments https://community.kde.org/Frameworks/Porting_Notes#KCmdLineArgs


==CMake==


Add KXmlGui and KTextWidgets frameworks.
Add KXmlGui and KTextWidgets frameworks.
Line 150: Line 147:
project (tutorial2)
project (tutorial2)


#1
cmake_minimum_required(VERSION 2.8.12 FATAL_ERROR)
cmake_minimum_required(VERSION 2.8.12 FATAL_ERROR)
set(QT_MIN_VERSION "5.3.0")
set(QT_MIN_VERSION "5.3.0")
set(KF5_MIN_VERSION "5.2.0")
set(KF5_MIN_VERSION "5.2.0")


#2
find_package(ECM 1.0.0 REQUIRED NO_MODULE)
find_package(ECM 1.0.0 REQUIRED NO_MODULE)
set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${ECM_KDE_MODULE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake)


include(KDEInstallDirs)
include(KDEInstallDirs)
Line 164: Line 159:
include(FeatureSummary)
include(FeatureSummary)


# Find Qt modules
find_package(Qt5 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS  
find_package(Qt5 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS  
     Core    # QCommandLineParser, QStringLiteral
     Core    # QCommandLineParser, QStringLiteral
Line 170: Line 164:
)
)


# Find KDE modules
find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS
find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS
     CoreAddons      # KAboutData
     CoreAddons      # KAboutData
Line 177: Line 170:
     TextWidgets    # KTextEdit
     TextWidgets    # KTextEdit
)
)
   


feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES)
feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES)
      
      
set(tutorial1_SRCS main.cpp mainwindow.cpp)
set(tutorial2_SRCS main.cpp mainwindow.cpp)


# just plain add_executable
add_executable(tutorial2 ${tutorial2_SRCS})
add_executable(tutorial2 ${tutorial1_SRCS})


# module-based linking
target_link_libraries(tutorial2
target_link_libraries(tutorial2
     Qt5::Widgets
     Qt5::Widgets
Line 198: Line 188:
</syntaxhighlight>
</syntaxhighlight>


====Notes====
=== Compile and run ===
 
The best way to compile, link and run it is to [[Getting_Started/Build|set up a correct build environment]]. But for a simple tutorial like this, it's enough to just create a build directory and build from there. This command takes cafe of all of that in one line:
# KF5 Cookbook https://books.kde.org/frameworks5/KDE-Frameworks-Cookbook.html#adding-threadweaver-to-a-project---an-introduction-to-the-frameworks-5-build-system
<syntaxhighlight lang="bash">
# https://community.kde.org/Frameworks/Porting_Notes#Build_System
mkdir build && cd build && cmake .. && make && ./tutorial2
</syntaxhighlight>


==TODO==
==Moving On==
Now you can move on to [[Development/Tutorials/Using_KActions/KF5|using KActions]].


warning: ‘virtual void KMainWindow::showAboutApplication()’ is deprecated [-Wdeprecated-declarations]
[[Category:C++]]
/usr/include/KF5/KXmlGui/kmainwindow.h:604:37: note: declared here
    virtual KXMLGUI_DEPRECATED void showAboutApplication() {}

Latest revision as of 18:00, 18 April 2020

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

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.


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 and is part of the KF5::XmlGui framework). 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.

mainwindow.h

#ifndef MAINWINDOW_H
#define MAINWINDOW_H
 
#include <KXmlGuiWindow>

class KTextEdit;
 
class MainWindow : public KXmlGuiWindow
{
  public:
    MainWindow(QWidget *parent=0);
 
  private:
    KTextEdit* textArea;
};
 
#endif

First we Subclass KXmlGuiWindow on line 8 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 niceties like cursor auto-hiding.

mainwindow.cpp

#include <KTextEdit>

#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 7 we initialise our text editor with an object. Then on line 8 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).

Back to main.cpp

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

main.cpp

#include <cstdlib>
 
#include <QApplication>
#include <QCommandLineParser>

#include <KAboutData>
#include <KLocalizedString>

#include "mainwindow.h"
 
int main (int argc, char *argv[])
{
    QApplication app(argc, argv);
    KLocalizedString::setApplicationDomain("tutorial2");
    
    KAboutData aboutData(
                         // The program name used internally. (componentName)
                         QStringLiteral("tutorial2"),
                         // A displayable program name string. (displayName)
                         i18n("Tutorial 2"),
                         // The program version string. (version)
                         QStringLiteral("1.0"),
                         // Short description of what the app does. (shortDescription)
                         i18n("A simple text area"),
                         // The license this code is released under
                         KAboutLicense::GPL,
                         // Copyright Statement (copyrightStatement = QString())
                         i18n("(c) 2015"),
                         // Optional text shown in the About box.
                         // Can contain any information desired. (otherText)
                         i18n("Some text..."),
                         // The program homepage string. (homePageAddress = QString())
                         QStringLiteral("http://example.com/"),
                         // The bug report email address
                         // (bugsEmailAddress = QLatin1String("[email protected]")
                         QStringLiteral("[email protected]"));
    aboutData.addAuthor(i18n("Name"), i18n("Task"), QStringLiteral("[email protected]"),
                         QStringLiteral("http://your.website.com"), QStringLiteral("OSC Username"));
    KAboutData::setApplicationData(aboutData);
 
    QCommandLineParser parser;
    parser.addHelpOption();
    parser.addVersionOption();
    aboutData.setupCommandLine(&parser);
    parser.process(app);
    aboutData.processCommandLine(&parser);
    
    MainWindow* window = new MainWindow();
    window->show();
    
    return app.exec();
}

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

CMake

The best way to build the program is to use CMake. We add mainwindow.cpp to the sources list, include the XmlGui and TextEdit frameworks, and replace all tutorial1 text to tutorial2.


Add KXmlGui and KTextWidgets frameworks.

CMakeLists.txt

project (tutorial2)

cmake_minimum_required(VERSION 2.8.12 FATAL_ERROR)
set(QT_MIN_VERSION "5.3.0")
set(KF5_MIN_VERSION "5.2.0")

find_package(ECM 1.0.0 REQUIRED NO_MODULE)
set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

include(KDEInstallDirs)
include(KDECMakeSettings)
include(KDECompilerSettings)
include(FeatureSummary)

find_package(Qt5 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS 
    Core    # QCommandLineParser, QStringLiteral
    Widgets # QApplication 
)

find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS
    CoreAddons      # KAboutData
    I18n            # KLocalizedString
    XmlGui          # KXmlGuiWindow
    TextWidgets     # KTextEdit
)

feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES)
    
set(tutorial2_SRCS main.cpp mainwindow.cpp)

add_executable(tutorial2 ${tutorial2_SRCS})

target_link_libraries(tutorial2
    Qt5::Widgets
    KF5::CoreAddons
    KF5::I18n
    KF5::XmlGui
    KF5::TextWidgets
)

install(TARGETS tutorial2  ${INSTALL_TARGETS_DEFAULT_ARGS})

Compile and run

The best way to compile, link and run it is to set up a correct build environment. But for a simple tutorial like this, it's enough to just create a build directory and build from there. This command takes cafe of all of that in one line:

mkdir build && cd build && cmake .. && make && ./tutorial2

Moving On

Now you can move on to using KActions.