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
334
src/plugins/help/helpviewer_qtb.cpp
Normal file
334
src/plugins/help/helpviewer_qtb.cpp
Normal file
@@ -0,0 +1,334 @@
|
||||
/**************************************************************************
|
||||
**
|
||||
** 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 "helpconstants.h"
|
||||
#include "helpviewer_p.h"
|
||||
#include "helpmanager.h"
|
||||
|
||||
#include <QtGui/QApplication>
|
||||
#include <QtGui/QClipboard>
|
||||
#include <QtGui/QContextMenuEvent>
|
||||
#include <QtGui/QKeyEvent>
|
||||
#include <QtGui/QMenu>
|
||||
|
||||
#include <QtHelp/QHelpEngineCore>
|
||||
|
||||
using namespace Find;
|
||||
using namespace Help;
|
||||
using namespace Help::Internal;
|
||||
|
||||
// -- HelpViewer
|
||||
|
||||
HelpViewer::HelpViewer(qreal zoom, QWidget *parent)
|
||||
: QTextBrowser(parent)
|
||||
, d(new HelpViewerPrivate(zoom))
|
||||
{
|
||||
installEventFilter(this);
|
||||
document()->setDocumentMargin(8);
|
||||
|
||||
QFont font = viewerFont();
|
||||
font.setPointSize(int(font.pointSize() + zoom));
|
||||
setViewerFont(font);
|
||||
|
||||
connect(this, SIGNAL(sourceChanged(QUrl)), this, SIGNAL(titleChanged()));
|
||||
connect(this, SIGNAL(loadFinished(bool)), this, SLOT(setLoadFinished(bool)));
|
||||
}
|
||||
|
||||
HelpViewer::~HelpViewer()
|
||||
{
|
||||
delete d;
|
||||
}
|
||||
|
||||
QFont HelpViewer::viewerFont() const
|
||||
{
|
||||
const QHelpEngineCore &engine = HelpManager::helpEngineCore();
|
||||
return qVariantValue<QFont>(engine.customValue(QLatin1String("font"),
|
||||
qApp->font()));
|
||||
}
|
||||
|
||||
void HelpViewer::setViewerFont(const QFont &newFont)
|
||||
{
|
||||
if (font() != newFont) {
|
||||
d->forceFont = true;
|
||||
setFont(newFont);
|
||||
d->forceFont = false;
|
||||
}
|
||||
}
|
||||
|
||||
void HelpViewer::scaleUp()
|
||||
{
|
||||
if (d->zoomCount < 10) {
|
||||
d->zoomCount++;
|
||||
d->forceFont = true;
|
||||
zoomIn();
|
||||
d->forceFont = false;
|
||||
}
|
||||
}
|
||||
|
||||
void HelpViewer::scaleDown()
|
||||
{
|
||||
if (d->zoomCount > -5) {
|
||||
d->zoomCount--;
|
||||
d->forceFont = true;
|
||||
zoomOut();
|
||||
d->forceFont = false;
|
||||
}
|
||||
}
|
||||
|
||||
void HelpViewer::resetScale()
|
||||
{
|
||||
if (d->zoomCount != 0) {
|
||||
d->forceFont = true;
|
||||
zoomOut(d->zoomCount);
|
||||
d->forceFont = false;
|
||||
}
|
||||
d->zoomCount = 0;
|
||||
}
|
||||
|
||||
qreal HelpViewer::scale() const
|
||||
{
|
||||
return d->zoomCount;
|
||||
}
|
||||
|
||||
QString HelpViewer::title() const
|
||||
{
|
||||
return documentTitle();
|
||||
}
|
||||
|
||||
void HelpViewer::setTitle(const QString &title)
|
||||
{
|
||||
setDocumentTitle(title);
|
||||
}
|
||||
|
||||
QUrl HelpViewer::source() const
|
||||
{
|
||||
return QTextBrowser::source();
|
||||
}
|
||||
|
||||
void HelpViewer::setSource(const QUrl &url)
|
||||
{
|
||||
const QString &string = url.toString();
|
||||
if (url.isValid() && string != QLatin1String("help")) {
|
||||
if (launchWithExternalApp(url))
|
||||
return;
|
||||
|
||||
const QHelpEngineCore &engine = HelpManager::instance().helpEngineCore();
|
||||
const QUrl &resolvedUrl = engine.findFile(url);
|
||||
if (resolvedUrl.isValid()) {
|
||||
QTextBrowser::setSource(resolvedUrl);
|
||||
emit loadFinished(true);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
QTextBrowser::setSource(url);
|
||||
setHtml(string == Help::Constants::AboutBlank ? AboutBlankPage
|
||||
: PageNotFoundMessage.arg(url.toString()));
|
||||
emit loadFinished(true);
|
||||
}
|
||||
|
||||
QString HelpViewer::selectedText() const
|
||||
{
|
||||
return textCursor().selectedText();
|
||||
}
|
||||
|
||||
bool HelpViewer::isForwardAvailable() const
|
||||
{
|
||||
return QTextBrowser::isForwardAvailable();
|
||||
}
|
||||
|
||||
bool HelpViewer::isBackwardAvailable() const
|
||||
{
|
||||
return QTextBrowser::isBackwardAvailable();
|
||||
}
|
||||
|
||||
bool HelpViewer::findText(const QString &text, IFindSupport::FindFlags flags,
|
||||
bool incremental)
|
||||
{
|
||||
QTextDocument *doc = document();
|
||||
QTextCursor cursor = textCursor();
|
||||
|
||||
if (!doc || cursor.isNull())
|
||||
return false;
|
||||
|
||||
if (incremental)
|
||||
cursor.setPosition(cursor.selectionStart());
|
||||
|
||||
QTextDocument::FindFlags f = IFindSupport::textDocumentFlagsForFindFlags(flags);
|
||||
QTextCursor found = doc->find(text, cursor, f);
|
||||
if (found.isNull()) {
|
||||
if ((flags & Find::IFindSupport::FindBackward) == 0)
|
||||
cursor.movePosition(QTextCursor::Start);
|
||||
else
|
||||
cursor.movePosition(QTextCursor::End);
|
||||
found = doc->find(text, cursor, f);
|
||||
if (found.isNull()) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if (!found.isNull()) {
|
||||
setTextCursor(found);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
// -- public slots
|
||||
|
||||
void HelpViewer::copy()
|
||||
{
|
||||
QTextBrowser::copy();
|
||||
}
|
||||
|
||||
void HelpViewer::forward()
|
||||
{
|
||||
QTextBrowser::forward();
|
||||
}
|
||||
|
||||
void HelpViewer::backward()
|
||||
{
|
||||
QTextBrowser::backward();
|
||||
}
|
||||
|
||||
// -- protected
|
||||
|
||||
void HelpViewer::keyPressEvent(QKeyEvent *e)
|
||||
{
|
||||
if ((e->key() == Qt::Key_Home && e->modifiers() != Qt::NoModifier)
|
||||
|| (e->key() == Qt::Key_End && e->modifiers() != Qt::NoModifier)) {
|
||||
QKeyEvent* event = new QKeyEvent(e->type(), e->key(), Qt::NoModifier,
|
||||
e->text(), e->isAutoRepeat(), e->count());
|
||||
e = event;
|
||||
}
|
||||
QTextBrowser::keyPressEvent(e);
|
||||
}
|
||||
|
||||
void HelpViewer::wheelEvent(QWheelEvent *e)
|
||||
{
|
||||
if (e->modifiers() == Qt::ControlModifier) {
|
||||
e->accept();
|
||||
e->delta() > 0 ? scaleUp() : scaleDown();
|
||||
} else {
|
||||
QTextBrowser::wheelEvent(e);
|
||||
}
|
||||
}
|
||||
|
||||
void HelpViewer::mousePressEvent(QMouseEvent *e)
|
||||
{
|
||||
#ifdef Q_OS_LINUX
|
||||
if (handleForwardBackwardMouseButtons(e))
|
||||
return;
|
||||
#endif
|
||||
QTextBrowser::mousePressEvent(e);
|
||||
}
|
||||
|
||||
void HelpViewer::mouseReleaseEvent(QMouseEvent *e)
|
||||
{
|
||||
#ifndef Q_OS_LINUX
|
||||
if (handleForwardBackwardMouseButtons(e))
|
||||
return;
|
||||
#endif
|
||||
|
||||
bool controlPressed = e->modifiers() & Qt::ControlModifier;
|
||||
if ((controlPressed && d->hasAnchorAt(this, e->pos())) ||
|
||||
(e->button() == Qt::MidButton && d->hasAnchorAt(this, e->pos()))) {
|
||||
d->openLinkInNewPage();
|
||||
return;
|
||||
}
|
||||
|
||||
QTextBrowser::mouseReleaseEvent(e);
|
||||
}
|
||||
|
||||
// -- private slots
|
||||
|
||||
void HelpViewer::actionChanged()
|
||||
{
|
||||
// stub
|
||||
}
|
||||
|
||||
void HelpViewer::setLoadFinished(bool ok)
|
||||
{
|
||||
Q_UNUSED(ok)
|
||||
emit sourceChanged(source());
|
||||
}
|
||||
|
||||
// -- private
|
||||
|
||||
bool HelpViewer::eventFilter(QObject *obj, QEvent *event)
|
||||
{
|
||||
if (event->type() == QEvent::FontChange && !d->forceFont)
|
||||
return true;
|
||||
return QTextBrowser::eventFilter(obj, event);
|
||||
}
|
||||
|
||||
void HelpViewer::contextMenuEvent(QContextMenuEvent *event)
|
||||
{
|
||||
QMenu menu(QLatin1String(""), 0);
|
||||
|
||||
QUrl link;
|
||||
QAction *copyAnchorAction = 0;
|
||||
if (d->hasAnchorAt(this, event->pos())) {
|
||||
link = anchorAt(event->pos());
|
||||
if (link.isRelative())
|
||||
link = source().resolved(link);
|
||||
menu.addAction(tr("Open Link"), d, SLOT(openLink()));
|
||||
menu.addAction(tr("Open Link as New Page"), d, SLOT(openLinkInNewPage()));
|
||||
|
||||
if (!link.isEmpty() && link.isValid())
|
||||
copyAnchorAction = menu.addAction(tr("Copy Link"));
|
||||
} else if (!selectedText().isEmpty()) {
|
||||
menu.addAction(tr("Copy"), this, SLOT(copy()));
|
||||
} else {
|
||||
menu.addAction(tr("Reload"), this, SLOT(reload()));
|
||||
}
|
||||
|
||||
if (copyAnchorAction == menu.exec(event->globalPos()))
|
||||
QApplication::clipboard()->setText(link.toString());
|
||||
}
|
||||
|
||||
QVariant HelpViewer::loadResource(int type, const QUrl &name)
|
||||
{
|
||||
QByteArray ba;
|
||||
if (type < 4) {
|
||||
const QHelpEngineCore &engine = HelpManager::instance().helpEngineCore();
|
||||
ba = engine.fileData(name);
|
||||
if (name.toString().endsWith(QLatin1String(".svg"), Qt::CaseInsensitive)) {
|
||||
QImage image;
|
||||
image.loadFromData(ba, "svg");
|
||||
if (!image.isNull())
|
||||
return image;
|
||||
}
|
||||
}
|
||||
return ba;
|
||||
}
|
||||
|
||||
#endif // QT_NO_WEBKIT
|
||||
Reference in New Issue
Block a user