helpwidget.cpp 26 KB
Newer Older
1 2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15 16 17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
27 28 29 30 31 32
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "helpwidget.h"

33
#include "bookmarkmanager.h"
34
#include "contentwindow.h"
35
#include "helpconstants.h"
36 37
#include "helpplugin.h"
#include "helpviewer.h"
38
#include "indexwindow.h"
39
#include "localhelpmanager.h"
40
#include "openpagesmanager.h"
41
#include "searchwidget.h"
42
#include "topicchooser.h"
43 44 45

#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/actionmanager.h>
46
#include <coreplugin/actionmanager/command.h>
47 48 49
#include <coreplugin/coreconstants.h>
#include <coreplugin/icore.h>
#include <coreplugin/findplaceholder.h>
50 51
#include <coreplugin/minisplitter.h>
#include <coreplugin/sidebar.h>
52
#include <texteditor/texteditorconstants.h>
53
#include <utils/qtcassert.h>
54 55
#include <utils/styledbar.h>

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

67 68
static const char kWindowSideBarSettingsKey[] = "Help/WindowSideBar";
static const char kModeSideBarSettingsKey[] = "Help/ModeSideBar";
69 70 71 72

namespace Help {
namespace Internal {

73 74
HelpWidget::HelpWidget(const Core::Context &context, WidgetStyle style, QWidget *parent) :
    QWidget(parent),
75
    m_style(style),
76
    m_toggleSideBarAction(0),
77 78 79
    m_switchToHelp(0),
    m_filterComboBox(0),
    m_closeAction(0),
80 81
    m_scaleUp(0),
    m_scaleDown(0),
82
    m_resetScale(0),
83 84
    m_printer(0),
    m_sideBar(0),
85 86 87 88 89
    m_contentsAction(0),
    m_indexAction(0),
    m_bookmarkAction(0),
    m_searchAction(0),
    m_openPagesAction(0)
90
{
91 92 93 94 95 96 97 98 99 100
    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);

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

    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);

123
    Core::Command *cmd;
124 125 126 127 128 129 130 131
    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
132 133
    }
    if (style != SideBarWidget) {
134
        m_toggleSideBarAction = new QAction(QIcon(QLatin1String(Core::Constants::ICON_TOGGLE_SIDEBAR)),
Sergey Belyashov's avatar
Sergey Belyashov committed
135 136
                                            QCoreApplication::translate("Core", Core::Constants::TR_SHOW_SIDEBAR),
                                            toolBar);
137 138 139 140 141 142
        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
143 144 145 146
                    m_toggleSideBarAction->setText(
                        QCoreApplication::translate("Core",
                                                    checked ? Core::Constants::TR_HIDE_SIDEBAR
                                                            : Core::Constants::TR_SHOW_SIDEBAR));
147 148
                });
        addSideBar();
149
        m_toggleSideBarAction->setChecked(m_sideBar->isVisibleTo(this));
150 151 152 153 154
        connect(m_toggleSideBarAction, &QAction::triggered, m_sideBar, &Core::SideBar::setVisible);
        connect(m_sideBar, &Core::SideBar::sideBarClosed, m_toggleSideBarAction, [this]() {
            m_toggleSideBarAction->setChecked(false);
        });
    }
155 156
    if (style == ExternalWindow)
        layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_toggleSideBarAction, cmd));
157

158 159 160 161
    if (style != ModeWidget) {
        m_switchToHelp = new QAction(tr("Go to Help Mode"), toolBar);
        cmd = Core::ActionManager::registerAction(m_switchToHelp, Constants::CONTEXT_HELP, context);
        connect(m_switchToHelp, SIGNAL(triggered()), this, SLOT(helpModeButtonClicked()));
162
        layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_switchToHelp, cmd));
163
    }
164

165 166 167 168
    m_homeAction = new QAction(QIcon(QLatin1String(":/help/images/home.png")),
        tr("Home"), this);
    cmd = Core::ActionManager::registerAction(m_homeAction, Constants::HELP_HOME, context);
    connect(m_homeAction, &QAction::triggered, this, &HelpWidget::goHome);
169
    layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_homeAction, cmd));
170

171
    m_backAction = new QAction(QIcon(QLatin1String(":/help/images/previous.png")),
172
        tr("Back"), toolBar);
173
    connect(m_backAction, &QAction::triggered, this, &HelpWidget::backward);
174 175
    m_backMenu = new QMenu(toolBar);
    connect(m_backMenu, SIGNAL(aboutToShow()), this, SLOT(updateBackMenu()));
176 177 178
    m_backAction->setMenu(m_backMenu);
    cmd = Core::ActionManager::registerAction(m_backAction, Constants::HELP_PREVIOUS, context);
    cmd->setDefaultKeySequence(QKeySequence::Back);
179 180 181
    button = Core::Command::toolButtonWithAppendedShortcut(m_backAction, cmd);
    button->setPopupMode(QToolButton::DelayedPopup);
    layout->addWidget(button);
182 183

    m_forwardAction = new QAction(QIcon(QLatin1String(":/help/images/next.png")),
184
        tr("Forward"), toolBar);
185
    connect(m_forwardAction, &QAction::triggered, this, &HelpWidget::forward);
186 187
    m_forwardMenu = new QMenu(toolBar);
    connect(m_forwardMenu, SIGNAL(aboutToShow()), this, SLOT(updateForwardMenu()));
188 189 190
    m_forwardAction->setMenu(m_forwardMenu);
    cmd = Core::ActionManager::registerAction(m_forwardAction, Constants::HELP_NEXT, context);
    cmd->setDefaultKeySequence(QKeySequence::Forward);
191 192 193
    button = Core::Command::toolButtonWithAppendedShortcut(m_forwardAction, cmd);
    button->setPopupMode(QToolButton::DelayedPopup);
    layout->addWidget(button);
194

195 196
    m_addBookmarkAction = new QAction(QIcon(QLatin1String(":/help/images/bookmark.png")),
        tr("Add Bookmark"), this);
Eike Ziller's avatar
Eike Ziller committed
197
    cmd = Core::ActionManager::registerAction(m_addBookmarkAction, Constants::HELP_ADDBOOKMARK, context);
198 199 200
    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));
201
    layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_addBookmarkAction, cmd));
202

203 204 205
    if (style == ModeWidget) {
        layout->addWidget(new Utils::StyledSeparator(toolBar));
        layout->addWidget(OpenPagesManager::instance().openPagesComboBox(), 10);
206 207 208 209
    } else {
        layout->addWidget(new QLabel(), 10);
    }
    if (style != SideBarWidget) {
210 211 212
        m_filterComboBox = new QComboBox;
        m_filterComboBox->setMinimumContentsLength(15);
        m_filterComboBox->setModel(LocalHelpManager::filterModel());
213
        m_filterComboBox->setCurrentIndex(LocalHelpManager::filterIndex());
214 215 216 217 218 219 220
        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);
    }

221 222
    layout->addStretch();

223 224 225
    m_printAction = new QAction(this);
    Core::ActionManager::registerAction(m_printAction, Core::Constants::PRINT, context);
    connect(m_printAction, &QAction::triggered, this, [this]() { print(currentViewer()); });
226

227
    m_copy = new QAction(this);
228
    Core::ActionManager::registerAction(m_copy, Core::Constants::COPY, context);
229
    connect(m_copy, &QAction::triggered, this, &HelpWidget::copy);
230 231 232 233

    Core::ActionContainer *advancedMenu = Core::ActionManager::actionContainer(Core::Constants::M_EDIT_ADVANCED);
    QTC_CHECK(advancedMenu);
    if (advancedMenu) {
234
        // reuse TextEditor constants to avoid a second pair of menu actions
235 236
        m_scaleUp = new QAction(tr("Increase Font Size"), this);
        cmd = Core::ActionManager::registerAction(m_scaleUp, TextEditor::Constants::INCREASE_FONT_SIZE,
237
                                                  context);
238
        connect(m_scaleUp, &QAction::triggered, this, &HelpWidget::scaleUp);
239 240
        advancedMenu->addAction(cmd, Core::Constants::G_EDIT_FONT);

241 242
        m_scaleDown = new QAction(tr("Decrease Font Size"), this);
        cmd = Core::ActionManager::registerAction(m_scaleDown, TextEditor::Constants::DECREASE_FONT_SIZE,
243
                                                  context);
244
        connect(m_scaleDown, &QAction::triggered, this, &HelpWidget::scaleDown);
245 246
        advancedMenu->addAction(cmd, Core::Constants::G_EDIT_FONT);

247 248
        m_resetScale = new QAction(tr("Reset Font Size"), this);
        cmd = Core::ActionManager::registerAction(m_resetScale, TextEditor::Constants::RESET_FONT_SIZE,
249
                                                  context);
250
        connect(m_resetScale, &QAction::triggered, this, &HelpWidget::resetScale);
251 252
        advancedMenu->addAction(cmd, Core::Constants::G_EDIT_FONT);
    }
253

254
    if (style != ExternalWindow) {
255
        m_closeAction = new QAction(QIcon(QLatin1String(Core::Constants::ICON_BUTTON_CLOSE)),
256
            QString(), toolBar);
257
        connect(m_closeAction, SIGNAL(triggered()), this, SIGNAL(closeButtonClicked()));
258 259 260
        button = new QToolButton;
        button->setDefaultAction(m_closeAction);
        layout->addWidget(button);
261 262 263 264 265 266
    }

    if (style != ModeWidget) {
        HelpViewer *viewer = HelpPlugin::createHelpViewer(qreal(0.0));
        addViewer(viewer);
        setCurrentViewer(viewer);
267 268 269 270 271
    }
}

HelpWidget::~HelpWidget()
{
272
    if (m_sideBar) {
273
        m_sideBar->saveSettings(Core::ICore::settings(), sideBarSettingsKey());
274
        Core::ActionManager::unregisterAction(m_contentsAction, Constants::HELP_CONTENTS);
275
        Core::ActionManager::unregisterAction(m_indexAction, Constants::HELP_INDEX);
Eike Ziller's avatar
Eike Ziller committed
276
        Core::ActionManager::unregisterAction(m_bookmarkAction, Constants::HELP_BOOKMARKS);
277
        Core::ActionManager::unregisterAction(m_searchAction, Constants::HELP_SEARCH);
278 279
        if (m_openPagesAction)
            Core::ActionManager::unregisterAction(m_openPagesAction, Constants::HELP_OPENPAGES);
280
    }
281
    Core::ICore::removeContextObject(m_context);
282
    Core::ActionManager::unregisterAction(m_copy, Core::Constants::COPY);
283
    Core::ActionManager::unregisterAction(m_printAction, Core::Constants::PRINT);
284 285
    if (m_toggleSideBarAction)
        Core::ActionManager::unregisterAction(m_toggleSideBarAction, Core::Constants::TOGGLE_SIDEBAR);
286 287
    if (m_switchToHelp)
        Core::ActionManager::unregisterAction(m_switchToHelp, Constants::CONTEXT_HELP);
288
    Core::ActionManager::unregisterAction(m_homeAction, Constants::HELP_HOME);
289 290
    Core::ActionManager::unregisterAction(m_forwardAction, Constants::HELP_NEXT);
    Core::ActionManager::unregisterAction(m_backAction, Constants::HELP_PREVIOUS);
Eike Ziller's avatar
Eike Ziller committed
291
    Core::ActionManager::unregisterAction(m_addBookmarkAction, Constants::HELP_ADDBOOKMARK);
292 293 294 295 296 297
    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);
298 299
}

300 301 302 303
void HelpWidget::addSideBar()
{
    QMap<QString, Core::Command *> shortcutMap;
    Core::Command *cmd;
304
    bool supportsNewPages = (m_style == ModeWidget);
305

306 307
    auto contentWindow = new ContentWindow;
    auto contentItem = new Core::SideBarItem(contentWindow, QLatin1String(Constants::HELP_CONTENTS));
308
    contentWindow->setOpenInNewPageActionVisible(supportsNewPages);
309
    contentWindow->setWindowTitle(HelpPlugin::tr(Constants::SB_CONTENTS));
310 311
    connect(contentWindow, &ContentWindow::linkActivated,
            this, &HelpWidget::open);
312
    m_contentsAction = new QAction(tr(Constants::SB_CONTENTS), this);
313 314 315 316 317
    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);

318
    auto indexWindow = new IndexWindow();
Eike Ziller's avatar
Eike Ziller committed
319
    auto indexItem = new Core::SideBarItem(indexWindow, QLatin1String(Constants::HELP_INDEX));
320
    indexWindow->setOpenInNewPageActionVisible(supportsNewPages);
321
    indexWindow->setWindowTitle(HelpPlugin::tr(Constants::SB_INDEX));
322 323 324 325
    connect(indexWindow, &IndexWindow::linkActivated,
            this, &HelpWidget::open);
    connect(indexWindow, &IndexWindow::linksActivated,
        this, &HelpWidget::showTopicChooser);
326
    m_indexAction = new QAction(tr(Constants::SB_INDEX), this);
327 328 329
    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
330
    shortcutMap.insert(QLatin1String(Constants::HELP_INDEX), cmd);
331

Eike Ziller's avatar
Eike Ziller committed
332
    auto bookmarkWidget = new BookmarkWidget(&LocalHelpManager::bookmarkManager());
333
    bookmarkWidget->setWindowTitle(HelpPlugin::tr(Constants::SB_BOOKMARKS));
334
    bookmarkWidget->setOpenInNewPageActionVisible(supportsNewPages);
Eike Ziller's avatar
Eike Ziller committed
335 336 337 338 339 340
    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());
341
    cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Alt+Meta+M")
Eike Ziller's avatar
Eike Ziller committed
342 343 344
                                                                  : tr("Ctrl+Shift+B")));
    shortcutMap.insert(QLatin1String(Constants::HELP_BOOKMARKS), cmd);

345 346 347 348 349 350 351 352 353
    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);

354 355 356
    Core::SideBarItem *openPagesItem = 0;
    if (m_style == ModeWidget) {
        QWidget *openPagesWidget = OpenPagesManager::instance().openPagesWidget();
357
        openPagesWidget->setWindowTitle(HelpPlugin::tr(Constants::SB_OPENPAGES));
358 359 360 361 362 363 364 365 366 367
        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);
    }

368
    QList<Core::SideBarItem *> itemList;
369
    itemList << contentItem << indexItem << bookmarkItem << searchItem;
370 371
    if (openPagesItem)
         itemList << openPagesItem;
372
    m_sideBar = new Core::SideBar(itemList,
373 374
                                  QList<Core::SideBarItem *>() << contentItem
                                  << (openPagesItem ? openPagesItem : indexItem));
375 376 377 378 379
    m_sideBar->setShortcutMap(shortcutMap);
    m_sideBar->setCloseWhenEmpty(true);
    m_sideBarSplitter->insertWidget(0, m_sideBar);
    m_sideBarSplitter->setStretchFactor(0, 0);
    m_sideBarSplitter->setStretchFactor(1, 1);
380 381
    if (m_style != ModeWidget)
        m_sideBar->setVisible(false);
382
    m_sideBar->resize(250, size().height());
383
    m_sideBar->readSettings(Core::ICore::settings(), sideBarSettingsKey());
384 385
    m_sideBarSplitter->setSizes(QList<int>() << m_sideBar->size().width() << 300);

386 387 388
    connect(m_contentsAction, &QAction::triggered, m_sideBar, [this]() {
        m_sideBar->activateItem(QLatin1String(Constants::HELP_CONTENTS));
    });
Eike Ziller's avatar
Eike Ziller committed
389 390
    connect(m_indexAction, &QAction::triggered, m_sideBar, [this]() {
        m_sideBar->activateItem(QLatin1String(Constants::HELP_INDEX));
391
    });
Eike Ziller's avatar
Eike Ziller committed
392 393 394
    connect(m_bookmarkAction, &QAction::triggered, m_sideBar, [this]() {
        m_sideBar->activateItem(QLatin1String(Constants::HELP_BOOKMARKS));
    });
395 396 397
    connect(m_searchAction, &QAction::triggered, m_sideBar, [this]() {
        m_sideBar->activateItem(QLatin1String(Constants::HELP_SEARCH));
    });
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
    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();
417 418
}

419 420
HelpViewer *HelpWidget::currentViewer() const
{
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
    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();
}

439
void HelpWidget::addViewer(HelpViewer *viewer)
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
{
    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)
        connect(viewer, SIGNAL(titleChanged()), this, SLOT(updateWindowTitle()));

463
    connect(viewer, &HelpViewer::loadFinished, this, &HelpWidget::highlightSearchTerms);
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489

    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));
}

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
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);
}

506 507 508 509 510 511
void HelpWidget::activateSideBarItem(const QString &id)
{
    QTC_ASSERT(m_sideBar, return);
    m_sideBar->activateItem(id);
}

512 513 514 515 516 517 518 519
void HelpWidget::setSource(const QUrl &url)
{
    HelpViewer* viewer = currentViewer();
    QTC_ASSERT(viewer, return);
    viewer->setSource(url);
    viewer->setFocus(Qt::OtherFocusReason);
}

520
void HelpWidget::openFromSearch(const QUrl &url, const QStringList &searchTerms, bool newPage)
521
{
522
    m_searchTerms = searchTerms;
523
    if (newPage)
524
        OpenPagesManager::instance().createPage(url);
525 526 527 528 529 530
    else {
        HelpViewer* viewer = currentViewer();
        QTC_ASSERT(viewer, return);
        viewer->setSource(url);
        viewer->setFocus(Qt::OtherFocusReason);
    }
531 532
}

533 534 535 536 537
void HelpWidget::closeEvent(QCloseEvent *)
{
    emit aboutToClose();
}

538 539 540
void HelpWidget::updateBackMenu()
{
    m_backMenu->clear();
541 542
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->addBackHistoryItems(m_backMenu);
543 544 545 546 547
}

void HelpWidget::updateForwardMenu()
{
    m_forwardMenu->clear();
548 549
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->addForwardHistoryItems(m_forwardMenu);
550 551
}

552 553
void HelpWidget::updateWindowTitle()
{
554 555
    QTC_ASSERT(currentViewer(), return);
    const QString pageTitle = currentViewer()->title();
556 557 558 559 560 561
    if (pageTitle.isEmpty())
        setWindowTitle(tr("Help"));
    else
        setWindowTitle(tr("Help - %1").arg(pageTitle));
}

562
void HelpWidget::helpModeButtonClicked()
563
{
564 565
    QTC_ASSERT(currentViewer(), return);
    emit openHelpMode(currentViewer()->source());
566 567
    if (m_style == ExternalWindow)
        close();
568 569
}

570 571 572
void HelpWidget::updateCloseButton()
{
    if (m_style == ModeWidget) {
573
        const bool closeOnReturn = LocalHelpManager::returnOnClose();
574 575 576 577
        m_closeAction->setEnabled(closeOnReturn || m_viewerStack->count() > 1);
    }
}

578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
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);
}

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 642 643 644 645 646 647 648 649 650
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()
{
651 652 653 654 655 656 657
    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();
658 659
}

660 661
} // Internal
} // Help