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
|
/*
SPDX-FileCopyrightText: 2010 Aleix Pol Gonzalez <aleixpol@kde.org>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_DOCUMENTATIONFINDWIDGET_H
#define KDEVPLATFORM_DOCUMENTATIONFINDWIDGET_H
#include <QWidget>
#include "documentationexport.h"
namespace Ui { class FindWidget; }
namespace KDevelop
{
class KDEVPLATFORMDOCUMENTATION_EXPORT DocumentationFindWidget : public QWidget
{
Q_OBJECT
public:
enum FindOption {
Next = 1,
Previous = 2,
MatchCase = 4
};
Q_DECLARE_FLAGS(FindOptions, FindOption)
explicit DocumentationFindWidget(QWidget* parent = nullptr);
~DocumentationFindWidget() override;
void hideEvent(QHideEvent* event) override;
public Q_SLOTS:
void startSearch();
private Q_SLOTS:
void searchNext();
void searchPrevious();
void emitDataChanged();
Q_SIGNALS:
/**
* Emitted when the user requests a search.
* @param text text to search in documentation
* @param options MatchCase being set or empty flags (Next/Previous unused here)
*/
void searchRequested(const QString& text, KDevelop::DocumentationFindWidget::FindOptions options);
/**
* Emitted when the user edits the search field or changes the case-sensitivity checkbox.
* Allows documentation views capable of live searches to show live results while the user types.
* @param text current text in search text field
* @param options MatchCase being set or empty flags (Next/Previous unused here)
*/
void searchDataChanged(const QString& text, KDevelop::DocumentationFindWidget::FindOptions options);
/**
* Emitted when the search tool view is closed, so no more search hits should be displayed.
*/
void searchFinished();
private:
Ui::FindWidget* m_ui;
};
}
#endif // KDEVPLATFORM_DOCUMENTATIONFINDWIDGET_H
|
