src/search/dolphinsearchinformation.h

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef DOLPHINSEARCHINFORMATION_H
  21 #define DOLPHINSEARCHINFORMATION_H
  22
  23 class KUrl;
  24
  25 /**
  26  * @brief Allows to access search-engine related information.
  27  */
  28 class DolphinSearchInformation
  29 {
  30 public:
  31     static DolphinSearchInformation& instance();
  32     virtual ~DolphinSearchInformation();
  33
  34     /**
  35      * @return True if the Nepomuk indexer is enabled. If Nepomuk is
  36      *         disabled, always false is returned.
  37      */
  38     bool isIndexingEnabled() const;
  39
  40     /**
  41      * @return True if the complete directory tree specified by path
  42      *         is indexed by the Nepomuk indexer. If Nepomuk is disabled,
  43      *         always false is returned.
  44      */
  45     bool isPathIndexed(const KUrl& url) const;
  46
  47 protected:
  48     DolphinSearchInformation();
  49
  50 private:
  51     bool m_indexingEnabled;
  52
  53     friend class DolphinSearchInformationSingleton;
  54 };
  55
  56 #endif
  57