src/kitemviews/private/kitemlistkeyboardsearchmanager.h

   1 /*
   2  * SPDX-FileCopyrightText: 2011 Tirtha Chatterjee <tirtha.p.chatterjee@gmail.com>
   3  *
   4  * Based on the Itemviews NG project from Trolltech Labs
   5  *
   6  * SPDX-License-Identifier: GPL-2.0-or-later
   7  */
   8
   9 #ifndef KITEMLISTKEYBOARDSEARCHMANAGER_H
  10 #define KITEMLISTKEYBOARDSEARCHMANAGER_H
  11
  12 #include "dolphin_export.h"
  13 #include "kitemviews/kitemset.h"
  14
  15 #include <QElapsedTimer>
  16 #include <QObject>
  17 #include <QString>
  18
  19 /**
  20  * @brief Controls the keyboard searching ability for a KItemListController.
  21  *
  22  * @see KItemListController
  23  * @see KItemModelBase
  24  */
  25 class DOLPHIN_EXPORT KItemListKeyboardSearchManager : public QObject
  26 {
  27     Q_OBJECT
  28
  29 public:
  30
  31     explicit KItemListKeyboardSearchManager(QObject* parent = nullptr);
  32     ~KItemListKeyboardSearchManager() override;
  33
  34     /**
  35      * Add \a keys to the text buffer used for searching.
  36      */
  37     void addKeys(const QString& keys);
  38     /**
  39      * @returns true if the next call to addKeys() will trigger a new search.
  40      *          Returns false if the next added key char will be added to the search string that was used previously.
  41      */
  42     bool addKeyBeginsNewSearch() const;
  43
  44     /**
  45      * Sets the delay after which the search is cancelled to \a milliseconds.
  46      * If the time interval between two calls of addKeys(const QString&) is
  47      * larger than this, the second call will start a new search, rather than
  48      * combining the keys received from both calls to a single search string.
  49      */
  50     void setTimeout(qint64 milliseconds);
  51     qint64 timeout() const;
  52
  53     void cancelSearch();
  54
  55 public Q_SLOTS:
  56
  57     void slotCurrentChanged(int current, int previous);
  58     void slotSelectionChanged(const KItemSet& current, const KItemSet& previous);
  59
  60 Q_SIGNALS:
  61     /**
  62      * Is emitted if the current item should be changed corresponding
  63      * to \a text.
  64      * @param searchFromNextItem If true start searching from item next to the
  65      *                           current item. Otherwise, search from the
  66      *                           current item.
  67      */
  68     // TODO: Think about getting rid of the bool parameter
  69     // (see https://doc.qt.io/archives/qq/qq13-apis.html#thebooleanparametertrap)
  70     void changeCurrentItem(const QString& string, bool searchFromNextItem);
  71
  72 private:
  73     bool shouldClearSearchIfInputTimeReached();
  74
  75 private:
  76     QString m_searchedString;
  77     bool m_isSearchRestarted;
  78     /** Measures the time since the last key press. */
  79     QElapsedTimer m_keyboardInputTime;
  80     /** Time in milliseconds in which a key press is considered as a continuation of the previous search input. */
  81     qint64 m_timeout;
  82 };
  83
  84 #endif
  85
  86