src/kitemviews/kitemlistkeyboardsearchmanager_p.h

   1 /***************************************************************************
   2  * Copyright (C) 2011 by Tirtha Chatterjee <tirtha.p.chatterjee@gmail.com> *
   3  *                                                                         *
   4  *   Based on the Itemviews NG project from Trolltech Labs:                *
   5  *   http://qt.gitorious.org/qt-labs/itemviews-ng                          *
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  *   This program is distributed in the hope that it will be useful,       *
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  15  *   GNU General Public License for more details.                          *
  16  *                                                                         *
  17  *   You should have received a copy of the GNU General Public License     *
  18  *   along with this program; if not, write to the                         *
  19  *   Free Software Foundation, Inc.,                                       *
  20  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  21  ***************************************************************************/
  22
  23 #ifndef KITEMLISTKEYBOARDMANAGER_H
  24 #define KITEMLISTKEYBOARDMANAGER_H
  25
  26 #include <libdolphin_export.h>
  27
  28 #include <QObject>
  29 #include <QString>
  30 #include <QElapsedTimer>
  31
  32 /**
  33  * @brief Controls the keyboard searching ability for a KItemListController.
  34  *
  35  * @see KItemListController
  36  * @see KItemModelBase
  37  */
  38 class LIBDOLPHINPRIVATE_EXPORT KItemListKeyboardSearchManager : public QObject
  39 {
  40     Q_OBJECT
  41
  42 public:
  43
  44     KItemListKeyboardSearchManager(QObject* parent = 0);
  45     virtual ~KItemListKeyboardSearchManager();
  46
  47     /**
  48      * Add \a keys to the text buffer used for searching.
  49      */
  50     void addKeys(const QString& keys);
  51
  52 signals:
  53     /**
  54      * Is emitted if the current item should be changed corresponding
  55      * to \a text.
  56      * @param searchFromNextItem If true start searching from item next to the
  57      *                           current item. Otherwise, search from the
  58      *                           current item.
  59      */
  60     // TODO: Think about getting rid of the bool parameter
  61     // (see http://doc.qt.nokia.com/qq/qq13-apis.html#thebooleanparametertrap)
  62     void changeCurrentItem(const QString& string, bool searchFromNextItem);
  63
  64 private:
  65     QString m_searchedString;
  66     QElapsedTimer m_keyboardInputTime;
  67 };
  68
  69 #endif
  70
  71