Difference between revisions of "Development/Tutorials/First program"

Jump to: navigation, search
m (CMakeLists.txt)
 
(43 intermediate revisions by 24 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Development/Tutorials/First_program}}
+
<languages />
 +
 
 
{{TutorialBrowser|
 
{{TutorialBrowser|
  
 +
<translate>
 +
 +
<!--T:1-->
 
series=Beginner Tutorial|
 
series=Beginner Tutorial|
  
 +
<!--T:2-->
 
name=Hello World|
 
name=Hello World|
  
pre=[http://mindview.net/Books/TICPP/ThinkingInCPP2e.html C++], [http://www.trolltech.com/products/qt/ Qt], [[Getting_Started/Build/KDE4|KDE4 development environment]]|
+
<!--T:3-->
 +
pre=[http://mindview.net/Books/TICPP/ThinkingInCPP2e.html C++], [http://qt.nokia.com Qt], [[Getting_Started/Build|Building KDE]]|
  
 +
<!--T:4-->
 
next=[[Development/Tutorials/Using_KXmlGuiWindow|Tutorial 2 - KXmlGuiWindow]]|  
 
next=[[Development/Tutorials/Using_KXmlGuiWindow|Tutorial 2 - KXmlGuiWindow]]|  
  
 +
<!--T:5-->
 
reading=[[Development/Tutorials/CMake|CMake]]
 
reading=[[Development/Tutorials/CMake|CMake]]
 
}}
 
}}
  
==Abstract==
+
==Abstract== <!--T:6-->
 +
 
 +
<!--T:7-->
 
Your first program shall greet the world with a friendly "Hello World", what else? For that, we will use a {{class|KMessageBox}} and customise one of the buttons.
 
Your first program shall greet the world with a friendly "Hello World", what else? For that, we will use a {{class|KMessageBox}} and customise one of the buttons.
 
[[image:introtokdetutorial1.png|frame|center]]
 
[[image:introtokdetutorial1.png|frame|center]]
  
{{tip|To get more information about any class you come across, Konqueror offers a quick shortcut. So to look for information about KMessageBox, just type "kde:kmessagebox" into Konqueror and you'll be taken to the documentation.}}
+
<!--T:8-->
 
+
{{Tip|To get more information about any class you come across, you can use the ‘kde’ search engine. For example, to look for information about KMessageBox, just type "kde:kmessagebox" into Konqueror, Rekonq or KRunner, and you’ll be taken to the documentation.}}
{{tip|
+
You might want to use KDevelop for your projects, which does many nice things like code completion, easy access to API documentation or debugging support.
+
  
Read [[Getting_Started/Set_up_KDE_4_for_development#KDevelop|this tutorial]] to set up KDevelop correctly for this task. You probably want to check if the setup is working by testing opening an existing KDE 4 application with KDevelop first.
+
<!--T:9-->
 
+
{{Tip|
You still need to edit the CMake files by hand though.
+
You might want to use [[qtcreator|QtCreator]] as IDE for your projects.
 
}}
 
}}
  
==The Code==
+
==The Code== <!--T:10-->
 +
 
 +
<!--T:11-->
 
All the code we need will be in one file, <tt>main.cpp</tt>. Create that file with the code below:
 
All the code we need will be in one file, <tt>main.cpp</tt>. Create that file with the code below:
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
#include <QString>
+
#include <cstdlib>
 +
 
 +
<!--T:12-->
 
#include <KApplication>
 
#include <KApplication>
 
#include <KAboutData>
 
#include <KAboutData>
#include <KMessageBox>
 
 
#include <KCmdLineArgs>
 
#include <KCmdLineArgs>
#include <KLocalizedString>
+
#include <KMessageBox>
 +
#include <KLocale>
  
 +
<!--T:13-->
 
int main (int argc, char *argv[])
 
int main (int argc, char *argv[])
 
{
 
{
     KAboutData aboutData("tutorial1",                  // The program name used internally.
+
     KAboutData aboutData(
                         0,                           // The message catalog name, use program name if null.
+
                        // The program name used internally.
                         ki18n("Tutorial 1"),         // A displayable program name string.
+
                         "tutorial1",
                         "1.0",                       // The program version string.
+
                        // The message catalog name
                         ki18n("KMessageBox popup"),   // A short description of what the program does.
+
                        // If null, program name is used instead.
                         KAboutData::License_GPL,     // License identifier
+
                        0,
                         ki18n("(c) 2007"),           // Copyright Statement
+
                        // A displayable program name string.
                         ki18n("Some text..."),       // Some free form text, that can contain any kind of information.
+
                         ki18n("Tutorial 1"),
                         "http://tutorial.com",       // The program homepage string.
+
                        // The program version string.
                         "submit@bugs.kde.org");       // The bug report email address string.
+
                         "1.0",
 +
                        // Short description of what the app does.
 +
                         ki18n("Displays a KMessageBox popup"),
 +
                        // The license this code is released under
 +
                         KAboutData::License_GPL,
 +
                        // Copyright Statement
 +
                         ki18n("(c) 2007"),
 +
                        // Optional text shown in the About box.
 +
                        // Can contain any information desired.
 +
                         ki18n("Some text..."),
 +
                        // The program homepage string.
 +
                         "http://example.com/",
 +
                        // The bug report email address
 +
                         "submit@bugs.kde.org");
  
     KCmdLineArgs::init( argc, argv, &aboutData );
+
     <!--T:14-->
 +
KCmdLineArgs::init( argc, argv, &aboutData );
 
     KApplication app;
 
     KApplication app;
     KGuiItem guiItem( QString( "Hello" ), QString(),
+
     KGuiItem yesButton( i18n( "Hello" ), QString(),
                      QString( "this is a tooltip" ),
+
                        i18n( "This is a tooltip" ),
                      QString( "this is a whatsthis" ) );
+
                        i18n( "This is a WhatsThis help text." ) );
     KMessageBox::questionYesNo( 0, "Hello World", "Hello", guiItem );
+
     return
 +
        KMessageBox ::questionYesNo  
 +
        (0, i18n( "Hello World" ), i18n( "Hello" ), yesButton )  
 +
        == KMessageBox ::Yes? EXIT_SUCCESS: EXIT_FAILURE;
 
}
 
}
</code>
+
</syntaxhighlight>
 
The first KDE specific code we come across in this program is {{class|KAboutData}}. This is the class used to store information about the program such as a short description, authors or license information. Pretty much every KDE application should use this class.
 
The first KDE specific code we come across in this program is {{class|KAboutData}}. This is the class used to store information about the program such as a short description, authors or license information. Pretty much every KDE application should use this class.
  
 +
<!--T:15-->
 
Then we come to {{class|KCmdLineArgs}}. This is the class one would use to specify command line switches to, for example, open the program with a specific file. However, in this tutorial, we simply initialise it with the {{class|KAboutData}} object we created so we can use the <tt>--version</tt> or <tt>--author</tt> switches.
 
Then we come to {{class|KCmdLineArgs}}. This is the class one would use to specify command line switches to, for example, open the program with a specific file. However, in this tutorial, we simply initialise it with the {{class|KAboutData}} object we created so we can use the <tt>--version</tt> or <tt>--author</tt> switches.
  
 +
<!--T:16-->
 
Then we create a {{class|KApplication}} object. This needs to be done exactly once in each program since it is needed for things such as [[Development/Tutorials/Localization/i18n|i18n]].
 
Then we create a {{class|KApplication}} object. This needs to be done exactly once in each program since it is needed for things such as [[Development/Tutorials/Localization/i18n|i18n]].
  
Now we've done all the necessary KDE setup, we can move on to doing interesting things with our application. We're going to create a popup box but we're going to customise one of the buttons. To do this customisation, we need to use a {{class|KGuiItem}} object. The first argument in the {{class|KGuiItem}} constructor is the text that will appear on the item (in our case, a button). Then we have an option of setting an icon for the button but we don't want one so we just give it <tt>QString()</tt>. Finally we set the tooltip (what appears when you hover over an item) and finally the "What's This?" (accessed through right-clicking or Shift-F1) text.
+
<!--T:17-->
 +
Now we've done all the necessary KDE setup, we can move on to doing interesting things with our application. We're going to create a popup box but we're going to customise one of the buttons. To do this customisation, we need to use a {{class|KGuiItem}} object. The first argument in the {{class|KGuiItem}} constructor is the text that will appear on the item (in our case, a button). Then we have an option of setting an icon for the button but we don't want one so we just give it <tt>QString()</tt>. We then set the tooltip (what appears when you hover over an item) and finally the "What's This?" (accessed through right-clicking or Shift-F1) text.
  
Now we have our item, we can create our popup. We call the <tt>{{class|KMessageBox}}::questionYesNo()</tt> function which, by default, creates a message box with a "Yes" and a "No" button. The second argument is the text that will appear in the middle of the popup box. The third is the caption the window will have and finally we set the KGuiItem for (what would normally be) the "Yes" button to the <tt>KGuiItem guiItem</tt> we created.
+
<!--T:18-->
 +
Now we have our item, we can create our popup. We call the <tt>{{class|KMessageBox}}::questionYesNo()</tt> function which, by default, creates a message box with a "Yes" and a "No" button. The second argument is the text that will appear in the message box above the buttons. The third is the caption the window will have and finally we set the KGuiItem for (what would normally be) the "Yes" button to the <tt>KGuiItem yesButton</tt> we created.
  
 +
<!--T:19-->
 +
Note that all user-visible text is passed through the i18n() function; this is necessary for the UI to be translatable. More information on localization can be found in the [[Development/Tutorials/Localization/i18n|localization tutorial]].
 +
 +
<!--T:20-->
 
We're all done as far as the code is concerned. Now to build it and try it out.
 
We're all done as far as the code is concerned. Now to build it and try it out.
  
==Build==
+
== Build == <!--T:21-->
If you set up your environment as described in [[Getting Started/Build/KDE4]], you can compile this code with
+
+
g++ main.cpp -o tutorial1 \
+
-I$QTDIR/include/Qt \
+
-I$QTDIR/include/QtCore \
+
-I$QTDIR/include \
+
-I$KDEDIR/include/KDE \
+
-I$KDEDIR/include \
+
-L$KDEDIR/lib \
+
-L$QTDIR/lib -lQtCore -lQtGui -lkdeui -lkdecore
+
and then run it with
+
dbus-launch ./tutorial1
+
  
===Using CMake===
+
<!--T:22-->
If that worked, you may want to use [[Development/Tutorials/CMake|CMake]], just like the rest of KDE. This will automatically locate the libraries and headers for KDE, Qt etc. and will allow you to easily build your applications on other computers.
+
You want to [[Development/Tutorials/CMake|use CMake]] for your build environment. You provide a file CMakeLists.txt, cmake uses this file to generate all Makefiles out of it.
====CMakeLists.txt====
+
 
 +
=== CMakeLists.txt === <!--T:23-->
 +
 
 +
<!--T:24-->
 
Create a file named CMakeLists.txt in the same directory as main.cpp with this content:
 
Create a file named CMakeLists.txt in the same directory as main.cpp with this content:
<code ini n>
+
<syntaxhighlight lang="cmake">
 
project (tutorial1)
 
project (tutorial1)
 
 
find_package(KDE4 REQUIRED)
 
find_package(KDE4 REQUIRED)
 +
include (KDE4Defaults)
 
include_directories(${KDE4_INCLUDES})
 
include_directories(${KDE4_INCLUDES})
 
 
set(tutorial1_SRCS main.cpp)
 
set(tutorial1_SRCS main.cpp)
 
 
kde4_add_executable(tutorial1 ${tutorial1_SRCS})
 
kde4_add_executable(tutorial1 ${tutorial1_SRCS})
 
target_link_libraries(tutorial1 ${KDE4_KDEUI_LIBS})
 
target_link_libraries(tutorial1 ${KDE4_KDEUI_LIBS})
</code>
+
install(TARGETS tutorial1  ${INSTALL_TARGETS_DEFAULT_ARGS})
 +
</syntaxhighlight>
 
The <tt>find_package()</tt> function locates the package that you ask it for (in this case KDE4) and sets some variables describing the location of the package's headers and libraries. In this case we will use the <tt>KDE4_INCLUDES</tt> variable which contains the path to the KDE4 header files.
 
The <tt>find_package()</tt> function locates the package that you ask it for (in this case KDE4) and sets some variables describing the location of the package's headers and libraries. In this case we will use the <tt>KDE4_INCLUDES</tt> variable which contains the path to the KDE4 header files.
  
 +
<!--T:25-->
 
In order to allow the compiler to find these files, we pass that variable to the <tt>include_directories()</tt> function which adds the KDE4 headers to the header search path.
 
In order to allow the compiler to find these files, we pass that variable to the <tt>include_directories()</tt> function which adds the KDE4 headers to the header search path.
  
 +
<!--T:26-->
 
Next we create a variable called <tt>tutorial1_SRCS</tt> using the <tt>set()</tt> function. In this case we simply set it to the name of our only source file.
 
Next we create a variable called <tt>tutorial1_SRCS</tt> using the <tt>set()</tt> function. In this case we simply set it to the name of our only source file.
  
Then we use <tt>kde4_add_executable()</tt> to create an executable called <tt>tutorial1</tt> from the source files listed in our <tt>tutorial1_SRCS</tt> variable. Finally we link our executable to the KDE4 kdeui library using <tt>target_link_libraries()</tt> and the <tt>KDE4_KDEUI_LIBS</tt> variable which was set by the <tt>find_package()</tt> function.
+
<!--T:27-->
 +
Then we use <tt>kde4_add_executable()</tt> to create an executable called <tt>tutorial1</tt> from the source files listed in our <tt>tutorial1_SRCS</tt> variable. Afterwards, we link our executable to the KDE4 kdeui library using <tt>target_link_libraries()</tt> and the <tt>KDE4_KDEUI_LIBS</tt> variable which was set by the <tt>find_package()</tt> function. The line starting with <tt>install</tt> writes a default "install" target into the Makefile.
  
====Make And Run====
+
=== Make And Run === <!--T:28-->
Again, if you set up your environment as described in [[Getting_Started/Build/KDE4|Getting Started/Build/KDE4]], you can compile this code with:
+
cmakekde
+
  
Or if you did not:
+
<!--T:29-->
 +
To compile, link and install your program, you must have several software installed, e.g. kdelibs, cmake, make and gcc-c++. To be sure you have everything, best follow [[Getting_Started/Build/Environment|this install guide]].
  
mkdir build
+
<!--T:30-->
cd build
+
You can invoke CMake and make manually:
cmake .. && make
+
<syntaxhighlight lang="bash">
 +
cmake . && make && make install
 +
</syntaxhighlight>
 +
Or, if you set up your environment as described in [[Getting_Started/Build/Environment|Getting Started/Build/Environment]], you can compile this code with:
 +
<syntaxhighlight lang="bash">
 +
cmakekde
 +
</syntaxhighlight>
  
And launch it as:
+
<!--T:31-->
./tutorial1.shell
+
And launch it with:
 +
<syntaxhighlight lang="bash">
 +
./tutorial1
 +
</syntaxhighlight>
  
==Moving On==
+
==Moving On== <!--T:32-->
 +
 
 +
<!--T:33-->
 
Now you can move on to [[Development/Tutorials/Using_KXmlGuiWindow|using KXmlGuiWindow]].
 
Now you can move on to [[Development/Tutorials/Using_KXmlGuiWindow|using KXmlGuiWindow]].
  
 +
<!--T:34-->
 
[[Category:C++]]
 
[[Category:C++]]
 +
 +
</translate>

Latest revision as of 19:44, 12 July 2012

Other languages:English 100% • ‎Dutch 96%
Hello World
Tutorial Series   Beginner Tutorial
Previous   C++, Qt, Building KDE
What's Next   Tutorial 2 - KXmlGuiWindow
Further Reading   CMake

Contents

[edit] Abstract

Your first program shall greet the world with a friendly "Hello World", what else? For that, we will use a KMessageBox and customise one of the buttons.

Introtokdetutorial1.png
Ktip.png
 
Tip
To get more information about any class you come across, you can use the ‘kde’ search engine. For example, to look for information about KMessageBox, just type "kde:kmessagebox" into Konqueror, Rekonq or KRunner, and you’ll be taken to the documentation.


Ktip.png
 
Tip
You might want to use QtCreator as IDE for your projects.


[edit] The Code

All the code we need will be in one file, main.cpp. Create that file with the code below:

#include <cstdlib>
 
#include <KApplication>
#include <KAboutData>
#include <KCmdLineArgs>
#include <KMessageBox>
#include <KLocale>
 
int main (int argc, char *argv[])
{
    KAboutData aboutData(
                         // The program name used internally.
                         "tutorial1",
                         // The message catalog name
                         // If null, program name is used instead.
                         0,
                         // A displayable program name string.
                         ki18n("Tutorial 1"),
                         // The program version string.
                         "1.0",
                         // Short description of what the app does.
                         ki18n("Displays a KMessageBox popup"),
                         // The license this code is released under
                         KAboutData::License_GPL,
                         // Copyright Statement
                         ki18n("(c) 2007"),
                         // Optional text shown in the About box.
                         // Can contain any information desired.
                         ki18n("Some text..."),
                         // The program homepage string.
                         "http://example.com/",
                         // The bug report email address
                         "submit@bugs.kde.org");
 
    KCmdLineArgs::init( argc, argv, &aboutData );
    KApplication app;
    KGuiItem yesButton( i18n( "Hello" ), QString(),
                        i18n( "This is a tooltip" ),
                        i18n( "This is a WhatsThis help text." ) );
    return 
        KMessageBox ::questionYesNo 
        (0, i18n( "Hello World" ), i18n( "Hello" ), yesButton ) 
        == KMessageBox ::Yes? EXIT_SUCCESS: EXIT_FAILURE;
}

The first KDE specific code we come across in this program is KAboutData. This is the class used to store information about the program such as a short description, authors or license information. Pretty much every KDE application should use this class.

Then we come to KCmdLineArgs. This is the class one would use to specify command line switches to, for example, open the program with a specific file. However, in this tutorial, we simply initialise it with the KAboutData object we created so we can use the --version or --author switches.

Then we create a KApplication object. This needs to be done exactly once in each program since it is needed for things such as i18n.

Now we've done all the necessary KDE setup, we can move on to doing interesting things with our application. We're going to create a popup box but we're going to customise one of the buttons. To do this customisation, we need to use a KGuiItem object. The first argument in the KGuiItem constructor is the text that will appear on the item (in our case, a button). Then we have an option of setting an icon for the button but we don't want one so we just give it QString(). We then set the tooltip (what appears when you hover over an item) and finally the "What's This?" (accessed through right-clicking or Shift-F1) text.

Now we have our item, we can create our popup. We call the KMessageBox::questionYesNo() function which, by default, creates a message box with a "Yes" and a "No" button. The second argument is the text that will appear in the message box above the buttons. The third is the caption the window will have and finally we set the KGuiItem for (what would normally be) the "Yes" button to the KGuiItem yesButton we created.

Note that all user-visible text is passed through the i18n() function; this is necessary for the UI to be translatable. More information on localization can be found in the localization tutorial.

We're all done as far as the code is concerned. Now to build it and try it out.

[edit] Build

You want to use CMake for your build environment. You provide a file CMakeLists.txt, cmake uses this file to generate all Makefiles out of it.

[edit] CMakeLists.txt

Create a file named CMakeLists.txt in the same directory as main.cpp with this content:

project (tutorial1)
find_package(KDE4 REQUIRED)
include (KDE4Defaults)
include_directories(${KDE4_INCLUDES})
set(tutorial1_SRCS main.cpp)
kde4_add_executable(tutorial1 ${tutorial1_SRCS})
target_link_libraries(tutorial1 ${KDE4_KDEUI_LIBS})
install(TARGETS tutorial1  ${INSTALL_TARGETS_DEFAULT_ARGS})

The find_package() function locates the package that you ask it for (in this case KDE4) and sets some variables describing the location of the package's headers and libraries. In this case we will use the KDE4_INCLUDES variable which contains the path to the KDE4 header files.

In order to allow the compiler to find these files, we pass that variable to the include_directories() function which adds the KDE4 headers to the header search path.

Next we create a variable called tutorial1_SRCS using the set() function. In this case we simply set it to the name of our only source file.

Then we use kde4_add_executable() to create an executable called tutorial1 from the source files listed in our tutorial1_SRCS variable. Afterwards, we link our executable to the KDE4 kdeui library using target_link_libraries() and the KDE4_KDEUI_LIBS variable which was set by the find_package() function. The line starting with install writes a default "install" target into the Makefile.

[edit] Make And Run

To compile, link and install your program, you must have several software installed, e.g. kdelibs, cmake, make and gcc-c++. To be sure you have everything, best follow this install guide.

You can invoke CMake and make manually:

cmake . && make && make install

Or, if you set up your environment as described in Getting Started/Build/Environment, you can compile this code with:

cmakekde

And launch it with:

./tutorial1

[edit] Moving On

Now you can move on to using KXmlGuiWindow.


This page was last modified on 12 July 2012, at 19:44. This page has been accessed 119,744 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