1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef INDEXWINDOW_H
43 #define INDEXWINDOW_H
44 
45 #include <QtCore/QUrl>
46 #include <QtGui/QWidget>
47 #include <QtGui/QLineEdit>
48 
49 QT_BEGIN_NAMESPACE
50 
51 class QHelpIndexWidget;
52 class QModelIndex;
53 
54 class IndexWindow : public QWidget
55 {
56     Q_OBJECT
57 
58 public:
59     IndexWindow(QWidget *parent = 0);
60     ~IndexWindow();
61 
62     void setSearchLineEditText(const QString &text);
searchLineEditText()63     QString searchLineEditText() const
64     {
65         return m_searchLineEdit->text();
66     }
67 
68 signals:
69     void linkActivated(const QUrl &link);
70     void linksActivated(const QMap<QString, QUrl> &links,
71         const QString &keyword);
72     void escapePressed();
73 
74 private slots:
75     void filterIndices(const QString &filter);
76     void enableSearchLineEdit();
77     void disableSearchLineEdit();
78 
79 private:
80     bool eventFilter(QObject *obj, QEvent *e);
81     void focusInEvent(QFocusEvent *e);
82     void open(QHelpIndexWidget *indexWidget, const QModelIndex &index);
83 
84     QLineEdit *m_searchLineEdit;
85     QHelpIndexWidget *m_indexWidget;
86 };
87 
88 QT_END_NAMESPACE
89 
90 #endif // INDEXWINDOW_H
91