aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/coreplugin/helpmanager_implementation.h
blob: 4c61b89d378fb6e06e439f7e91b7f00470e5fa81 (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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0

#pragma once

#include "helpmanager.h"

namespace Core {

namespace HelpManager {

class CORE_EXPORT Implementation
{
protected:
    Implementation();
    virtual ~Implementation();

public:
    virtual void registerDocumentation(const QStringList &fileNames) = 0;
    virtual void unregisterDocumentation(const QStringList &fileNames) = 0;
    virtual QMultiMap<QString, QUrl> linksForIdentifier(const QString &id) = 0;
    virtual QMultiMap<QString, QUrl> linksForKeyword(const QString &keyword) = 0;
    virtual QByteArray fileData(const QUrl &url) = 0;
    virtual void showHelpUrl(const QUrl &url, HelpViewerLocation location = HelpModeAlways) = 0;
};

} // HelpManager
} // Core