blob: 280d7c3e5d780819f5ad9ca3ddc1d06ec6cd4c9f (
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
|
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef QQMLLSHELPPLUGININTERFACE_H
#define QQMLLSHELPPLUGININTERFACE_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <QtCore/qstring.h>
#include <QtCore/qurl.h>
#include <QtCore/qobject.h>
#include <vector>
QT_BEGIN_NAMESPACE
class QQmlLSHelpProviderBase
{
public:
struct DocumentLink
{
QUrl url;
QString title;
};
public:
virtual ~QQmlLSHelpProviderBase() = default;
virtual bool registerDocumentation(const QString &documentationFileName) = 0;
[[nodiscard]] virtual QByteArray fileData(const QUrl &url) const = 0;
[[nodiscard]] virtual std::vector<DocumentLink> documentsForIdentifier(const QString &id) const = 0;
[[nodiscard]] virtual std::vector<DocumentLink>
documentsForIdentifier(const QString &id, const QString &filterName) const = 0;
[[nodiscard]] virtual std::vector<DocumentLink> documentsForKeyword(const QString &keyword) const = 0;
[[nodiscard]] virtual std::vector<DocumentLink>
documentsForKeyword(const QString &keyword, const QString &filterName) const = 0;
[[nodiscard]] virtual QStringList registeredNamespaces() const = 0;
[[nodiscard]] virtual QString error() const = 0;
};
class QQmlLSHelpPluginInterface
{
public:
QQmlLSHelpPluginInterface() = default;
virtual ~QQmlLSHelpPluginInterface() = default;
Q_DISABLE_COPY_MOVE(QQmlLSHelpPluginInterface)
virtual std::unique_ptr<QQmlLSHelpProviderBase> initialize(const QString &collectionFile,
QObject *parent) = 0;
};
#define QQmlLSHelpPluginInterface_iid "org.qt-project.Qt.QmlLS.HelpPlugin/1.0"
Q_DECLARE_INTERFACE(QQmlLSHelpPluginInterface, QQmlLSHelpPluginInterface_iid)
QT_END_NAMESPACE
#endif // QQMLLSHELPPLUGININTERFACE_H
|
