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