1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Assistant of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QHELPSEARCHQUERYWIDGET_H
41#define QHELPSEARCHQUERYWIDGET_H
42
43#include <QtHelp/qhelp_global.h>
44#include <QtHelp/qhelpsearchengine.h>
45
46#include <QtCore/QMap>
47#include <QtCore/QString>
48#include <QtCore/QStringList>
49
50#include <QtWidgets/QWidget>
51
52QT_BEGIN_NAMESPACE
53
54
55class QFocusEvent;
56class QHelpSearchQueryWidgetPrivate;
57
58class QHELP_EXPORT QHelpSearchQueryWidget : public QWidget
59{
60 Q_OBJECT
61
62public:
63 explicit QHelpSearchQueryWidget(QWidget *parent = nullptr);
64 ~QHelpSearchQueryWidget() override;
65
66 void expandExtendedSearch();
67 void collapseExtendedSearch();
68
69#if QT_DEPRECATED_SINCE(5, 9)
70 QT_DEPRECATED QList<QHelpSearchQuery> query() const;
71 QT_DEPRECATED void setQuery(const QList<QHelpSearchQuery> &queryList);
72#endif
73
74 QString searchInput() const;
75 void setSearchInput(const QString &searchInput);
76
77 bool isCompactMode() const;
78 Q_SLOT void setCompactMode(bool on);
79
80Q_SIGNALS:
81 void search();
82
83private:
84 void focusInEvent(QFocusEvent *focusEvent) override;
85 void changeEvent(QEvent *event) override;
86
87private:
88 QHelpSearchQueryWidgetPrivate *d;
89};
90
91QT_END_NAMESPACE
92
93#endif // QHELPSEARCHQUERYWIDGET_H
94

source code of qttools/src/assistant/help/qhelpsearchquerywidget.h