src/kitemviews/private/kitemlistkeyboardsearchmanager.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 KITEMLISTKEYBOARDSEARCHMANAGER_H
  24 #define KITEMLISTKEYBOARDSEARCHMANAGER_H
  25
  26 #include "dolphin_export.h"
  27 #include "kitemviews/kitemset.h"
  28
  29 #include <QElapsedTimer>
  30 #include <QObject>
  31 #include <QString>
  32
  33 /**
  34  * @brief Controls the keyboard searching ability for a KItemListController.
  35  *
  36  * @see KItemListController
  37  * @see KItemModelBase
  38  */
  39 class DOLPHIN_EXPORT KItemListKeyboardSearchManager : public QObject
  40 {
  41     Q_OBJECT
  42
  43 public:
  44
  45     explicit KItemListKeyboardSearchManager(QObject* parent = nullptr);
  46     ~KItemListKeyboardSearchManager() override;
  47
  48     /**
  49      * Add \a keys to the text buffer used for searching.
  50      */
  51     void addKeys(const QString& keys);
  52
  53     /**
  54      * Sets the delay after which the search is cancelled to \a milliseconds.
  55      * If the time interval between two calls of addKeys(const QString&) is
  56      * larger than this, the second call will start a new search, rather than
  57      * combining the keys received from both calls to a single search string.
  58      */
  59     void setTimeout(qint64 milliseconds);
  60     qint64 timeout() const;
  61
  62     void cancelSearch();
  63     bool shouldClearSearchIfInputTimeReached();
  64
  65 public slots:
  66
  67     void slotCurrentChanged(int current, int previous);
  68     void slotSelectionChanged(const KItemSet& current, const KItemSet& previous);
  69
  70 signals:
  71     /**
  72      * Is emitted if the current item should be changed corresponding
  73      * to \a text.
  74      * @param searchFromNextItem If true start searching from item next to the
  75      *                           current item. Otherwise, search from the
  76      *                           current item.
  77      */
  78     // TODO: Think about getting rid of the bool parameter
  79     // (see http://doc.qt.nokia.com/qq/qq13-apis.html#thebooleanparametertrap)
  80     void changeCurrentItem(const QString& string, bool searchFromNextItem);
  81
  82 private:
  83     QString m_searchedString;
  84     bool m_isSearchRestarted;
  85     QElapsedTimer m_keyboardInputTime;
  86     qint64 m_timeout;
  87 };
  88
  89 #endif
  90
  91