helpwidget.cpp 27 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 44 45
#include <coreplugin/coreconstants.h>
#include <coreplugin/icore.h>
#include <coreplugin/findplaceholder.h>
46 47
#include <coreplugin/minisplitter.h>
#include <coreplugin/sidebar.h>
48
#include <texteditor/texteditorconstants.h>
49
#include <utils/qtcassert.h>
50
#include <utils/styledbar.h>
51
#include <utils/utilsicons.h>
52

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

61 62
static const char kWindowSideBarSettingsKey[] = "Help/WindowSideBar";
static const char kModeSideBarSettingsKey[] = "Help/ModeSideBar";
63 64 65 66

namespace Help {
namespace Internal {

67 68 69 70 71 72 73 74
static void openUrlInWindow(const QUrl &url)
{
    HelpViewer *viewer = HelpPlugin::viewerForHelpViewerLocation(Core::HelpManager::ExternalHelpAlways);
    if (QTC_GUARD(viewer))
        viewer->setSource(url);
    Core::ICore::raiseWindow(viewer);
}

75 76 77 78 79
static bool isBookmarkable(const QUrl &url)
{
    return !url.isEmpty() && url != QUrl(Help::Constants::AboutBlank);
}

80 81
HelpWidget::HelpWidget(const Core::Context &context, WidgetStyle style, QWidget *parent) :
    QWidget(parent),
82
    m_style(style)
83
{
84 85 86 87 88 89 90 91 92 93
    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);

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

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

116
    Core::Command *cmd;
117 118 119 120 121 122 123 124
    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
125 126
    }
    if (style != SideBarWidget) {
Serhii Moroz's avatar
Serhii Moroz committed
127 128
        m_toggleSideBarAction = new QAction(Utils::Icons::TOGGLE_LEFT_SIDEBAR_TOOLBAR.icon(),
                                            QCoreApplication::translate("Core", Core::Constants::TR_SHOW_LEFT_SIDEBAR),
Sergey Belyashov's avatar
Sergey Belyashov committed
129
                                            toolBar);
130 131 132
        m_toggleSideBarAction->setCheckable(true);
        m_toggleSideBarAction->setChecked(false);
        cmd = Core::ActionManager::registerAction(m_toggleSideBarAction,
Serhii Moroz's avatar
Serhii Moroz committed
133
                                                  Core::Constants::TOGGLE_LEFT_SIDEBAR, context);
134 135
        connect(m_toggleSideBarAction, &QAction::toggled, m_toggleSideBarAction,
                [this](bool checked) {
Sergey Belyashov's avatar
Sergey Belyashov committed
136 137
                    m_toggleSideBarAction->setText(
                        QCoreApplication::translate("Core",
Serhii Moroz's avatar
Serhii Moroz committed
138 139
                                                    checked ? Core::Constants::TR_HIDE_LEFT_SIDEBAR
                                                            : Core::Constants::TR_SHOW_LEFT_SIDEBAR));
140 141
                });
        addSideBar();
142
        m_toggleSideBarAction->setChecked(m_sideBar->isVisibleTo(this));
143 144 145 146 147
        connect(m_toggleSideBarAction, &QAction::triggered, m_sideBar, &Core::SideBar::setVisible);
        connect(m_sideBar, &Core::SideBar::sideBarClosed, m_toggleSideBarAction, [this]() {
            m_toggleSideBarAction->setChecked(false);
        });
    }
148 149
    if (style == ExternalWindow)
        layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_toggleSideBarAction, cmd));
150

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

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

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

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

185
    m_addBookmarkAction = new QAction(Utils::Icons::BOOKMARK_TOOLBAR.icon(), tr("Add Bookmark"), this);
Eike Ziller's avatar
Eike Ziller committed
186
    cmd = Core::ActionManager::registerAction(m_addBookmarkAction, Constants::HELP_ADDBOOKMARK, context);
187 188 189
    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));
190
    layout->addWidget(Core::Command::toolButtonWithAppendedShortcut(m_addBookmarkAction, cmd));
191

192 193 194
    if (style == ModeWidget) {
        layout->addWidget(new Utils::StyledSeparator(toolBar));
        layout->addWidget(OpenPagesManager::instance().openPagesComboBox(), 10);
195 196 197 198
    } else {
        layout->addWidget(new QLabel(), 10);
    }
    if (style != SideBarWidget) {
199 200 201
        m_filterComboBox = new QComboBox;
        m_filterComboBox->setMinimumContentsLength(15);
        m_filterComboBox->setModel(LocalHelpManager::filterModel());
202
        m_filterComboBox->setCurrentIndex(LocalHelpManager::filterIndex());
203 204 205 206 207 208 209
        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);
    }

210 211
    layout->addStretch();

212 213 214
    m_printAction = new QAction(this);
    Core::ActionManager::registerAction(m_printAction, Core::Constants::PRINT, context);
    connect(m_printAction, &QAction::triggered, this, [this]() { print(currentViewer()); });
215

216
    m_copy = new QAction(this);
217
    Core::ActionManager::registerAction(m_copy, Core::Constants::COPY, context);
218
    connect(m_copy, &QAction::triggered, this, &HelpWidget::copy);
219 220

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

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

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

242
    if (style != ExternalWindow) {
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
        auto openButton = new QToolButton;
        openButton->setIcon(Utils::Icons::SPLIT_HORIZONTAL_TOOLBAR.icon());
        openButton->setPopupMode(QToolButton::InstantPopup);
        openButton->setProperty("noArrow", true);
        layout->addWidget(openButton);
        QMenu *openMenu = new QMenu(openButton);
        if (m_switchToHelp)
            openMenu->addAction(m_switchToHelp);
        if (style == ModeWidget) {
            QAction *openPage = openMenu->addAction(tr("Open in New Page"));
            connect(openPage, &QAction::triggered, this, [this]() {
                if (HelpViewer *viewer = currentViewer())
                    OpenPagesManager::instance().createPage(viewer->source());
            });
        }
        QAction *openExternal = openMenu->addAction(tr("Open in Window"));
        connect(openExternal, &QAction::triggered, this, [this]() {
            if (HelpViewer *viewer = currentViewer()) {
                openUrlInWindow(viewer->source());
                if (m_style == SideBarWidget)
                    emit closeButtonClicked();
            }
        });
        openButton->setMenu(openMenu);

268 269 270
        const Utils::Icon &icon = style == ModeWidget ? Utils::Icons::CLOSE_TOOLBAR
                                                      : Utils::Icons::CLOSE_SPLIT_RIGHT;
        m_closeAction = new QAction(icon.icon(), QString(), toolBar);
Orgad Shaneh's avatar
Orgad Shaneh committed
271
        connect(m_closeAction, &QAction::triggered, this, &HelpWidget::closeButtonClicked);
272 273 274
        button = new QToolButton;
        button->setDefaultAction(m_closeAction);
        layout->addWidget(button);
275 276 277 278 279 280
    }

    if (style != ModeWidget) {
        HelpViewer *viewer = HelpPlugin::createHelpViewer(qreal(0.0));
        addViewer(viewer);
        setCurrentViewer(viewer);
281 282 283 284 285
    }
}

HelpWidget::~HelpWidget()
{
286
    if (m_sideBar) {
287
        m_sideBar->saveSettings(Core::ICore::settings(), sideBarSettingsKey());
288
        Core::ActionManager::unregisterAction(m_contentsAction, Constants::HELP_CONTENTS);
289
        Core::ActionManager::unregisterAction(m_indexAction, Constants::HELP_INDEX);
Eike Ziller's avatar
Eike Ziller committed
290
        Core::ActionManager::unregisterAction(m_bookmarkAction, Constants::HELP_BOOKMARKS);
291
        Core::ActionManager::unregisterAction(m_searchAction, Constants::HELP_SEARCH);
292 293
        if (m_openPagesAction)
            Core::ActionManager::unregisterAction(m_openPagesAction, Constants::HELP_OPENPAGES);
294
    }
295
    Core::ICore::removeContextObject(m_context);
296
    Core::ActionManager::unregisterAction(m_copy, Core::Constants::COPY);
297
    Core::ActionManager::unregisterAction(m_printAction, Core::Constants::PRINT);
298
    if (m_toggleSideBarAction)
Serhii Moroz's avatar
Serhii Moroz committed
299
        Core::ActionManager::unregisterAction(m_toggleSideBarAction, Core::Constants::TOGGLE_LEFT_SIDEBAR);
300 301
    if (m_switchToHelp)
        Core::ActionManager::unregisterAction(m_switchToHelp, Constants::CONTEXT_HELP);
302
    Core::ActionManager::unregisterAction(m_homeAction, Constants::HELP_HOME);
303 304
    Core::ActionManager::unregisterAction(m_forwardAction, Constants::HELP_NEXT);
    Core::ActionManager::unregisterAction(m_backAction, Constants::HELP_PREVIOUS);
Eike Ziller's avatar
Eike Ziller committed
305
    Core::ActionManager::unregisterAction(m_addBookmarkAction, Constants::HELP_ADDBOOKMARK);
306 307 308 309 310 311
    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);
312 313
}

314 315 316 317
void HelpWidget::addSideBar()
{
    QMap<QString, Core::Command *> shortcutMap;
    Core::Command *cmd;
318
    bool supportsNewPages = (m_style == ModeWidget);
319

320
    auto contentWindow = new ContentWindow;
321
    auto contentItem = new Core::SideBarItem(contentWindow, Constants::HELP_CONTENTS);
322
    contentWindow->setOpenInNewPageActionVisible(supportsNewPages);
323
    contentWindow->setWindowTitle(HelpPlugin::tr(Constants::SB_CONTENTS));
324 325
    connect(contentWindow, &ContentWindow::linkActivated,
            this, &HelpWidget::open);
Takumi ASAKI's avatar
Takumi ASAKI committed
326
    m_contentsAction = new QAction(HelpPlugin::tr(Constants::SB_CONTENTS), this);
327 328 329
    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")));
330
    shortcutMap.insert(Constants::HELP_CONTENTS, cmd);
331

332
    auto indexWindow = new IndexWindow();
333
    auto indexItem = new Core::SideBarItem(indexWindow, Constants::HELP_INDEX);
334
    indexWindow->setOpenInNewPageActionVisible(supportsNewPages);
335
    indexWindow->setWindowTitle(HelpPlugin::tr(Constants::SB_INDEX));
336 337 338 339
    connect(indexWindow, &IndexWindow::linkActivated,
            this, &HelpWidget::open);
    connect(indexWindow, &IndexWindow::linksActivated,
        this, &HelpWidget::showTopicChooser);
Takumi ASAKI's avatar
Takumi ASAKI committed
340
    m_indexAction = new QAction(HelpPlugin::tr(Constants::SB_INDEX), this);
341 342 343
    cmd = Core::ActionManager::registerAction(m_indexAction, Constants::HELP_INDEX, m_context->context());
    cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Meta+I")
                                                                  : tr("Ctrl+Shift+I")));
344
    shortcutMap.insert(Constants::HELP_INDEX, cmd);
345

Eike Ziller's avatar
Eike Ziller committed
346
    auto bookmarkWidget = new BookmarkWidget(&LocalHelpManager::bookmarkManager());
347
    bookmarkWidget->setWindowTitle(HelpPlugin::tr(Constants::SB_BOOKMARKS));
348
    bookmarkWidget->setOpenInNewPageActionVisible(supportsNewPages);
349
    auto bookmarkItem = new Core::SideBarItem(bookmarkWidget, Constants::HELP_BOOKMARKS);
Eike Ziller's avatar
Eike Ziller committed
350 351 352 353
    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());
354
    cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Alt+Meta+M")
Eike Ziller's avatar
Eike Ziller committed
355
                                                                  : tr("Ctrl+Shift+B")));
356
    shortcutMap.insert(Constants::HELP_BOOKMARKS, cmd);
Eike Ziller's avatar
Eike Ziller committed
357

358 359 360 361 362 363 364
    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+/")));
365
    shortcutMap.insert(Constants::HELP_SEARCH, cmd);
366

367 368 369
    Core::SideBarItem *openPagesItem = 0;
    if (m_style == ModeWidget) {
        QWidget *openPagesWidget = OpenPagesManager::instance().openPagesWidget();
370
        openPagesWidget->setWindowTitle(HelpPlugin::tr(Constants::SB_OPENPAGES));
371
        openPagesItem = new Core::SideBarItem(openPagesWidget, Constants::HELP_OPENPAGES);
372 373 374 375 376
        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")));
377
        shortcutMap.insert(Constants::HELP_OPENPAGES, cmd);
378 379
    }

380
    QList<Core::SideBarItem *> itemList;
381
    itemList << contentItem << indexItem << bookmarkItem << searchItem;
382 383
    if (openPagesItem)
         itemList << openPagesItem;
384
    m_sideBar = new Core::SideBar(itemList,
385 386
                                  QList<Core::SideBarItem *>() << contentItem
                                  << (openPagesItem ? openPagesItem : indexItem));
387 388 389 390 391
    m_sideBar->setShortcutMap(shortcutMap);
    m_sideBar->setCloseWhenEmpty(true);
    m_sideBarSplitter->insertWidget(0, m_sideBar);
    m_sideBarSplitter->setStretchFactor(0, 0);
    m_sideBarSplitter->setStretchFactor(1, 1);
392 393
    if (m_style != ModeWidget)
        m_sideBar->setVisible(false);
394
    m_sideBar->resize(250, size().height());
395
    m_sideBar->readSettings(Core::ICore::settings(), sideBarSettingsKey());
396 397
    m_sideBarSplitter->setSizes(QList<int>() << m_sideBar->size().width() << 300);

398
    connect(m_contentsAction, &QAction::triggered, m_sideBar, [this]() {
399
        m_sideBar->activateItem(Constants::HELP_CONTENTS);
400
    });
Eike Ziller's avatar
Eike Ziller committed
401
    connect(m_indexAction, &QAction::triggered, m_sideBar, [this]() {
402
        m_sideBar->activateItem(Constants::HELP_INDEX);
403
    });
Eike Ziller's avatar
Eike Ziller committed
404
    connect(m_bookmarkAction, &QAction::triggered, m_sideBar, [this]() {
405
        m_sideBar->activateItem(Constants::HELP_BOOKMARKS);
Eike Ziller's avatar
Eike Ziller committed
406
    });
407
    connect(m_searchAction, &QAction::triggered, m_sideBar, [this]() {
408
        m_sideBar->activateItem(Constants::HELP_SEARCH);
409
    });
410 411
    if (m_openPagesAction) {
        connect(m_openPagesAction, &QAction::triggered, m_sideBar, [this]() {
412
            m_sideBar->activateItem(Constants::HELP_OPENPAGES);
413 414 415 416 417 418 419 420
        });
    }
}

QString HelpWidget::sideBarSettingsKey() const
{
    switch (m_style) {
    case ModeWidget:
421
        return QString(kModeSideBarSettingsKey);
422
    case ExternalWindow:
423
        return QString(kWindowSideBarSettingsKey);
424 425 426 427 428
    case SideBarWidget:
        QTC_CHECK(false);
        break;
    }
    return QString();
429 430
}

431 432
HelpViewer *HelpWidget::currentViewer() const
{
433 434 435 436 437 438 439 440
    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());
441
    m_addBookmarkAction->setEnabled(isBookmarkable(viewer->source()));
442 443 444 445 446 447 448 449 450 451
    if (m_style == ExternalWindow)
        updateWindowTitle();
    emit sourceChanged(viewer->source());
}

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

452
void HelpWidget::addViewer(HelpViewer *viewer)
453 454 455
{
    m_viewerStack->addWidget(viewer);
    viewer->setFocus(Qt::OtherFocusReason);
456 457
    viewer->setActionVisible(HelpViewer::Action::NewPage, m_style == ModeWidget);
    viewer->setActionVisible(HelpViewer::Action::ExternalWindow, m_style != ExternalWindow);
458
    connect(viewer, &HelpViewer::sourceChanged, this, [viewer, this](const QUrl &url) {
459 460
        if (currentViewer() == viewer) {
            m_addBookmarkAction->setEnabled(isBookmarkable(url));
461
            emit sourceChanged(url);
462
        }
463 464 465 466 467 468 469 470 471 472 473 474 475
    });
    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
476
        connect(viewer, &HelpViewer::titleChanged, this, &HelpWidget::updateWindowTitle);
477

478
    connect(viewer, &HelpViewer::loadFinished, this, &HelpWidget::highlightSearchTerms);
479 480 481
    connect(viewer, &HelpViewer::newPageRequested, [](const QUrl &url) {
        OpenPagesManager::instance().createPage(url);
    });
482
    connect(viewer, &HelpViewer::externalPageRequested, this, &openUrlInWindow);
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508

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

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
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);
}

525 526 527 528 529 530
void HelpWidget::activateSideBarItem(const QString &id)
{
    QTC_ASSERT(m_sideBar, return);
    m_sideBar->activateItem(id);
}

531 532 533 534 535 536 537 538
void HelpWidget::setSource(const QUrl &url)
{
    HelpViewer* viewer = currentViewer();
    QTC_ASSERT(viewer, return);
    viewer->setSource(url);
    viewer->setFocus(Qt::OtherFocusReason);
}

539
void HelpWidget::openFromSearch(const QUrl &url, const QStringList &searchTerms, bool newPage)
540
{
541
    m_searchTerms = searchTerms;
542
    if (newPage)
543
        OpenPagesManager::instance().createPage(url);
544 545 546 547 548 549
    else {
        HelpViewer* viewer = currentViewer();
        QTC_ASSERT(viewer, return);
        viewer->setSource(url);
        viewer->setFocus(Qt::OtherFocusReason);
    }
550 551
}

552 553 554 555 556
void HelpWidget::closeEvent(QCloseEvent *)
{
    emit aboutToClose();
}

557 558 559
void HelpWidget::updateBackMenu()
{
    m_backMenu->clear();
560 561
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->addBackHistoryItems(m_backMenu);
562 563 564 565 566
}

void HelpWidget::updateForwardMenu()
{
    m_forwardMenu->clear();
567 568
    QTC_ASSERT(currentViewer(), return);
    currentViewer()->addForwardHistoryItems(m_forwardMenu);
569 570
}

571 572
void HelpWidget::updateWindowTitle()
{
573 574
    QTC_ASSERT(currentViewer(), return);
    const QString pageTitle = currentViewer()->title();
575 576 577 578 579 580
    if (pageTitle.isEmpty())
        setWindowTitle(tr("Help"));
    else
        setWindowTitle(tr("Help - %1").arg(pageTitle));
}

581
void HelpWidget::helpModeButtonClicked()
582
{
583 584
    QTC_ASSERT(currentViewer(), return);
    emit openHelpMode(currentViewer()->source());
585 586
    if (m_style == ExternalWindow)
        close();
587 588
}

589 590 591
void HelpWidget::updateCloseButton()
{
    if (m_style == ModeWidget) {
592
        const bool closeOnReturn = LocalHelpManager::returnOnClose();
593 594 595 596
        m_closeAction->setEnabled(closeOnReturn || m_viewerStack->count() > 1);
    }
}

597 598 599 600 601 602 603 604 605 606 607 608
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();
609
    if (!isBookmarkable(url))
610 611 612 613 614 615
        return;

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

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 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
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()
{
670 671 672 673 674 675 676
    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();
677 678
}

679 680
} // Internal
} // Help