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

Help: Add method for showing URL in specific viewer

Browse Source 
That centralizes all the focus setting, raising of windows, etc. This
was for example already done wrong when opening links in help mode and
external window.

Change-Id: I5036b5caa751d1f36dc442078624a31fb8f573ee
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
This commit is contained in:
Eike Ziller
2017-07-11 17:05:40 +02:00
parent be3dbd4c53
commit 6afc0c3eb6
3 changed files with 26 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
src/plugins/help/helpplugin.cpp
View File

@@ -362,7 +362,6 @@ HelpViewer *HelpPlugin::externalHelpViewer()
else else
m_externalWindow->setGeometry(m_externalWindowState); m_externalWindow->setGeometry(m_externalWindowState);
m_externalWindow->show(); m_externalWindow->show();
m_externalWindow->setFocus();
return m_externalWindow->currentViewer(); return m_externalWindow->currentViewer();
} }
@@ -428,10 +427,7 @@ void HelpPlugin::activateHelpMode()
void HelpPlugin::showLinkInHelpMode(const QUrl &source) void HelpPlugin::showLinkInHelpMode(const QUrl &source)
{ {
activateHelpMode(); showInHelpViewer(source, helpModeHelpViewer());
ICore::raiseWindow(m_mode->widget());
m_centralWidget->setSource(source);
m_centralWidget->setFocus();
} }
void HelpPlugin::showLinksInHelpMode(const QMap<QString, QUrl> &links, const QString &key) void HelpPlugin::showLinksInHelpMode(const QMap<QString, QUrl> &links, const QString &key)
@@ -494,6 +490,15 @@ bool HelpPlugin::canShowHelpSideBySide()
return true; return true;
} }
HelpViewer *HelpPlugin::helpModeHelpViewer()
{
activateHelpMode(); // should trigger an createPage...
HelpViewer *viewer = m_instance->m_centralWidget->currentViewer();
if (!viewer)
viewer = OpenPagesManager::instance().createPage();
return viewer;
}
HelpViewer *HelpPlugin::viewerForHelpViewerLocation(HelpManager::HelpViewerLocation location) HelpViewer *HelpPlugin::viewerForHelpViewerLocation(HelpManager::HelpViewerLocation location)
{ {
HelpManager::HelpViewerLocation actualLocation = location; HelpManager::HelpViewerLocation actualLocation = location;
@@ -513,11 +518,16 @@ HelpViewer *HelpPlugin::viewerForHelpViewerLocation(HelpManager::HelpViewerLocat
QTC_CHECK(actualLocation == HelpManager::HelpModeAlways); QTC_CHECK(actualLocation == HelpManager::HelpModeAlways);
activateHelpMode(); // should trigger an createPage... return m_instance->helpModeHelpViewer();
HelpViewer *viewer = m_instance->m_centralWidget->currentViewer(); }
if (!viewer)
viewer = OpenPagesManager::instance().createPage(); void HelpPlugin::showInHelpViewer(const QUrl &url, HelpViewer *viewer)
return viewer; {
QTC_ASSERT(viewer, return);
viewer->setFocus();
viewer->stop();
viewer->setSource(url);
ICore::raiseWindow(viewer);
} }
HelpViewer *HelpPlugin::viewerForContextHelp() HelpViewer *HelpPlugin::viewerForContextHelp()
@@ -574,7 +584,7 @@ void HelpPlugin::showContextHelp()
QUrl source = findBestLink(links, &m_contextHelpHighlightId); QUrl source = findBestLink(links, &m_contextHelpHighlightId);
if (!source.isValid()) { if (!source.isValid()) {
// No link found or no context object // No link found or no context object
viewer->setSource(QUrl(Help::Constants::AboutBlank)); showInHelpViewer(QUrl(Help::Constants::AboutBlank), viewer);
viewer->setHtml(tr("<html><head><title>No Documentation</title>" viewer->setHtml(tr("<html><head><title>No Documentation</title>"
"</head><body><br/><center>" "</head><body><br/><center>"
"<font color=\"%1\"><b>%2</b></font><br/>" "<font color=\"%1\"><b>%2</b></font><br/>"
@@ -584,10 +594,7 @@ void HelpPlugin::showContextHelp()
.arg(contextHelpId) .arg(contextHelpId)
.arg(creatorTheme()->color(Theme::TextColorNormal).name())); .arg(creatorTheme()->color(Theme::TextColorNormal).name()));
} else { } else {
viewer->setFocus(); showInHelpViewer(source, viewer); // triggers loadFinished which triggers id highlighting
viewer->stop();
viewer->setSource(source); // triggers loadFinished which triggers id highlighting
ICore::raiseWindow(viewer);
} }
} }
@@ -635,9 +642,7 @@ void HelpPlugin::handleHelpRequest(const QUrl &url, HelpManager::HelpViewerLocat
} }
HelpViewer *viewer = viewerForHelpViewerLocation(location); HelpViewer *viewer = viewerForHelpViewerLocation(location);
QTC_ASSERT(viewer, return); showInHelpViewer(url, viewer);
viewer->setSource(url);
ICore::raiseWindow(viewer);
} }
class DialogClosingOnEscape : public QDialog class DialogClosingOnEscape : public QDialog

2
src/plugins/help/helpplugin.h
View File

@@ -76,6 +76,7 @@ public:
ShutdownFlag aboutToShutdown(); ShutdownFlag aboutToShutdown();
static HelpViewer *viewerForHelpViewerLocation(Core::HelpManager::HelpViewerLocation location); static HelpViewer *viewerForHelpViewerLocation(Core::HelpManager::HelpViewerLocation location);
static void showInHelpViewer(const QUrl &url, HelpViewer *viewer);
static HelpViewer *createHelpViewer(qreal zoom); static HelpViewer *createHelpViewer(qreal zoom);
@@ -107,6 +108,7 @@ private:
HelpWidget *createHelpWidget(const Core::Context &context, HelpWidget::WidgetStyle style); HelpWidget *createHelpWidget(const Core::Context &context, HelpWidget::WidgetStyle style);
void createRightPaneContextViewer(); void createRightPaneContextViewer();
HelpViewer *externalHelpViewer(); HelpViewer *externalHelpViewer();
HelpViewer *helpModeHelpViewer();
void doSetupIfNeeded(); void doSetupIfNeeded();

4
src/plugins/help/helpwidget.cpp
View File

@@ -70,9 +70,7 @@ namespace Internal {
static void openUrlInWindow(const QUrl &url) static void openUrlInWindow(const QUrl &url)
{ {
HelpViewer *viewer = HelpPlugin::viewerForHelpViewerLocation(Core::HelpManager::ExternalHelpAlways); HelpViewer *viewer = HelpPlugin::viewerForHelpViewerLocation(Core::HelpManager::ExternalHelpAlways);
if (QTC_GUARD(viewer)) HelpPlugin::showInHelpViewer(url, viewer);
viewer->setSource(url);
Core::ICore::raiseWindow(viewer);
} }
static bool isBookmarkable(const QUrl &url) static bool isBookmarkable(const QUrl &url)