Development/Tutorials/Programming Tutorial KDE 4/KDirWatch: Difference between revisions

    From KDE TechBase
    Line 92: Line 92:
    {
    {
         KAboutData about("khello", I18N_NOOP("khello"), version,  
         KAboutData about("khello", I18N_NOOP("khello"), version,  
           description, KAboutData::License_GPL, "(C) %{YEAR} Thorsten Staerk", 0, 0, "[email protected]");
           description, KAboutData::License_GPL,  
          "(C) %{YEAR} Thorsten Staerk", 0, 0, "[email protected]");
         about.addAuthor( "Thorsten Staerk", 0, "[email protected]" );
         about.addAuthor( "Thorsten Staerk", 0, "[email protected]" );
         KCmdLineArgs::init(argc, argv, &about);
         KCmdLineArgs::init(argc, argv, &about);

    Revision as of 13:13, 19 June 2007

    Using KDirWatch

    If you want your program to be notified upon file changes, use KDirWatch. Here is an example.

    khello.h

    1. ifndef _KHELLO_H_
    2. define _KHELLO_H_
    1. include <kmainwindow.h>
    2. include <kdirwatch.h>

    /**

    * @short Application Main Window
    * @author Thorsten Staerk <[email protected]>
    * @version 0.1
    */
    

    class khello : public KMainWindow {

       Q_OBJECT
    

    public:

       KDirWatch dw;
       /**
        * Default Constructor
        */
       khello(char* args);
    

    public slots:

       void slotdirty();
    

    };

    1. endif // _KHELLO_H_

    This subclasses KMainWindow.

    khello.cpp

    1. include "khello.h"
    1. include <qlabel.h>
    1. include <kdebug.h>
    2. include <kmainwindow.h>
    3. include <klocale.h>
    4. include <kmessagebox.h>

    khello::khello(char* args)

       : KMainWindow()
    

    {

       kdDebug() << "args = " << args << endl;
       dw.addFile(args);
       kdDebug() << "Watching file " << args << endl;
       connect(&dw, SIGNAL(dirty(const QString & ) ),
              SLOT( slotdirty() ) );
    

    }

    void khello::slotdirty() {

     kdDebug() << "File has changed" << endl;
    

    }

    1. include "khello.moc"

    When instanciated, the class creates a KDirWatcher object and tells it to watch the file passed in by the arguments (dw.addFile(args)). The DirWatcher will now emit a SIGNAL dirty each time this file gets modified. This signal is connected to khello's slot slotdirty(). So, every time the file gets modified, slotdirty is called.

    main.cpp

    /* This program reacts on file changes.

    • /
    1. include "khello.h"
    2. include <kapplication.h>
    3. include <kaboutdata.h>
    4. include <kcmdlineargs.h>
    5. include <kdebug.h>
    6. include <klocale.h>

    static const char description[] =

       I18N_NOOP("A KDE KPart Application");
    

    static const char version[] = "0.1";

    static KCmdLineOptions options[] = {

       { "+[URL]", I18N_NOOP( "Document to open" ), 0 },
       KCmdLineLastOption
    

    };

    int main(int argc, char **argv) {

       KAboutData about("khello", I18N_NOOP("khello"), version, 
         description, KAboutData::License_GPL, 
         "(C) %{YEAR} Thorsten Staerk", 0, 0, "[email protected]");
       about.addAuthor( "Thorsten Staerk", 0, "[email protected]" );
       KCmdLineArgs::init(argc, argv, &about);
       KCmdLineArgs::addCmdLineOptions( options );
       KApplication app;
       khello *mainWin = 0;
    
       KCmdLineArgs *args = KCmdLineArgs::parsedArgs();
       kdDebug() << argv[1] << endl;
       mainWin = new khello(argv[1]);
       mainWin->show();
    
       args->clear();
    
       return app.exec();
    

    }

    CMake

    The best way to build the program is to use CMake.

    CMakeLists.txt

    project (tutorial2) find_package(KDE4 REQUIRED KIO KDIRWATCH) include_directories( ${KDE4_INCLUDES} ) set(tutorial2_SRCS

           main.cpp
           khello.cpp
    

    ) KDE4_AUTOMOC( ${tutorial2_SRCS} ) kde4_add_executable(tutorial2 ${tutorial2_SRCS}) target_link_libraries( tutorial2 ${KDE4_KDEUI_LIBS} ${KDE4_KIO_LIBS}) Note that we added ${KDE4_KIO_LIBS} to the target_link_libraries. If we do not do it, the linker complains about undefined symbols. In the kio-libs, KDirWatch is defined.

    Kompile it

    To compile, link and run it, use:

    cmake . && make && ./tutorial2 /var/log/messages