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.

Astuce

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");

    
    <nowiki>
KAboutData aboutData(
                         // Nom du programme utilisé en interne. (componentName)
                         QStringLiteral("tutorial1"),
                         // Nom du programme en tant que chaîne affichable. (displayName)
                         i18n("Tutorial 1"),
                         // Chaîne de caractères représentant la version du programme. (version)
                         QStringLiteral("1.0"),
                         // Courte description de ce que fait l'application. (shortDescription)
                         i18n("Displays a KMessageBox popup"),
                         // Licence sous laquelle ce code est diffusé
                         KAboutLicense::GPL,
                         // Déclaration de droits d'auteur (copyrightStatement = QString())
                         i18n("(c) 2015"),
                         // Texte facultatif affiché dans la boîte 'A  propos'.
                         // Peut contenir toute information  utile. (otherText)
                         i18n("Some text..."),
                         // Chaîne de caractères représentant la page d'accueil du programme. (homePageAddress = QString())
                         QStringLiteral("http://example.com/"),
                         // L'adresse courriel où envoyer les rapports de bogue
                         // (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);
</nowiki><!--) to solve misbalanced bracket-->

    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 Framework 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 Framework 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 .

Puis nous arrivons à QCommandLineParser. C'est la classe à utiliser pour spécifier les sélecteurs sur la ligne de commande pour, par exemple, ouvrir le programme avec un ficher spécifique. Néanmoins, dans ce tutoriel, nous l'initialisons simplement avec l'objet KAboutData que nous avons créé afin de pouvoir utiliser les sélecteurs --version ou --author.

Maintenant nous avons fait toute l'initialisation KDE nécessaire, et nous pouvons commencer à faire des choses intéressantes avec notre application. Nous allons créer une fenêtre qui s'ouvre mais en presonalisant un de ses boutons. Pour faire cette adaptation, nous avons besoin de d'utiliser un objet KGuiItem . Le premier argument du constructeur de KGuiItem est le texte à afficher sur l'élément (dans notre cas, le bouton). Puis nous avons une option pour définir une icône pour le bouton mais nous n'en voulons pas donc nous passons simplement QString(). Nous fixons ensuite l'infobulle (ce qui apparait quand vous survolez un élément) et finalement le texte du "Qu'est-ce que c'est ?" (accédé via le clic-droit ou par Maj-F1).

Nous avons maintenant notre élément et pouvons créer notre fenêtre. Nous appelons la fonction KMessageBox::questionYesNo() qui, par défaut, crée une boîte de message avec un bouton "Yes" et un bouton "No" . Le deuxième argument est le texte à afficher dans la boîte de message au-dessus des boutons. Le troisième est le titre de la fenêtre et finalement, nous initialisons le KGuiItem pour (ce qui normalement serait) le bouton "Yes" avec le KGuiItem yesButton que nous avons créé.

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)

Vous voulez utiliser CMake pour votre environnement de compilation. Vous fournissez alors un fichier CMakeLists.txt; cmake part de ce fichier pour générer tous les Makefiles.

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} ${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.

Ici nous tentons de trouver les modules pour Qt 5 et le KDE Frameworks 5, nécessaires pour compiler notre tutoriel. Ces fichers sont inclus par CMake pour que le compilateur les voit au moment du build. Les nombres des versions minimales sont définis tout en haut du fichier CMakeLists.txt pour s'y référer plus facilement.

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.

Puis nous utilisons add_executable() pour créer un exécutable appelé tutorial1 à partir des fichiers source listés dans notre variable tutorial1_SRCS . Après quoi, nous faisons l'édition de liens de notre exécutable avec les bibliothèques nécessaires en utilisant la fonction target_link_libraries() . La ligne qui commence par install écrit une cible d' "installation" par défault dans le 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.