Help: Add litehtml based viewer backend

For CMake add litehtml installation path to CMAKE_PREFIX_PATH For qmake pass litehtml installation path via LITEHTML_INSTALL_DIR qmake variable Release build of litehtml is recommended. The litehtml backend is used by default when available, you can force QTextBrowser again with the environment variable "QTC_HELPVIEWER_BACKEND=textbrowser". Some things are not implemented yet: - Text search - Context menu - Shift-drag to extend existing selection Change-Id: I79f989e5fe2063de2e9832abbed19b24d7a1a1fe Reviewed-by: hjk <hjk@qt.io>
2019-07-29 15:30:58 +02:00
parent 7855c9bb80
commit 0efd65e07e
12 changed files with 2456 additions and 3 deletions
--- a/src/plugins/help/litehtmlhelpviewer.h
+++ b/src/plugins/help/litehtmlhelpviewer.h
@@ -0,0 +1,99 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt Creator.
+**
+** 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 General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** 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-3.0.html.
+**
+****************************************************************************/
+
+#pragma once
+
+#include "centralwidget.h"
+#include "helpviewer.h"
+#include "openpagesmanager.h"
+
+#include <utils/optional.h>
+
+#include <qlitehtmlwidget.h>
+
+#include <QTextBrowser>
+
+namespace Help {
+namespace Internal {
+
+class LiteHtmlHelpViewer : public HelpViewer
+{
+    Q_OBJECT
+
+public:
+    explicit LiteHtmlHelpViewer(QWidget *parent = nullptr);
+    ~LiteHtmlHelpViewer() override;
+
+    QFont viewerFont() const override;
+    void setViewerFont(const QFont &font) override;
+
+    qreal scale() const override;
+    void setScale(qreal scale) override;
+
+    QString title() const override;
+
+    QUrl source() const override;
+    void setSource(const QUrl &url) override;
+
+    void setHtml(const QString &html) override;
+
+    QString selectedText() const override;
+    bool isForwardAvailable() const override;
+    bool isBackwardAvailable() const override;
+    void addBackHistoryItems(QMenu *backMenu) override;
+    void addForwardHistoryItems(QMenu *forwardMenu) override;
+
+    bool findText(const QString &text, Core::FindFlags flags,
+                  bool incremental, bool fromSearch, bool *wrapped = nullptr) override;
+
+    void scaleUp() override;
+    void scaleDown() override;
+    void resetScale() override;
+    void copy() override;
+    void stop() override;
+    void forward() override;
+    void backward() override;
+    void print(QPrinter *printer) override;
+
+private:
+    void goForward(int count);
+    void goBackward(int count);
+    void setSourceInternal(const QUrl &url, Utils::optional<int> vscroll = Utils::nullopt);
+
+    struct HistoryItem
+    {
+        QUrl url;
+        QString title;
+        int vscroll;
+    };
+    HistoryItem currentHistoryItem() const;
+
+    QLiteHtmlWidget *m_viewer;
+    std::vector<HistoryItem> m_backItems;
+    std::vector<HistoryItem> m_forwardItems;
+};
+
+}   // namespace Internal
+}   // namespace Help