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  *                                                                         *
   6  *   This program is free software; you can redistribute it and/or modify  *
   7  *   it under the terms of the GNU General Public License as published by  *
   8  *   the Free Software Foundation; either version 2 of the License, or     *
   9  *   (at your option) any later version.                                   *
  10  *                                                                         *
  11  *   This program is distributed in the hope that it will be useful,       *
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  14  *   GNU General Public License for more details.                          *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU General Public License     *
  17  *   along with this program; if not, write to the                         *
  18  *   Free Software Foundation, Inc.,                                       *
  19  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  20  ***************************************************************************/
  21
  22 #ifndef KITEMLISTKEYBOARDSEARCHMANAGER_H
  23 #define KITEMLISTKEYBOARDSEARCHMANAGER_H
  24
  25 #include "dolphin_export.h"
  26 #include "kitemviews/kitemset.h"
  27
  28 #include <QElapsedTimer>
  29 #include <QObject>
  30 #include <QString>
  31
  32 /**
  33  * @brief Controls the keyboard searching ability for a KItemListController.
  34  *
  35  * @see KItemListController
  36  * @see KItemModelBase
  37  */
  38 class DOLPHIN_EXPORT KItemListKeyboardSearchManager : public QObject
  39 {
  40     Q_OBJECT
  41
  42 public:
  43
  44     explicit KItemListKeyboardSearchManager(QObject* parent = nullptr);
  45     ~KItemListKeyboardSearchManager() override;
  46
  47     /**
  48      * Add \a keys to the text buffer used for searching.
  49      */
  50     void addKeys(const QString& keys);
  51
  52     /**
  53      * Sets the delay after which the search is cancelled to \a milliseconds.
  54      * If the time interval between two calls of addKeys(const QString&) is
  55      * larger than this, the second call will start a new search, rather than
  56      * combining the keys received from both calls to a single search string.
  57      */
  58     void setTimeout(qint64 milliseconds);
  59     qint64 timeout() const;
  60
  61     void cancelSearch();
  62     bool shouldClearSearchIfInputTimeReached();
  63
  64 public slots:
  65
  66     void slotCurrentChanged(int current, int previous);
  67     void slotSelectionChanged(const KItemSet& current, const KItemSet& previous);
  68
  69 signals:
  70     /**
  71      * Is emitted if the current item should be changed corresponding
  72      * to \a text.
  73      * @param searchFromNextItem If true start searching from item next to the
  74      *                           current item. Otherwise, search from the
  75      *                           current item.
  76      */
  77     // TODO: Think about getting rid of the bool parameter
  78     // (see https://doc.qt.io/archives/qq/qq13-apis.html#thebooleanparametertrap)
  79     void changeCurrentItem(const QString& string, bool searchFromNextItem);
  80
  81 private:
  82     QString m_searchedString;
  83     bool m_isSearchRestarted;
  84     QElapsedTimer m_keyboardInputTime;
  85     qint64 m_timeout;
  86 };
  87
  88 #endif
  89
  90