feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Help: Move viewer backend management from plugin to local help manager

Browse Source 
which poses as a settings class.

Change-Id: Icb01f0d4750c2d197875954a648ae7358c4c217a
Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
Eike Ziller
2019-08-29 14:08:55 +02:00
parent 24da5b14d4
commit f52c4f450d
3 changed files with 70 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
src/plugins/help/localhelpmanager.cpp
View File

@@ -29,6 +29,17 @@
#include "helpconstants.h"
#include "helpmanager.h"
#include "helpviewer.h"
#include "textbrowserhelpviewer.h"
#ifdef QTC_WEBENGINE_HELPVIEWER
#include "webenginehelpviewer.h"
#endif
#ifdef QTC_LITEHTML_HELPVIEWER
#include "litehtmlhelpviewer.h"
#endif
#ifdef QTC_MAC_NATIVE_HELPVIEWER
#include "macwebkithelpviewer.h"
#endif
#include <app/app_version.h>
#include <coreplugin/icore.h>
@@ -276,6 +287,46 @@ void LocalHelpManager::setLastSelectedTab(int index)
Core::ICore::settings()->setValue(kLastSelectedTabKey, index);
}
QByteArray LocalHelpManager::defaultViewerBackend()
{
const QByteArray backend = qgetenv("QTC_HELPVIEWER_BACKEND");
if (Utils::contains(viewerBackends(), Utils::equal(&HelpViewerFactory::id, backend)))
return backend;
else if (!backend.isEmpty())
qWarning("Help viewer backend \"%s\" not found, using default.", backend.constData());
#ifdef QTC_WEBENGINE_HELPVIEWER
return "qtwebengine";
#else
return "textbrowser";
#endif
}
QVector<HelpViewerFactory> LocalHelpManager::viewerBackends()
{
QVector<HelpViewerFactory> result;
#ifdef QTC_WEBENGINE_HELPVIEWER
result.append({"qtwebengine", tr("QtWebEngine"), []() { return new WebEngineHelpViewer; }});
#endif
#ifdef QTC_LITEHTML_HELPVIEWER
result.append({"litehtml", tr("litehtml"), []() { return new LiteHtmlHelpViewer; }});
#endif
#ifdef QTC_MAC_NATIVE_HELPVIEWER
result.append({"native", tr("WebKit"), []() { return new MacWebKitHelpViewer; }});
#endif
result.append({"textbrowser", tr("QTextBrowser"), []() { return new TextBrowserHelpViewer; }});
return result;
}
HelpViewerFactory LocalHelpManager::viewerBackend()
{
const QVector<HelpViewerFactory> factories = viewerBackends();
const auto backend = std::find_if(std::begin(factories),
std::end(factories),
Utils::equal(&HelpViewerFactory::id, defaultViewerBackend()));
QTC_ASSERT(backend != std::end(factories), return {});
return *backend;
}
void LocalHelpManager::setupGuiHelpEngine()
{
if (m_needsCollectionFile) {