Development/Tutorials/First program/fr

Bonjour le monde

Tutorial Series	Tutoriel du débutant
Previous	C++, Qt, Construire KDE
What's Next	Tutoriel 2 - KXmlGuiWindow
Further Reading	CMake

Résumé

Votre premier programme va saluer le monde à l'aide du fameux "Bonjour le monde" ("Hello World"), quoi de plus ? Pour cela, nous utiliserons une KMessageBox dont nous adapterons l'un des boutons.

Tip

Pour obtenir plus d'informations sur une classe que vous rencontrez, vous pouvez utiliser le moteur de recherche de ‘kde’ . Par exemple, pour chercher des informations sur KMessageBox, il suffit de taper "kde:kmessagebox" dans Konqueror, Rekonq ou KRunner, pour être redirigé vers la documentation.

Astuce

Vous pouvez utiliser KDevelop ou QtCreator comme environnement de développement (IDE) pour vos projets.

Le code

Tout le code dont nous avons besoin sera dans un fichier, main.cpp. Créez ce ficher et copiez le code ci-dessous :

#include <QApplication>
#include <QCommandLineParser>
#include <KAboutData>
#include <KLocalizedString>
#include <KMessageBox>

int main (int argc, char *argv[])
{
    QApplication app(argc, argv);
    KLocalizedString::setApplicationDomain("tutorial1");

    
    KAboutData aboutData(
                         // The program name used internally. (componentName)
                         QStringLiteral("tutorial1"),
                         // A displayable program name string. (displayName)
                         i18n("Tutorial 1"),
                         // The program version string. (version)
                         QStringLiteral("1.0"),
                         // Short description of what the app does. (shortDescription)
                         i18n("Displays a KMessageBox popup"),
                         // 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;
    aboutData.setupCommandLine(&parser);
    parser.process(app);
    aboutData.processCommandLine(&parser);
    
    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;
}

D'abord il faut créer un objet QApplication . Ceci doit être fait absolument une fois dans chaque programme car il est utilisé pour des choses comme le i18n. Il doit aussi être créé avant les objets KDE et Qt. Un appel à KLocalizedString::setApplicationDomain() est nécessaire pour initialiser proprement le catalogue de traduction et doit être fait avant d'enchaîner les étapes suivantes.

Le premier objet spécifique KDE que nous créons dans ce programme est KAboutData. C'est la classe qui est utilisée pour ranger les informations concernant le programme telles qu'une courte description, les auteurs ou les informations de licence. Chaque application KDE devrait plutôt utiliser cette classe. Ensuite nous appelons KAboutData::setApplicationData() pour initialiser les propriétés de l'objet QApplication .

Then we come to QCommandLineParser. 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.

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.

Remarquez que tout le texte visible par l'utilisateur est passé à la fonction i18n() ; ceci est nécessaire pour que l'interface utilisateur soit traduisible. Davantage d'information sur la localisation est disponible dans le tutoriel localisation.

Voila pour tout ce qui concerne le code. Passons maintenant à la compilation et aux essais.

Edition de liens (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.

CMakeLists.txt

Créer un fichier CMakeLists.txt dans le même répertoire que main.cpp avec le contenu suivant :

cmake_minimum_required(VERSION 3.0)

project (tutorial1)

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} ${ECM_KDE_MODULE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

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

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

# Find KDE modules
find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS
    CoreAddons      # KAboutData
    I18n            # KLocalizedString
    WidgetsAddons   # KMessageBox
)

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

add_executable(tutorial1 ${tutorial1_SRCS})

target_link_libraries(tutorial1
    Qt5::Widgets
    KF5::CoreAddons
    KF5::I18n
    KF5::WidgetsAddons
)

install(TARGETS tutorial1  ${KDE_INSTALL_TARGETS_DEFAULT_ARGS})

La fonction find_package() localise le paquetage que vous demandez (dans ce cas ECM, Qt5, ou KF5) et initialise quelques variables décrivant les chemins vers les fichiers header et les libraires. Les modules ECM, ou Extra CMake, sont nécessaires pour importer les fichiers CMake et les fonctions spéciales pour construire des applications KDE.

Here we try to find the modules for Qt 5 and KDE Frameworks 5 required to build our tutorial. The necessary files are included by CMake so that the compiler can see them at build time. Minimum version numbers are set at the very top of CMakeLists.txt file for easier reference.

Ensuite nous créons une variable appelée tutorial1_SRCS en utilisant la fonction set() . Dans ce cas nous l'initialisons simplement avec le nom de notre unique fichier source.

Then we use 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 necessary libraries using target_link_libraries() function. The line starting with install writes a default "install" target into the Makefile.

Make et exécution

Pour compiler, éditer les liens et installer votre programme, vous devez disposer de plusieurs logiciels, comme par exemple cmake, make et gcc-c++, et les fichiers de développement de Qt 5 et du Framework KDE. Assurez-vous que vous avez tout; le mieux étant de suivre ce guide d'installation.

Alors que vous pouvez exécuter le cmake directement dans votre répertoire où se trouvent les fichiers source de votre application, il est préférable - et ceci est actuellement encouragé dans plusieurs logiciels KDE - d'utiliser un répertoire « build  » de compilation séparé, à partir duquel vous lancerez le cmake :

mkdir build && cd build

You can invoke CMake and make manually:

cmake .. && make

Et exécutez le avec :

./tutorial1

Pour aller plus loin

Vous pouvez maintenant passer à utiliser KXmlGuiWindow.

Le code source sur cette page s'applique seulement à la version courante de l'environnement de développement KDE Frameworks 5 ("KF5"). Pour la plateforme de développement plus ancienne ("KDE4"), voir Special:myLanguage/Development/Tutorials/First_program/KDE4