blob: 58dda5e3945b40de2a837d1feeb9c49786419bc7 (
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QHELPINDEXWIDGET_H
#define QHELPINDEXWIDGET_H
#include <QtHelp/qhelp_global.h>
#include <QtCore/QUrl>
#include <QtCore/QStringListModel>
#include <QtWidgets/QListView>
QT_BEGIN_NAMESPACE
class QHelpEnginePrivate;
class QHelpIndexModelPrivate;
class QHELP_EXPORT QHelpIndexModel : public QStringListModel
{
Q_OBJECT
public:
void createIndex(const QString &customFilterName);
QModelIndex filter(const QString &filter,
const QString &wildcard = QString());
QMap<QString, QUrl> linksForKeyword(const QString &keyword) const;
bool isCreatingIndex() const;
Q_SIGNALS:
void indexCreationStarted();
void indexCreated();
private Q_SLOTS:
void insertIndices();
private:
QHelpIndexModel(QHelpEnginePrivate *helpEngine);
~QHelpIndexModel();
QHelpIndexModelPrivate *d;
friend class QHelpEnginePrivate;
};
class QHELP_EXPORT QHelpIndexWidget : public QListView
{
Q_OBJECT
Q_SIGNALS:
void linkActivated(const QUrl &link, const QString &keyword);
void linksActivated(const QMap<QString, QUrl> &links,
const QString &keyword);
public Q_SLOTS:
void filterIndices(const QString &filter,
const QString &wildcard = QString());
void activateCurrentItem();
private Q_SLOTS:
void showLink(const QModelIndex &index);
private:
QHelpIndexWidget();
friend class QHelpEngine;
};
QT_END_NAMESPACE
#endif
|
