Development/Tutorials/First program/fr: Difference between revisions

    From KDE TechBase
    (Created page with "Ensuite nous créons une variable appelée <tt>tutorial1_SRCS</tt> en utilisant la fonction <tt>set()</tt> . Dans ce cas nous l'initialisons simplement avec le nom de notre un...")
    (Created page with "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 actuell...")
    Line 167: Line 167:
    To compile, link and install your program, you must have several software installed, e.g. cmake, make and gcc-c++, and the Qt 5 and KDE Frameworks development files. To be sure you have everything, best follow [[Special:myLanguage/Getting_Started/Build/Environment|this install guide]].
    To compile, link and install your program, you must have several software installed, e.g. cmake, make and gcc-c++, and the Qt 5 and KDE Frameworks development files. To be sure you have everything, best follow [[Special:myLanguage/Getting_Started/Build/Environment|this install guide]].


    While you can run cmake directly inside the source code directory itself, it is a best practice, and actually enforced in some KDE software, to use a separate build directory and run cmake from there:
    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 :


    <syntaxhighlight lang="bash">
    <syntaxhighlight lang="bash">

    Revision as of 14:38, 21 March 2018

    Other languages:
    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
    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
    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 <cstdlib>
    
    #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;
    }
    

    First we need to create a QApplication object. This needs to be done exactly once in each program since it is needed for things such as i18n. It also should be created before any other KDE or Qt object. A call to KLocalizedString::setApplicationDomain() is required to properly set the translation catalog and must be done before the next step happens.

    The first KDE specific object we create 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. We then call KAboutData::setApplicationData() to initialize the properties of the QApplication object.

    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.

    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.

    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 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} ${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})
    
    <!--T:54-->
    target_link_libraries(tutorial1
        Qt5::Widgets
        KF5::CoreAddons
        KF5::I18n
        KF5::WidgetsAddons
    )
    
    install(TARGETS tutorial1  ${KDE_INSTALL_TARGETS_DEFAULT_ARGS})
    

    The find_package() function locates the package that you ask it for (in this case ECM, Qt5, or KF5) and sets some variables describing the location of the package's headers and libraries. ECM, or Extra CMake Modules, is required to import special CMake files and functions for building KDE applications.

    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

    To compile, link and install your program, you must have several software installed, e.g. cmake, make and gcc-c++, and the Qt 5 and KDE Frameworks development files. To be sure you have everything, best follow this install guide.

    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 à using 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