helpwidget.cpp 25.6 KB
Newer Older
1 2
/****************************************************************************
**
3 4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
5 6 7 8 9 10 11
**
** 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
12 13 14
** 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.
15
**
16 17 18 19 20 21 22
** 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.
23 24 25 26 27
**
****************************************************************************/

#include "helpwidget.h"

28
#include "bookmarkmanager.h"
29
#include "contentwindow.h"
30
#include "helpconstants.h"
31
#include "helpicons.h"
32 33
#include "helpplugin.h"
#include "helpviewer.h"
34
#include "indexwindow.h"
35
#include "localhelpmanager.h"
36
#include "openpagesmanager.h"
37
#include "searchwidget.h"
38
#include "topicchooser.h"
39 40 41

#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/actionmanager.h>
42
#include <coreplugin/actionmanager/command.h>
43
#include <coreplugin/coreconstants.h>
44
#include <coreplugin/coreicons.h>
45 46
#include <coreplugin/icore.h>
#include <coreplugin/findplaceholder.h>
47 48
#include <coreplugin/minisplitter.h>
#include <coreplugin/sidebar.h>
49
#include <texteditor/texteditorconstants.h>
50
#include <utils/qtcassert.h>
51 52
#include <utils/styledbar.h>

Sergey Belyashov's avatar
Sergey Belyashov committed
53
#include <QCoreApplication>
54
#include <QHBoxLayout>
55 56 57
#include <QHelpEngine>
#include <QHelpSearchEngine>
#include <QHelpSearchQuery>
58
#include <QMenu>
59 60 61
#include <QPrinter>
#include <QPrintDialog>
#include <QStackedWidget>
62 63
#include <QToolButton>

64 65
static const char kWindowSideBarSettingsKey[] = "Help/WindowSideBar";
static const char kModeSideBarSettingsKey[] = "Help/ModeSideBar";
66 67 68 69

namespace Help {
namespace Internal {

70 71
HelpWidget::HelpWidget(const Core::Context &context, WidgetStyle style, QWidget *parent) :
    QWidget(parent),
72
    m_style(style),
73
    m_toggleSideBarAction(0),
74 75 76
    m_switchToHelp(0),
    m_filterComboBox(0),
    m_closeAction(0),
77 78
    m_scaleUp(0),
    m_scaleDown(0),
79
    m_resetScale(0),
80 81
    m_printer(0),
    m_sideBar(0),
82 83 84 85 86
    m_contentsAction(0),
    m_indexAction(0),
    m_bookmarkAction(0),
    m_searchAction(0),
    m_openPagesAction(0)
87
{
88 89 90 91 92 93 94 95 96 97
    m_viewerStack = new QStackedWidget;

    auto hLayout = new QHBoxLayout(this);
    hLayout->setMargin(0);
    hLayout->setSpacing(0);

    m_sideBarSplitter = new Core::MiniSplitter(this);
    m_sideBarSplitter->setOpaqueResize(false);
    hLayout->addWidget(m_sideBarSplitter);

98
    Utils::StyledBar *toolBar = new Utils::StyledBar();
99 100 101
    QHBoxLayout *layout = new QHBoxLayout(toolBar);
    layout->setSpacing(0);
    layout->setMargin(0);
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119

    auto rightSide = new QWidget(this);
    m_sideBarSplitter->insertWidget(1, rightSide);
    QVBoxLayout *vLayout = new QVBoxLayout(rightSide);
    vLayout->setMargin(0);
    vLayout->setSpacing(0);
    vLayout->addWidget(toolBar);
    vLayout->addWidget(m_viewerStack);
    Core::FindToolBarPlaceHolder *fth = new Core::FindToolBarPlaceHolder(this);
    vLayout->addWidget(fth);

    setFocusProxy(m_viewerStack);

    m_context = new Core::IContext(this);
    m_context->setContext(context);
    m_context->setWidget(m_sideBarSplitter);
    Core::ICore::addContextObject(m_context);

120
    Core::Command *cmd;
121 122 123 124 125 126 127 128
    QToolButton *button;

    if (style == ExternalWindow) {
        static int windowId = 0;
        Core::ICore::registerWindow(this,
                                    Core::Context(Core::Id("Help.Window.").withSuffix(++windowId)));
        setAttribute(Qt::WA_DeleteOnClose);
        setAttribute(Qt::WA_QuitOnClose, false); // don't prevent Qt Creator from closing
129 130
    }
    if (style != SideBarWidget) {
131
        m_toggleSideBarAction = new QAction(Core::Icons::TOGGLE_SIDEBAR_TOOLBAR.icon(),
Sergey Belyashov's avatar
Sergey Belyashov committed
132 133
                                            QCoreApplication::translate("Core", Core::Constants::TR_SHOW_SIDEBAR),
                                            toolBar);
134 135 136 137 138 139
        m_toggleSideBarAction->setCheckable(true);
        m_toggleSideBarAction->setChecked(false);
        cmd = Core::ActionManager::registerAction(m_toggleSideBarAction,
                                                  Core::Constants::TOGGLE_SIDEBAR, context);
        connect(m_toggleSideBarAction, &QAction::toggled, m_toggleSideBarAction,
                [this](bool checked) {
Sergey Belyashov's avatar
Sergey Belyashov committed
140 141 142 143
                    m_toggleSideBarAction->setText(
                        QCoreApplication::translate("Core",
                                                    checked ? Core::Constants::TR_HIDE_SIDEBAR
                                                            : Core::Constants::TR_SHOW_SIDEBAR));
144 145
                });
        addSideBar();
146
        m_toggleSideBarAction->setChecked(m_sideBar->isVisibleTo(this));
147 148 149 150 151
        connect(m_toggleSideBarAction, &QAction::triggered, m_sideBar, &Core::SideBar::setVisible);
        connect(m_sideBar, &Core::SideBar::sideBarClosed, m_toggleSideBarAction, [this]() {
            m_toggleSideBarAction->setChecked(false);
        });
    }
152 153
    if (style == ExternalWindow)
        layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_toggleSideBarAction, cmd));
154

155 156 157
    if (style != ModeWidget) {
        m_switchToHelp = new QAction(tr("Go to Help Mode"), toolBar);
        cmd = Core::ActionManager::registerAction(m_switchToHelp, Constants::CONTEXT_HELP, context);
Montel Laurent's avatar
Montel Laurent committed
158
        connect(m_switchToHelp, &QAction::triggered, this, &HelpWidget::helpModeButtonClicked);
159
        layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_switchToHelp, cmd));
160
    }
161

162
    m_homeAction = new QAction(Icons::HOME_TOOLBAR.icon(), tr("Home"), this);
163 164
    cmd = Core::ActionManager::registerAction(m_homeAction, Constants::HELP_HOME, context);
    connect(m_homeAction, &QAction::triggered, this, &HelpWidget::goHome);
165
    layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_homeAction, cmd));
166

167
    m_backAction = new QAction(Core::Icons::PREV_TOOLBAR.icon(), tr("Back"), toolBar);
168
    connect(m_backAction, &QAction::triggered, this, &HelpWidget::backward);
169
    m_backMenu = new QMenu(toolBar);
Montel Laurent's avatar
Montel Laurent committed
170
    connect(m_backMenu, &QMenu::aboutToShow, this, &HelpWidget::updateBackMenu);
171 172 173
    m_backAction->setMenu(m_backMenu);
    cmd = Core::ActionManager::registerAction(m_backAction, Constants::HELP_PREVIOUS, context);
    cmd->setDefaultKeySequence(QKeySequence::Back);
174 175 176
    button = Core::Command::toolButtonWithAppendedShortcut(m_backAction, cmd);
    button->setPopupMode(QToolButton::DelayedPopup);
    layout->addWidget(button);
177

178
    m_forwardAction = new QAction(Core::Icons::NEXT_TOOLBAR.icon(), tr("Forward"), toolBar);
179
    connect(m_forwardAction, &QAction::triggered, this, &HelpWidget::forward);
180
    m_forwardMenu = new QMenu(toolBar);
Montel Laurent's avatar
Montel Laurent committed
181
    connect(m_forwardMenu, &QMenu::aboutToShow, this, &HelpWidget::updateForwardMenu);
182 183 184
    m_forwardAction->setMenu(m_forwardMenu);
    cmd = Core::ActionManager::registerAction(m_forwardAction, Constants::HELP_NEXT, context);
    cmd->setDefaultKeySequence(QKeySequence::Forward);
185 186 187
    button = Core::Command::toolButtonWithAppendedShortcut(m_forwardAction, cmd);
    button->setPopupMode(QToolButton::DelayedPopup);
    layout->addWidget(button);
188

189
    m_addBookmarkAction = new QAction(Icons::BOOKMARK_TOOLBAR.icon(), tr("Add Bookmark"), this);
Eike Ziller's avatar
Eike Ziller committed
190
    cmd = Core::ActionManager::registerAction(m_addBookmarkAction, Constants::HELP_ADDBOOKMARK, context);
191 192 193
    cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Meta+M") : tr("Ctrl+M")));
    connect(m_addBookmarkAction, &QAction::triggered, this, &HelpWidget::addBookmark);
    layout->addWidget(new Utils::StyledSeparator(toolBar));
194
    layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_addBookmarkAction, cmd));
195

196 197 198
    if (style == ModeWidget) {
        layout->addWidget(new Utils::StyledSeparator(toolBar));
        layout->addWidget(OpenPagesManager::instance().openPagesComboBox(), 10);
199 200 201 202
    } else {
        layout->addWidget(new QLabel(), 10);
    }
    if (style != SideBarWidget) {
203 204 205
        m_filterComboBox = new QComboBox;
        m_filterComboBox->setMinimumContentsLength(15);
        m_filterComboBox->setModel(LocalHelpManager::filterModel());
206
        m_filterComboBox->setCurrentIndex(LocalHelpManager::filterIndex());
207 208 209 210 211 212 213
        layout->addWidget(m_filterComboBox);
        connect(m_filterComboBox, static_cast<void (QComboBox::*)(int)>(&QComboBox::activated),
                LocalHelpManager::instance(), &LocalHelpManager::setFilterIndex);
        connect(LocalHelpManager::instance(), &LocalHelpManager::filterIndexChanged,
                m_filterComboBox, &QComboBox::setCurrentIndex);
    }

214 215
    layout->addStretch();

216 217 218
    m_printAction = new QAction(this);
    Core::ActionManager::registerAction(m_printAction, Core::Constants::PRINT, context);
    connect(m_printAction, &QAction::triggered, this, [this]() { print(currentViewer()); });
219

220
    m_copy = new QAction(this);
221
    Core::ActionManager::registerAction(m_copy, Core::Constants::COPY, context);
222
    connect(m_copy, &QAction::triggered, this, &HelpWidget::copy);
223 224

    Core::ActionContainer *advancedMenu = Core::ActionManager::actionContainer(Core::Constants::M_EDIT_ADVANCED);
Eike Ziller's avatar
Eike Ziller committed
225
    if (QTC_GUARD(advancedMenu)) {
226
        // reuse TextEditor constants to avoid a second pair of menu actions
227 228
        m_scaleUp = new QAction(tr("Increase Font Size"), this);
        cmd = Core::ActionManager::registerAction(m_scaleUp, TextEditor::Constants::INCREASE_FONT_SIZE,
229
                                                  context);
230
        connect(m_scaleUp, &QAction::triggered, this, &HelpWidget::scaleUp);
231 232
        advancedMenu->addAction(cmd, Core::Constants::G_EDIT_FONT);

233 234
        m_scaleDown = new QAction(tr("Decrease Font Size"), this);
        cmd = Core::ActionManager::registerAction(m_scaleDown, TextEditor::Constants::DECREASE_FONT_SIZE,
235
                                                  context);
236
        connect(m_scaleDown, &QAction::triggered, this, &HelpWidget::scaleDown);
237 238
        advancedMenu->addAction(cmd, Core::Constants::G_EDIT_FONT);

239 240
        m_resetScale = new QAction(tr("Reset Font Size"), this);
        cmd = Core::ActionManager::registerAction(m_resetScale, TextEditor::Constants::RESET_FONT_SIZE,
241
                                                  context);
242
        connect(m_resetScale, &QAction::triggered, this, &HelpWidget::resetScale);
243 244
        advancedMenu->addAction(cmd, Core::Constants::G_EDIT_FONT);
    }
245

246
    if (style != ExternalWindow) {
247
        m_closeAction = new QAction(Core::Icons::CLOSE_TOOLBAR.icon(), QString(), toolBar);
248
        connect(m_closeAction, SIGNAL(triggered()), this, SIGNAL(closeButtonClicked()));
249 250 251
        button = new QToolButton;
        button->setDefaultAction(m_closeAction);
        layout->addWidget(button);
252 253 254 255 256 257
    }

    if (style != ModeWidget) {
        HelpViewer *viewer = HelpPlugin::createHelpViewer(qreal(0.0));
        addViewer(viewer);
        setCurrentViewer(viewer);
258 259 260 261 262
    }
}

HelpWidget::~HelpWidget()
{
263
    if (m_sideBar) {
264
        m_sideBar->saveSettings(Core::ICore::settings(), sideBarSettingsKey());
265
        Core::ActionManager::unregisterAction(m_contentsAction, Constants::HELP_CONTENTS);
266
        Core::ActionManager::unregisterAction(m_indexAction, Constants::HELP_INDEX);
Eike Ziller's avatar
Eike Ziller committed
267
        Core::ActionManager::unregisterAction(m_bookmarkAction, Constants::HELP_BOOKMARKS);
268
        Core::ActionManager::unregisterAction(m_searchAction, Constants::HELP_SEARCH);
269 270
        if (m_openPagesAction)
            Core::ActionManager::unregisterAction(m_openPagesAction, Constants::HELP_OPENPAGES);
271
    }
272
    Core::ICore::removeContextObject(m_context);
273
    Core::ActionManager::unregisterAction(m_copy, Core::Constants::COPY);
274
    Core::ActionManager::unregisterAction(m_printAction, Core::Constants::PRINT);
275 276
    if (m_toggleSideBarAction)
        Core::ActionManager::unregisterAction(m_toggleSideBarAction, Core::Constants::TOGGLE_SIDEBAR);
277 278
    if (m_switchToHelp)
        Core::ActionManager::unregisterAction(m_switchToHelp, Constants::CONTEXT_HELP);
279
    Core::ActionManager::unregisterAction(m_homeAction, Constants::HELP_HOME);
280 281
    Core::ActionManager::unregisterAction(m_forwardAction, Constants::HELP_NEXT);
    Core::ActionManager::unregisterAction(m_backAction, Constants::HELP_PREVIOUS);
Eike Ziller's avatar
Eike Ziller committed
282
    Core::ActionManager::unregisterAction(m_addBookmarkAction, Constants::HELP_ADDBOOKMARK);
283 284 285 286 287 288
    if (m_scaleUp)
        Core::ActionManager::unregisterAction(m_scaleUp, TextEditor::Constants::INCREASE_FONT_SIZE);
    if (m_scaleDown)
        Core::ActionManager::unregisterAction(m_scaleDown, TextEditor::Constants::DECREASE_FONT_SIZE);
    if (m_resetScale)
        Core::ActionManager::unregisterAction(m_resetScale, TextEditor::Constants::RESET_FONT_SIZE);
289 290
}

291 292 293 294
void HelpWidget::addSideBar()
{
    QMap<QString, Core::Command *> shortcutMap;
    Core::Command *cmd;
295
    bool supportsNewPages = (m_style == ModeWidget);
296

297 298
    auto contentWindow = new ContentWindow;
    auto contentItem = new Core::SideBarItem(contentWindow, QLatin1String(Constants::HELP_CONTENTS));
299
    contentWindow->setOpenInNewPageActionVisible(supportsNewPages);
300
    contentWindow->setWindowTitle(HelpPlugin::tr(Constants::SB_CONTENTS));
301 302
    connect(contentWindow, &ContentWindow::linkActivated,
            this, &HelpWidget::open);
303
    m_contentsAction = new QAction(tr(Constants::SB_CONTENTS), this);
304 305 306 307 308
    cmd = Core::ActionManager::registerAction(m_contentsAction, Constants::HELP_CONTENTS, m_context->context());
    cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Meta+Shift+C")
                                                                  : tr("Ctrl+Shift+C")));
    shortcutMap.insert(QLatin1String(Constants::HELP_CONTENTS), cmd);

309
    auto indexWindow = new IndexWindow();
Eike Ziller's avatar
Eike Ziller committed
310
    auto indexItem = new Core::SideBarItem(indexWindow, QLatin1String(Constants::HELP_INDEX));
311
    indexWindow->setOpenInNewPageActionVisible(supportsNewPages);
312
    indexWindow->setWindowTitle(HelpPlugin::tr(Constants::SB_INDEX));
313 314 315 316
    connect(indexWindow, &IndexWindow::linkActivated,
            this, &HelpWidget::open);
    connect(indexWindow, &IndexWindow::linksActivated,
        this, &HelpWidget::showTopicChooser);
317
    m_indexAction = new QAction(tr(Constants::SB_INDEX), this);
318 319 320
    cmd = Core::ActionManager::registerAction(m_indexAction, Constants::HELP_INDEX, m_context->context());
    cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Meta+I")
                                                                  : tr("Ctrl+Shift+I")));
Eike Ziller's avatar
Eike Ziller committed
321
    shortcutMap.insert(QLatin1String(Constants::HELP_INDEX), cmd);
322

Eike Ziller's avatar
Eike Ziller committed
323
    auto bookmarkWidget = new BookmarkWidget(&LocalHelpManager::bookmarkManager());
324
    bookmarkWidget->setWindowTitle(HelpPlugin::tr(Constants::SB_BOOKMARKS));
325
    bookmarkWidget->setOpenInNewPageActionVisible(supportsNewPages);
Eike Ziller's avatar
Eike Ziller committed
326 327 328 329 330 331
    auto bookmarkItem = new Core::SideBarItem(bookmarkWidget,
                                              QLatin1String(Constants::HELP_BOOKMARKS));
    connect(bookmarkWidget, &BookmarkWidget::linkActivated, this, &HelpWidget::setSource);
    m_bookmarkAction = new QAction(tr("Activate Help Bookmarks View"), this);
    cmd = Core::ActionManager::registerAction(m_bookmarkAction, Constants::HELP_BOOKMARKS,
                                              m_context->context());
332
    cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Alt+Meta+M")
Eike Ziller's avatar
Eike Ziller committed
333 334 335
                                                                  : tr("Ctrl+Shift+B")));
    shortcutMap.insert(QLatin1String(Constants::HELP_BOOKMARKS), cmd);

336 337 338 339 340 341 342 343 344
    auto searchItem = new SearchSideBarItem;
    connect(searchItem, &SearchSideBarItem::linkActivated, this, &HelpWidget::openFromSearch);
    m_searchAction = new QAction(tr("Activate Help Search View"), this);
    cmd = Core::ActionManager::registerAction(m_searchAction, Constants::HELP_SEARCH,
                                              m_context->context());
    cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Meta+/")
                                                                  : tr("Ctrl+Shift+/")));
    shortcutMap.insert(QLatin1String(Constants::HELP_SEARCH), cmd);

345 346 347
    Core::SideBarItem *openPagesItem = 0;
    if (m_style == ModeWidget) {
        QWidget *openPagesWidget = OpenPagesManager::instance().openPagesWidget();
348
        openPagesWidget->setWindowTitle(HelpPlugin::tr(Constants::SB_OPENPAGES));
349 350 351 352 353 354 355 356 357 358
        openPagesItem = new Core::SideBarItem(openPagesWidget,
                                              QLatin1String(Constants::HELP_OPENPAGES));
        m_openPagesAction = new QAction(tr("Activate Open Help Pages View"), this);
        cmd = Core::ActionManager::registerAction(m_openPagesAction, Constants::HELP_OPENPAGES,
                                                  m_context->context());
        cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Meta+O")
                                                                      : tr("Ctrl+Shift+O")));
        shortcutMap.insert(QLatin1String(Constants::HELP_OPENPAGES), cmd);
    }

359
    QList<Core::SideBarItem *> itemList;
360
    itemList << contentItem << indexItem << bookmarkItem << searchItem;
361 362
    if (openPagesItem)
         itemList << openPagesItem;
363
    m_sideBar = new Core::SideBar(itemList,
364 365
                                  QList<Core::SideBarItem *>() << contentItem
                                  << (openPagesItem ? openPagesItem : indexItem));
366 367 368 369 370
    m_sideBar->setShortcutMap(shortcutMap);
    m_sideBar->setCloseWhenEmpty(true);
    m_sideBarSplitter->insertWidget(0, m_sideBar);
    m_sideBarSplitter->setStretchFactor(0, 0);
    m_sideBarSplitter->setStretchFactor(1, 1);
371 372
    if (m_style != ModeWidget)
        m_sideBar->setVisible(false);
373
    m_sideBar->resize(250, size().height());
374
    m_sideBar->readSettings(Core::ICore::settings(), sideBarSettingsKey());
375 376
    m_sideBarSplitter->setSizes(QList<int>() << m_sideBar->size().width() << 300);

377 378 379
    connect(m_contentsAction, &QAction::triggered, m_sideBar, [this]() {
        m_sideBar->activateItem(QLatin1String(Constants::HELP_CONTENTS));
    });
Eike Ziller's avatar
Eike Ziller committed
380 381
    connect(m_indexAction, &QAction::triggered, m_sideBar, [this]() {
        m_sideBar->activateItem(QLatin1String(Constants::HELP_INDEX));
382
    });
Eike Ziller's avatar
Eike Ziller committed
383 384 385
    connect(m_bookmarkAction, &QAction::triggered, m_sideBar, [this]() {
        m_sideBar->activateItem(QLatin1String(Constants::HELP_BOOKMARKS));
    });
386 387 388
    connect(m_searchAction, &QAction::triggered, m_sideBar, [this]() {
        m_sideBar->activateItem(QLatin1String(Constants::HELP_SEARCH));
    });
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
    if (m_openPagesAction) {
        connect(m_openPagesAction, &QAction::triggered, m_sideBar, [this]() {
            m_sideBar->activateItem(QLatin1String(Constants::HELP_OPENPAGES));
        });
    }
}

QString HelpWidget::sideBarSettingsKey() const
{
    switch (m_style) {
    case ModeWidget:
        return QLatin1String(kModeSideBarSettingsKey);
    case ExternalWindow:
        return QLatin1String(kWindowSideBarSettingsKey);
    case SideBarWidget:
        QTC_CHECK(false);
        break;
    }
    return QString();
408 409
}

410 411
HelpViewer *HelpWidget::currentViewer() const
{
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    return qobject_cast<HelpViewer *>(m_viewerStack->currentWidget());
}

void HelpWidget::setCurrentViewer(HelpViewer *viewer)
{
    m_viewerStack->setCurrentWidget(viewer);
    m_backAction->setEnabled(viewer->isBackwardAvailable());
    m_forwardAction->setEnabled(viewer->isForwardAvailable());
    if (m_style == ExternalWindow)
        updateWindowTitle();
    emit sourceChanged(viewer->source());
}

int HelpWidget::currentIndex() const
{
    return m_viewerStack->currentIndex();
}

430
void HelpWidget::addViewer(HelpViewer *viewer)
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
{
    m_viewerStack->addWidget(viewer);
    viewer->setFocus(Qt::OtherFocusReason);
    if (m_style == SideBarWidget || m_style == ExternalWindow)
        viewer->setOpenInNewPageActionVisible(false);
    connect(viewer, &HelpViewer::sourceChanged, this, [viewer, this](const QUrl &url) {
        if (currentViewer() == viewer)
            emit sourceChanged(url);
    });
    connect(viewer, &HelpViewer::forwardAvailable, this, [viewer, this](bool available) {
        if (currentViewer() == viewer)
            m_forwardAction->setEnabled(available);
    });
    connect(viewer, &HelpViewer::backwardAvailable, this, [viewer, this](bool available) {
        if (currentViewer() == viewer)
            m_backAction->setEnabled(available);
    });
    connect(viewer, &HelpViewer::printRequested, this, [viewer, this]() {
        print(viewer);
    });
    if (m_style == ExternalWindow)
Montel Laurent's avatar
Montel Laurent committed
452
        connect(viewer, &HelpViewer::titleChanged, this, &HelpWidget::updateWindowTitle);
453

454
    connect(viewer, &HelpViewer::loadFinished, this, &HelpWidget::highlightSearchTerms);
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480

    updateCloseButton();
}

void HelpWidget::removeViewerAt(int index)
{
    QWidget *viewerWidget = m_viewerStack->widget(index);
    QTC_ASSERT(viewerWidget, return);
    m_viewerStack->removeWidget(viewerWidget);
    // do not delete, that is done in the model
    // delete viewerWidget;
    if (m_viewerStack->currentWidget())
        setCurrentViewer(qobject_cast<HelpViewer *>(m_viewerStack->currentWidget()));
    updateCloseButton();
}

int HelpWidget::viewerCount() const
{
    return m_viewerStack->count();
}

HelpViewer *HelpWidget::viewerAt(int index) const
{
    return qobject_cast<HelpViewer *>(m_viewerStack->widget(index));
}

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
void HelpWidget::open(const QUrl &url, bool newPage)
{
    if (newPage)
        OpenPagesManager::instance().createPage(url);
    else
        setSource(url);
}

void HelpWidget::showTopicChooser(const QMap<QString, QUrl> &links,
    const QString &keyword, bool newPage)
{
    TopicChooser tc(this, keyword, links);
    if (tc.exec() == QDialog::Accepted)
        open(tc.link(), newPage);
}

497 498 499 500 501 502
void HelpWidget::activateSideBarItem(const QString &id)
{
    QTC_ASSERT(m_sideBar, return);
    m_sideBar->activateItem(id);
}

503 504 505 506 507 508 509 510
void HelpWidget::setSource(const QUrl &url)
{
    HelpViewer* viewer = currentViewer();
    QTC_ASSERT(viewer, return);
    viewer->setSource(url);
    viewer->setFocus(Qt::OtherFocusReason);
}

511
void HelpWidget::openFromSearch(const QUrl &url, const QStringList &searchTerms, bool newPage)
512
{
513
    m_searchTerms = searchTerms;
514
    if (newPage)
515
        OpenPagesManager::instance().createPage(url);
516 517 518 519 520 521
    else {
        HelpViewer* viewer = currentViewer();
        QTC_ASSERT(viewer, return);
        viewer->setSource(url);
        viewer->setFocus(Qt::OtherFocusReason);
    }
522 523
}

524 525 526 527 528
void HelpWidget::closeEvent(QCloseEvent *)
{
    emit aboutToClose();
}

529 530 531
void HelpWidget::updateBackMenu()
{
    m_backMenu->clear();
532 533
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->addBackHistoryItems(m_backMenu);
534 535 536 537 538
}

void HelpWidget::updateForwardMenu()
{
    m_forwardMenu->clear();
539 540
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->addForwardHistoryItems(m_forwardMenu);
541 542
}

543 544
void HelpWidget::updateWindowTitle()
{
545 546
    QTC_ASSERT(currentViewer(), return);
    const QString pageTitle = currentViewer()->title();
547 548 549 550 551 552
    if (pageTitle.isEmpty())
        setWindowTitle(tr("Help"));
    else
        setWindowTitle(tr("Help - %1").arg(pageTitle));
}

553
void HelpWidget::helpModeButtonClicked()
554
{
555 556
    QTC_ASSERT(currentViewer(), return);
    emit openHelpMode(currentViewer()->source());
557 558
    if (m_style == ExternalWindow)
        close();
559 560
}

561 562 563
void HelpWidget::updateCloseButton()
{
    if (m_style == ModeWidget) {
564
        const bool closeOnReturn = LocalHelpManager::returnOnClose();
565 566 567 568
        m_closeAction->setEnabled(closeOnReturn || m_viewerStack->count() > 1);
    }
}

569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
void HelpWidget::goHome()
{
    if (HelpViewer *viewer = currentViewer())
        viewer->home();
}

void HelpWidget::addBookmark()
{
    HelpViewer *viewer = currentViewer();
    QTC_ASSERT(viewer, return);

    const QString &url = viewer->source().toString();
    if (url.isEmpty() || url == Help::Constants::AboutBlank)
        return;

    BookmarkManager *manager = &LocalHelpManager::bookmarkManager();
    manager->showBookmarkDialog(this, viewer->title(), url);
}

588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
void HelpWidget::copy()
{
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->copy();
}

void HelpWidget::forward()
{
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->forward();
}

void HelpWidget::backward()
{
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->backward();
}

void HelpWidget::scaleUp()
{
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->scaleUp();
}

void HelpWidget::scaleDown()
{
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->scaleDown();
}

void HelpWidget::resetScale()
{
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->resetScale();
}

void HelpWidget::print(HelpViewer *viewer)
{
    QTC_ASSERT(viewer, return);
    if (!m_printer)
        m_printer = new QPrinter(QPrinter::HighResolution);
    QPrintDialog dlg(m_printer, this);
    dlg.setWindowTitle(tr("Print Documentation"));
    if (!viewer->selectedText().isEmpty())
        dlg.addEnabledOption(QAbstractPrintDialog::PrintSelection);
    dlg.addEnabledOption(QAbstractPrintDialog::PrintPageRange);
    dlg.addEnabledOption(QAbstractPrintDialog::PrintCollateCopies);

    if (dlg.exec() == QDialog::Accepted)
        viewer->print(m_printer);
}

void HelpWidget::highlightSearchTerms()
{
642 643 644 645 646 647 648
    if (m_searchTerms.isEmpty())
        return;
    HelpViewer *viewer = qobject_cast<HelpViewer *>(sender());
    QTC_ASSERT(viewer, return);
    foreach (const QString& term, m_searchTerms)
        viewer->findText(term, 0, false, true);
    m_searchTerms.clear();
649 650
}

651 652
} // Internal
} // Help