runtime/nepomuk/services/strigi/config.h

   1 /* This file is part of the KDE Project
   2    Copyright (c) 2008 Sebastian Trueg <trueg@kde.org>
   3
   4    This library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public
   6    License version 2 as published by the Free Software Foundation.
   7
   8    This library is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11    Library General Public License for more details.
  12
  13    You should have received a copy of the GNU Library General Public License
  14    along with this library; see the file COPYING.LIB.  If not, write to
  15    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16    Boston, MA 02110-1301, USA.
  17 */
  18
  19 #ifndef _NEPOMUK_STRIGI_CONFIG_H_
  20 #define _NEPOMUK_STRIGI_CONFIG_H_
  21
  22 #include <QtCore/QObject>
  23
  24 #include <kconfig.h>
  25 #include <kio/global.h>
  26
  27
  28 namespace Nepomuk {
  29     /**
  30      * Active config class which emits signals if the config
  31      * was changed, for example if the KCM saved the config file.
  32      */
  33     class Config : public QObject
  34     {
  35         Q_OBJECT
  36
  37     public:
  38         ~Config();
  39         static Config* self();
  40
  41         /**
  42          * The folders to search for files to analyze
  43          */
  44         QStringList folders() const;
  45
  46         /**
  47          * The folders that should be excluded.
  48          * It is perfectly possible to include subfolders again.
  49          */
  50         QStringList excludeFolders() const;
  51
  52         QStringList excludeFilters() const;
  53         QStringList includeFilters() const;
  54
  55         bool showGui() const;
  56         void setShowGui( bool showGui );
  57
  58         /**
  59          * The minimal available disk space. If it drops below
  60          * indexing will be suspended.
  61          */
  62         KIO::filesize_t minDiskSpace() const;
  63
  64         /**
  65          * true the first time the service is run (or after manually
  66          * tampering with the config.
  67          */
  68         bool isInitialRun() const;
  69
  70         /**
  71          * Check if the folder should be indexed based on
  72          * folders() and excludeFolders()
  73          */
  74         bool shouldFolderBeIndexed( const QString& );
  75
  76     Q_SIGNALS:
  77         void configChanged();
  78
  79     private Q_SLOTS:
  80         void slotConfigDirty();
  81
  82     private:
  83         Config();
  84
  85         KConfig m_config;
  86     };
  87 }
  88
  89 #endif