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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/****************************************************************************
**
** Copyright (C) 2021 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:COMM$
**
** 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.
**
** $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 QHelpEngineCore;
class QHelpIndexModelPrivate;
struct QHelpLink;
class QHELP_EXPORT QHelpIndexModel : public QStringListModel
{
Q_OBJECT
public:
void createIndex(const QString &customFilterName);
QModelIndex filter(const QString &filter,
const QString &wildcard = QString());
#if QT_DEPRECATED_SINCE(5, 15)
QT_DEPRECATED_X("Use QHelpEngineCore::documentsForKeyword() instead")
QMap<QString, QUrl> linksForKeyword(const QString &keyword) const;
#endif
bool isCreatingIndex() const;
QHelpEngineCore *helpEngine() 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:
#if QT_DEPRECATED_SINCE(5, 15)
QT_DEPRECATED_X("Use documentActivated() instead")
void linkActivated(const QUrl &link, const QString &keyword);
QT_DEPRECATED_X("Use documentsActivated() instead")
void linksActivated(const QMap<QString, QUrl> &links,
const QString &keyword);
#endif
void documentActivated(const QHelpLink &document,
const QString &keyword);
void documentsActivated(const QList<QHelpLink> &documents,
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
|
