forked from qt-creator/qt-creator
Implement a common interface for help viewers.
Both implementations are now split into two source files, based on the base class type. They share also a commen implementation, but the class interface looks now clean to the outside. Adopt other classes for use.
This commit is contained in:
kh1
441
src/plugins/help/helpviewer_qwv.cpp
Normal file
441
src/plugins/help/helpviewer_qwv.cpp
Normal file
@@ -0,0 +1,441 @@
|
||||
/**************************************************************************
|
||||
**
|
||||
** This file is part of Qt Creator
|
||||
**
|
||||
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
|
||||
**
|
||||
** Contact: Nokia Corporation (qt-info@nokia.com)
|
||||
**
|
||||
** Commercial Usage
|
||||
**
|
||||
** Licensees holding valid Qt Commercial licenses may use this file in
|
||||
** accordance with the Qt Commercial License Agreement provided with the
|
||||
** Software or, alternatively, in accordance with the terms contained in
|
||||
** a written agreement between you and Nokia.
|
||||
**
|
||||
** GNU Lesser General Public License Usage
|
||||
**
|
||||
** Alternatively, this file may be used under the terms of the GNU Lesser
|
||||
** General Public License version 2.1 as published by the Free Software
|
||||
** Foundation and appearing in the file LICENSE.LGPL included in the
|
||||
** packaging of this file. Please review the following information to
|
||||
** ensure the GNU Lesser General Public License version 2.1 requirements
|
||||
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
||||
**
|
||||
** If you are unsure which license is appropriate for your use, please
|
||||
** contact the sales department at http://qt.nokia.com/contact.
|
||||
**
|
||||
**************************************************************************/
|
||||
|
||||
#include "helpviewer.h"
|
||||
|
||||
#if !defined(QT_NO_WEBKIT)
|
||||
|
||||
#include "centralwidget.h"
|
||||
#include "helpconstants.h"
|
||||
#include "helpmanager.h"
|
||||
#include "openpagesmanager.h"
|
||||
|
||||
#include <QtCore/QFileInfo>
|
||||
#include <QtCore/QString>
|
||||
#include <QtCore/QStringBuilder>
|
||||
#include <QtCore/QTimer>
|
||||
|
||||
#include <QtGui/QApplication>
|
||||
#include <QtGui/QWheelEvent>
|
||||
|
||||
#include <QtHelp/QHelpEngineCore>
|
||||
|
||||
#include <QtNetwork/QNetworkAccessManager>
|
||||
#include <QtNetwork/QNetworkReply>
|
||||
#include <QtNetwork/QNetworkRequest>
|
||||
|
||||
using namespace Find;
|
||||
using namespace Help;
|
||||
using namespace Help::Internal;
|
||||
|
||||
// -- HelpNetworkReply
|
||||
|
||||
class HelpNetworkReply : public QNetworkReply
|
||||
{
|
||||
public:
|
||||
HelpNetworkReply(const QNetworkRequest &request, const QByteArray &fileData,
|
||||
const QString &mimeType);
|
||||
|
||||
virtual void abort();
|
||||
|
||||
virtual qint64 bytesAvailable() const
|
||||
{ return data.length() + QNetworkReply::bytesAvailable(); }
|
||||
|
||||
protected:
|
||||
virtual qint64 readData(char *data, qint64 maxlen);
|
||||
|
||||
private:
|
||||
QByteArray data;
|
||||
qint64 origLen;
|
||||
};
|
||||
|
||||
HelpNetworkReply::HelpNetworkReply(const QNetworkRequest &request,
|
||||
const QByteArray &fileData, const QString& mimeType)
|
||||
: data(fileData), origLen(fileData.length())
|
||||
{
|
||||
setRequest(request);
|
||||
setOpenMode(QIODevice::ReadOnly);
|
||||
|
||||
setHeader(QNetworkRequest::ContentTypeHeader, mimeType);
|
||||
setHeader(QNetworkRequest::ContentLengthHeader, QByteArray::number(origLen));
|
||||
QTimer::singleShot(0, this, SIGNAL(metaDataChanged()));
|
||||
QTimer::singleShot(0, this, SIGNAL(readyRead()));
|
||||
}
|
||||
|
||||
void HelpNetworkReply::abort()
|
||||
{
|
||||
}
|
||||
|
||||
qint64 HelpNetworkReply::readData(char *buffer, qint64 maxlen)
|
||||
{
|
||||
qint64 len = qMin(qint64(data.length()), maxlen);
|
||||
if (len) {
|
||||
qMemCopy(buffer, data.constData(), len);
|
||||
data.remove(0, len);
|
||||
}
|
||||
if (!data.length())
|
||||
QTimer::singleShot(0, this, SIGNAL(finished()));
|
||||
return len;
|
||||
}
|
||||
|
||||
// -- HelpNetworkAccessManager
|
||||
|
||||
class HelpNetworkAccessManager : public QNetworkAccessManager
|
||||
{
|
||||
public:
|
||||
HelpNetworkAccessManager(QObject *parent);
|
||||
|
||||
protected:
|
||||
virtual QNetworkReply *createRequest(Operation op,
|
||||
const QNetworkRequest &request, QIODevice *outgoingData = 0);
|
||||
};
|
||||
|
||||
HelpNetworkAccessManager::HelpNetworkAccessManager(QObject *parent)
|
||||
: QNetworkAccessManager(parent)
|
||||
{
|
||||
}
|
||||
|
||||
QNetworkReply *HelpNetworkAccessManager::createRequest(Operation /*op*/,
|
||||
const QNetworkRequest &request, QIODevice* /*outgoingData*/)
|
||||
{
|
||||
const QUrl& url = request.url();
|
||||
QString mimeType = url.toString();
|
||||
if (mimeType.endsWith(QLatin1String(".svg"))
|
||||
|| mimeType.endsWith(QLatin1String(".svgz"))) {
|
||||
mimeType = QLatin1String("image/svg+xml");
|
||||
} else if (mimeType.endsWith(QLatin1String(".css"))) {
|
||||
mimeType = QLatin1String("text/css");
|
||||
} else if (mimeType.endsWith(QLatin1String(".js"))) {
|
||||
mimeType = QLatin1String("text/javascript");
|
||||
} else if (mimeType.endsWith(QLatin1String(".txt"))) {
|
||||
mimeType = QLatin1String("text/plain");
|
||||
} else {
|
||||
mimeType = QLatin1String("text/html");
|
||||
}
|
||||
|
||||
const QHelpEngineCore &engine = HelpManager::helpEngineCore();
|
||||
const QByteArray &data = engine.findFile(url).isValid()
|
||||
? engine.fileData(url) : HelpViewer::PageNotFoundMessage.arg(url.toString()).toUtf8();
|
||||
return new HelpNetworkReply(request, data, mimeType);
|
||||
}
|
||||
|
||||
// -- HelpPage
|
||||
|
||||
class HelpPage : public QWebPage
|
||||
{
|
||||
public:
|
||||
HelpPage(QObject *parent);
|
||||
|
||||
protected:
|
||||
virtual QWebPage *createWindow(QWebPage::WebWindowType);
|
||||
virtual void triggerAction(WebAction action, bool checked = false);
|
||||
|
||||
virtual bool acceptNavigationRequest(QWebFrame *frame,
|
||||
const QNetworkRequest &request, NavigationType type);
|
||||
|
||||
private:
|
||||
bool closeNewTabIfNeeded;
|
||||
|
||||
friend class HelpViewer;
|
||||
Qt::MouseButtons m_pressedButtons;
|
||||
Qt::KeyboardModifiers m_keyboardModifiers;
|
||||
};
|
||||
|
||||
HelpPage::HelpPage(QObject *parent)
|
||||
: QWebPage(parent)
|
||||
, closeNewTabIfNeeded(false)
|
||||
, m_pressedButtons(Qt::NoButton)
|
||||
, m_keyboardModifiers(Qt::NoModifier)
|
||||
{
|
||||
}
|
||||
|
||||
QWebPage *HelpPage::createWindow(QWebPage::WebWindowType)
|
||||
{
|
||||
HelpPage* newPage = static_cast<HelpPage*>(OpenPagesManager::instance()
|
||||
.createPage()->page());
|
||||
newPage->closeNewTabIfNeeded = closeNewTabIfNeeded;
|
||||
closeNewTabIfNeeded = false;
|
||||
return newPage;
|
||||
}
|
||||
|
||||
void HelpPage::triggerAction(WebAction action, bool checked)
|
||||
{
|
||||
switch (action) {
|
||||
case OpenLinkInNewWindow:
|
||||
closeNewTabIfNeeded = true;
|
||||
default: // fall through
|
||||
QWebPage::triggerAction(action, checked);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
bool HelpPage::acceptNavigationRequest(QWebFrame *,
|
||||
const QNetworkRequest &request, QWebPage::NavigationType type)
|
||||
{
|
||||
const bool closeNewTab = closeNewTabIfNeeded;
|
||||
closeNewTabIfNeeded = false;
|
||||
|
||||
const QUrl &url = request.url();
|
||||
if (HelpViewer::launchWithExternalApp(url)) {
|
||||
if (closeNewTab)
|
||||
QMetaObject::invokeMethod(&OpenPagesManager::instance(), "closeCurrentPage");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (type == QWebPage::NavigationTypeLinkClicked
|
||||
&& (m_keyboardModifiers & Qt::ControlModifier || m_pressedButtons == Qt::MidButton)) {
|
||||
m_pressedButtons = Qt::NoButton;
|
||||
m_keyboardModifiers = Qt::NoModifier;
|
||||
OpenPagesManager::instance().createPage(url);
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
// -- HelpViewer
|
||||
|
||||
HelpViewer::HelpViewer(qreal zoom, QWidget *parent)
|
||||
: QWebView(parent)
|
||||
{
|
||||
setAcceptDrops(false);
|
||||
settings()->setAttribute(QWebSettings::JavaEnabled, false);
|
||||
settings()->setAttribute(QWebSettings::PluginsEnabled, false);
|
||||
|
||||
setPage(new HelpPage(this));
|
||||
page()->setNetworkAccessManager(new HelpNetworkAccessManager(this));
|
||||
|
||||
QAction* action = pageAction(QWebPage::OpenLinkInNewWindow);
|
||||
action->setText(tr("Open Link as New Page"));
|
||||
|
||||
pageAction(QWebPage::DownloadLinkToDisk)->setVisible(false);
|
||||
pageAction(QWebPage::DownloadImageToDisk)->setVisible(false);
|
||||
pageAction(QWebPage::OpenImageInNewWindow)->setVisible(false);
|
||||
|
||||
connect(pageAction(QWebPage::Copy), SIGNAL(changed()), this,
|
||||
SLOT(actionChanged()));
|
||||
connect(pageAction(QWebPage::Back), SIGNAL(changed()), this,
|
||||
SLOT(actionChanged()));
|
||||
connect(pageAction(QWebPage::Forward), SIGNAL(changed()), this,
|
||||
SLOT(actionChanged()));
|
||||
connect(this, SIGNAL(urlChanged(QUrl)), this, SIGNAL(sourceChanged(QUrl)));
|
||||
connect(this, SIGNAL(loadFinished(bool)), this, SLOT(setLoadFinished(bool)));
|
||||
connect(this, SIGNAL(titleChanged(QString)), this, SIGNAL(titleChanged()));
|
||||
|
||||
setFont(viewerFont());
|
||||
setTextSizeMultiplier(zoom == 0.0 ? 1.0 : zoom);
|
||||
}
|
||||
|
||||
HelpViewer::~HelpViewer()
|
||||
{
|
||||
}
|
||||
|
||||
QFont HelpViewer::viewerFont() const
|
||||
{
|
||||
QWebSettings* webSettings = QWebSettings::globalSettings();
|
||||
QFont font(QApplication::font().family(),
|
||||
webSettings->fontSize(QWebSettings::DefaultFontSize));
|
||||
const QHelpEngineCore &engine = HelpManager::helpEngineCore();
|
||||
return qVariantValue<QFont>(engine.customValue(QLatin1String("font"),
|
||||
font));
|
||||
}
|
||||
|
||||
void HelpViewer::setViewerFont(const QFont &font)
|
||||
{
|
||||
QWebSettings *webSettings = settings();
|
||||
webSettings->setFontFamily(QWebSettings::StandardFont, font.family());
|
||||
webSettings->setFontSize(QWebSettings::DefaultFontSize, font.pointSize());
|
||||
}
|
||||
|
||||
void HelpViewer::scaleUp()
|
||||
{
|
||||
setTextSizeMultiplier(textSizeMultiplier() + 0.1);
|
||||
}
|
||||
|
||||
void HelpViewer::scaleDown()
|
||||
{
|
||||
setTextSizeMultiplier(qMax(0.0, textSizeMultiplier() - 0.1));
|
||||
}
|
||||
|
||||
void HelpViewer::resetScale()
|
||||
{
|
||||
setTextSizeMultiplier(1.0);
|
||||
}
|
||||
|
||||
qreal HelpViewer::scale() const
|
||||
{
|
||||
return textSizeMultiplier();
|
||||
}
|
||||
|
||||
QString HelpViewer::title() const
|
||||
{
|
||||
return QWebView::title();
|
||||
}
|
||||
|
||||
void HelpViewer::setTitle(const QString &title)
|
||||
{
|
||||
Q_UNUSED(title)
|
||||
}
|
||||
|
||||
QUrl HelpViewer::source() const
|
||||
{
|
||||
return url();
|
||||
}
|
||||
|
||||
void HelpViewer::setSource(const QUrl &url)
|
||||
{
|
||||
load(url);
|
||||
}
|
||||
|
||||
QString HelpViewer::selectedText() const
|
||||
{
|
||||
return QWebView::selectedText();
|
||||
}
|
||||
|
||||
bool HelpViewer::isForwardAvailable() const
|
||||
{
|
||||
return pageAction(QWebPage::Forward)->isEnabled();
|
||||
}
|
||||
|
||||
bool HelpViewer::isBackwardAvailable() const
|
||||
{
|
||||
return pageAction(QWebPage::Back)->isEnabled();
|
||||
}
|
||||
|
||||
bool HelpViewer::findText(const QString &text, IFindSupport::FindFlags flags,
|
||||
bool incremental)
|
||||
{
|
||||
Q_UNUSED(incremental)
|
||||
QWebPage::FindFlags options = QWebPage::FindWrapsAroundDocument;
|
||||
if (flags & Find::IFindSupport::FindBackward)
|
||||
options |= QWebPage::FindBackward;
|
||||
if (flags & Find::IFindSupport::FindCaseSensitively)
|
||||
options |= QWebPage::FindCaseSensitively;
|
||||
|
||||
bool found = QWebView::findText(text, options);
|
||||
options = QWebPage::HighlightAllOccurrences;
|
||||
QWebView::findText(QLatin1String(""), options); // clear first
|
||||
QWebView::findText(text, options); // force highlighting of all other matches
|
||||
return found;
|
||||
}
|
||||
|
||||
// -- public slots
|
||||
|
||||
void HelpViewer::copy()
|
||||
{
|
||||
triggerPageAction(QWebPage::Copy);
|
||||
}
|
||||
|
||||
void HelpViewer::forward()
|
||||
{
|
||||
QWebView::forward();
|
||||
}
|
||||
|
||||
void HelpViewer::backward()
|
||||
{
|
||||
back();
|
||||
}
|
||||
|
||||
// -- protected
|
||||
|
||||
void HelpViewer::keyPressEvent(QKeyEvent *e)
|
||||
{
|
||||
// TODO: remove this once we support multiple keysequences per command
|
||||
if (e->key() == Qt::Key_Insert && e->modifiers() == Qt::CTRL) {
|
||||
if (!selectedText().isEmpty())
|
||||
copy();
|
||||
}
|
||||
QWebView::keyPressEvent(e);
|
||||
}
|
||||
|
||||
void HelpViewer::wheelEvent(QWheelEvent *event)
|
||||
{
|
||||
if (event->modifiers()& Qt::ControlModifier) {
|
||||
event->accept();
|
||||
event->delta() > 0 ? scaleUp() : scaleDown();
|
||||
} else {
|
||||
QWebView::wheelEvent(event);
|
||||
}
|
||||
}
|
||||
|
||||
void HelpViewer::mousePressEvent(QMouseEvent *event)
|
||||
{
|
||||
#ifdef Q_OS_LINUX
|
||||
if (handleForwardBackwardMouseButtons(event))
|
||||
return;
|
||||
#endif
|
||||
|
||||
if (HelpPage *currentPage = static_cast<HelpPage*> (page())) {
|
||||
currentPage->m_pressedButtons = event->buttons();
|
||||
currentPage->m_keyboardModifiers = event->modifiers();
|
||||
}
|
||||
|
||||
QWebView::mousePressEvent(event);
|
||||
}
|
||||
|
||||
void HelpViewer::mouseReleaseEvent(QMouseEvent *event)
|
||||
{
|
||||
#ifndef Q_OS_LINUX
|
||||
if (handleForwardBackwardMouseButtons(event))
|
||||
return;
|
||||
#endif
|
||||
|
||||
QWebView::mouseReleaseEvent(event);
|
||||
}
|
||||
|
||||
// -- private slots
|
||||
|
||||
void HelpViewer::actionChanged()
|
||||
{
|
||||
QAction *a = qobject_cast<QAction *>(sender());
|
||||
if (a == pageAction(QWebPage::Back))
|
||||
emit backwardAvailable(a->isEnabled());
|
||||
else if (a == pageAction(QWebPage::Forward))
|
||||
emit forwardAvailable(a->isEnabled());
|
||||
}
|
||||
|
||||
void HelpViewer::setLoadFinished(bool ok)
|
||||
{
|
||||
Q_UNUSED(ok)
|
||||
emit sourceChanged(source());
|
||||
}
|
||||
|
||||
// -- private
|
||||
|
||||
bool HelpViewer::eventFilter(QObject *obj, QEvent *event)
|
||||
{
|
||||
return QWebView::eventFilter(obj, event);
|
||||
}
|
||||
|
||||
void HelpViewer::contextMenuEvent(QContextMenuEvent *event)
|
||||
{
|
||||
QWebView::contextMenuEvent(event);
|
||||
}
|
||||
|
||||
#endif // !QT_NO_WEBKIT
|
||||
Reference in New Issue
Block a user