Skip to content
Snippets Groups Projects
Normal view Permalink
helpplugin.cpp 27.7 KiB
Newer Older
hjk's avatar
Fixes: change file license headers to include LGPL  
hjk committed
1 
/**************************************************************************
con's avatar
Initial import
con committed
2 3 4 
**
** This file is part of Qt Creator
**
hjk's avatar
Fixes: change file license headers to include LGPL  
hjk committed
5 
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
Initial import
con committed
6 7 8 
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
hjk's avatar
Fixes: change file license headers to include LGPL  
hjk committed
9 
** Commercial Usage
hjk's avatar
end-of-line whitespace correction of the new headers  
hjk committed
10 
**
hjk's avatar
Fixes: change file license headers to include LGPL  
hjk committed
11 12 13 14 
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
hjk's avatar
end-of-line whitespace correction of the new headers  
hjk committed
15 
**
hjk's avatar
Fixes: change file license headers to include LGPL  
hjk committed
16 
** GNU Lesser General Public License Usage
hjk's avatar
end-of-line whitespace correction of the new headers  
hjk committed
17 
**
hjk's avatar
Fixes: change file license headers to include LGPL  
hjk committed
18 19 20 21 22 23 
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
end-of-line whitespace correction of the new headers  
hjk committed
24 
**
hjk's avatar
Fixes: change file license headers to include LGPL  
hjk committed
25 26 
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
con's avatar
Initial import
con committed
27 
**
hjk's avatar
Fixes: change file license headers to include LGPL  
hjk committed
28 
**************************************************************************/
con's avatar
Initial import
con committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 

#include "helpplugin.h"
#include "docsettingspage.h"
#include "filtersettingspage.h"
#include "helpindexfilter.h"
#include "helpmode.h"
#include "helpviewer.h"
#include "contentwindow.h"
#include "indexwindow.h"
#include "bookmarkmanager.h"
#include "centralwidget.h"
#include "helpfindsupport.h"
#include "searchwidget.h"
hjk's avatar
more code cosmetics  
hjk committed
43 44 45 46 47 
#include <extensionsystem/pluginmanager.h>
#include <coreplugin/icore.h>
#include <coreplugin/coreconstants.h>
#include <coreplugin/modemanager.h>
#include <coreplugin/uniqueidmanager.h>
con's avatar
Fixes: - Rename ActionManagerInterface --> ActionManager  
con committed
48 
#include <coreplugin/actionmanager/actionmanager.h>
hjk's avatar
more code cosmetics  
hjk committed
49 50 51 52 53 54 
#include <coreplugin/minisplitter.h>
#include <coreplugin/modemanager.h>
#include <coreplugin/rightpane.h>
#include <coreplugin/sidebar.h>
#include <coreplugin/welcomemode.h>
con's avatar
Initial import
con committed
55 56 57 58 59 60 
#include <QtCore/QDebug>
#include <QtCore/qplugin.h>
#include <QtCore/QFileInfo>
#include <QtCore/QSettings>
#include <QtCore/QDir>
#include <QtCore/QResource>
Oswald Buddenhagen's avatar
load translations  
Oswald Buddenhagen committed
61 62 
#include <QtCore/QLibraryInfo>
#include <QtCore/QTranslator>
con's avatar
Initial import
con committed
63 64 65 66 67 68 
#include <QtGui/QAction>
#include <QtGui/QShortcut>
#include <QtGui/QSplitter>
#include <QtGui/QStyle>
#include <QtGui/QToolBar>
#include <QtGui/QComboBox>
Daniel Molkentin's avatar
welcome screen: tutorial section works, remember last tab  
Daniel Molkentin committed
69 
#include <QtGui/QDesktopServices>
con's avatar
Initial import
con committed
70 71 
#include <QtHelp/QHelpEngine>
Oswald Buddenhagen's avatar
fully-fledged webkit-free welcome mode  
Oswald Buddenhagen committed
72 73 74 75 76 
#ifndef QT_NO_WEBKIT
#include <QtGui/QApplication>
#include <QtWebKit/QWebSettings>
#endif
con's avatar
Initial import
con committed
77 78 79 80 81 82 83 84 85 86 87 88 89 
using namespace Help;
using namespace Help::Internal;

HelpManager::HelpManager(QHelpEngine *helpEngine)
    : m_helpEngine(helpEngine)
{
}

void HelpManager::registerDocumentation(const QStringList &fileNames)
{
    bool needsSetup = false;
    {
        QHelpEngineCore hc(m_helpEngine->collectionFile());
con's avatar
Fixes: - Move help collection also to qtcreator subdir.  
con committed
90 91 
        if (!hc.setupData())
            qWarning() << "Could not initialize help engine:" << hc.error();
con's avatar
Initial import
con committed
92 93 94 95 96 97 98 99 100 101 102 103 104 
        foreach (const QString &fileName, fileNames) {
            if (!QFile::exists(fileName))
                continue;
            QString fileNamespace = QHelpEngineCore::namespaceName(fileName);
            if (!fileNamespace.isEmpty() && !hc.registeredDocumentations().contains(fileNamespace)) {
                if (hc.registerDocumentation(fileName))
                    needsSetup = true;
                else
                    qDebug() << "error registering" << fileName << hc.error();
            }
        }
    }
    if (needsSetup)
con's avatar
Fixes: - Avoid some annoying debug output.  
con committed
105 
        m_helpEngine->setupData();
con's avatar
Initial import
con committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 
}

HelpPlugin::HelpPlugin() :
    m_core(0),
    m_helpEngine(0),
    m_contextHelpEngine(0),
    m_contentWidget(0),
    m_indexWidget(0),
    m_centralWidget(0),
    m_helpViewerForSideBar(0),
    m_mode(0),
    m_shownLastPages(false),
    m_contentItem(0),
    m_indexItem(0),
    m_searchItem(0),
    m_bookmarkItem(0),
    m_rightPaneSideBar(0)
{
}

HelpPlugin::~HelpPlugin()
{
}
hjk's avatar
replace ExtensionSystem::PluginManager::instance()->getObject<Core::ICore>()...  
hjk committed
130 
bool HelpPlugin::initialize(const QStringList &arguments, QString *error)
con's avatar
Initial import
con committed
131 
{
hjk's avatar
replace ExtensionSystem::PluginManager::instance()->getObject<Core::ICore>()...  
hjk committed
132 133 134 
    Q_UNUSED(arguments);
    Q_UNUSED(error);
    m_core = Core::ICore::instance();
con's avatar
Initial import
con committed
135 136 137 138 139 
    QList<int> globalcontext;
    globalcontext << Core::Constants::C_GLOBAL_ID;
    QList<int> modecontext;
    modecontext << m_core->uniqueIDManager()->uniqueIdentifier(Constants::C_MODE_HELP);
Oswald Buddenhagen's avatar
load translations  
Oswald Buddenhagen committed
140 141 142 143 144 145 146 147 
    QString locale = qApp->property("qtc_locale").toString();
    if (!locale.isEmpty()) {
        QTranslator *qtr = new QTranslator(this);
        qtr->load(QLatin1String("assistant_") + locale,
                  QLibraryInfo::location(QLibraryInfo::TranslationsPath));
        qApp->installTranslator(qtr);
    }
Oswald Buddenhagen's avatar
fully-fledged webkit-free welcome mode  
Oswald Buddenhagen committed
148 149 150 151 152 153 154 
#ifndef QT_NO_WEBKIT
    QWebSettings *webSettings = QWebSettings::globalSettings();
    const QFont applicationFont = QApplication::font();
    webSettings->setFontFamily(QWebSettings::StandardFont, applicationFont.family());
    //webSettings->setFontSize(QWebSettings::DefaultFontSize, applicationFont.pointSize());
#endif
con's avatar
Initial import
con committed
155 156 
    // FIXME shouldn't the help engine create the directory if it doesn't exist?
    QFileInfo fi(m_core->settings()->fileName());
con's avatar
Fixes: - Move help collection also to qtcreator subdir.  
con committed
157 
    QDir directory(fi.absolutePath()+"/qtcreator");
con's avatar
Initial import
con committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 
    if (!directory.exists())
        directory.mkpath(directory.absolutePath());
    m_helpEngine = new QHelpEngine(directory.absolutePath()
                                   + QLatin1String("/helpcollection.qhc"), this);
    connect(m_helpEngine, SIGNAL(setupFinished()),
        this, SLOT(updateFilterComboBox()));

    addAutoReleasedObject(new HelpManager(m_helpEngine));

    m_docSettingsPage = new DocSettingsPage(m_helpEngine);
    addAutoReleasedObject(m_docSettingsPage);

    m_filterSettingsPage = new FilterSettingsPage(m_helpEngine);
    addAutoReleasedObject(m_filterSettingsPage);
    connect(m_docSettingsPage, SIGNAL(documentationAdded()),
        m_filterSettingsPage, SLOT(updateFilterPage()));
    connect(m_docSettingsPage, SIGNAL(dialogAccepted()),
        this, SLOT(checkForHelpChanges()));

    m_contentWidget = new ContentWindow(m_helpEngine);
    m_contentWidget->setWindowTitle(tr("Contents"));
    m_indexWidget = new IndexWindow(m_helpEngine);
    m_indexWidget->setWindowTitle(tr("Index"));
    m_searchWidget = new SearchWidget(m_helpEngine->searchEngine());
    m_searchWidget->setWindowTitle(tr("Search"));
    m_bookmarkManager = new BookmarkManager(m_helpEngine);
    m_bookmarkWidget = new BookmarkWidget(m_bookmarkManager, 0, false);
    m_bookmarkWidget->setWindowTitle(tr("Bookmarks"));
    connect(m_bookmarkWidget, SIGNAL(addBookmark()),
        this, SLOT(addBookmark()));
con's avatar
Fixes: - Rename ActionManagerInterface --> ActionManager  
con committed
189 
    Core::ActionManager *am = m_core->actionManager();
con's avatar
Fixes: - ICommand --> Command  
con committed
190 
    Core::Command *cmd;
con's avatar
Initial import
con committed
191 192 193 194 195 196 197 198 

    // Add Home, Previous and Next actions (used in the toolbar)
    QAction *homeAction = new QAction(QIcon(QLatin1String(":/help/images/home.png")), tr("Home"), this);
    cmd = am->registerAction(homeAction, QLatin1String("Help.Home"), globalcontext);

    QAction *previousAction = new QAction(QIcon(QLatin1String(":/help/images/previous.png")),
        tr("Previous"), this);
    cmd = am->registerAction(previousAction, QLatin1String("Help.Previous"), modecontext);
kh's avatar
Use default key sequence for next and previous page.  
kh committed
199 
    cmd->setDefaultKeySequence(QKeySequence::Back);
con's avatar
Initial import
con committed
200 201 202 

    QAction *nextAction = new QAction(QIcon(QLatin1String(":/help/images/next.png")), tr("Next"), this);
    cmd = am->registerAction(nextAction, QLatin1String("Help.Next"), modecontext);
kh's avatar
Use default key sequence for next and previous page.  
kh committed
203 
    cmd->setDefaultKeySequence(QKeySequence::Forward);
con's avatar
Initial import
con committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 

    QAction *addBookmarkAction = new QAction(QIcon(QLatin1String(":/help/images/bookmark.png")),
        tr("Add Bookmark"), this);
    cmd = am->registerAction(addBookmarkAction, QLatin1String("Help.AddBookmark"), modecontext);
    cmd->setDefaultKeySequence(QKeySequence(Qt::CTRL + Qt::Key_M));

    // Add Index, Contents, and Context menu items and a separator to the Help menu
    QAction *indexAction = new QAction(tr("Index"), this);
    cmd = am->registerAction(indexAction, QLatin1String("Help.Index"), globalcontext);
    am->actionContainer(Core::Constants::M_HELP)->addAction(cmd, Core::Constants::G_HELP_HELP);

    QAction *contentsAction = new QAction(tr("Contents"), this);
    cmd = am->registerAction(contentsAction, QLatin1String("Help.Contents"), globalcontext);
    am->actionContainer(Core::Constants::M_HELP)->addAction(cmd, Core::Constants::G_HELP_HELP);

    QAction *searchAction = new QAction(tr("Search"), this);
    cmd = am->registerAction(searchAction, QLatin1String("Help.Search"), globalcontext);
    am->actionContainer(Core::Constants::M_HELP)->addAction(cmd, Core::Constants::G_HELP_HELP);

    QAction *contextAction = new QAction(tr("Context Help"), this);
    cmd = am->registerAction(contextAction, QLatin1String("Help.Context"), globalcontext);
    cmd->setDefaultKeySequence(QKeySequence(Qt::Key_F1));
    am->actionContainer(Core::Constants::M_HELP)->addAction(cmd, Core::Constants::G_HELP_HELP);

#ifndef Q_OS_MAC
    QAction *sep = new QAction(this);
    sep->setSeparator(true);
    cmd = am->registerAction(sep, QLatin1String("Help.Separator"), globalcontext);
    am->actionContainer(Core::Constants::M_HELP)->addAction(cmd, Core::Constants::G_HELP_HELP);
#endif
Friedemann Kleint's avatar
Fixed translation issues.  
Friedemann Kleint committed
235 
    m_centralWidget = new Help::Internal::CentralWidget(m_helpEngine);
con's avatar
Initial import
con committed
236 237 238 239 240 241 242 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 268 269 270 271 272 273 274 275 
    Aggregation::Aggregate *agg = new Aggregation::Aggregate;
    agg->add(m_centralWidget);
    agg->add(new HelpFindSupport(m_centralWidget));
    QWidget *mainWidget = new QWidget;
    QVBoxLayout *mainWidgetLayout = new QVBoxLayout(mainWidget);
    mainWidgetLayout->setMargin(0);
    mainWidgetLayout->setSpacing(0);
    mainWidgetLayout->addWidget(createToolBar());
    mainWidgetLayout->addWidget(m_centralWidget);

    m_contentItem = new Core::SideBarItem(m_contentWidget);
    m_indexItem = new Core::SideBarItem(m_indexWidget);
    m_searchItem = new Core::SideBarItem(m_searchWidget);
    m_bookmarkItem = new Core::SideBarItem(m_bookmarkWidget);
    QList<Core::SideBarItem*> itemList;
    itemList << m_contentItem << m_indexItem << m_searchItem << m_bookmarkItem;
    m_sideBar = new Core::SideBar(itemList, QList<Core::SideBarItem*>() << m_indexItem);

    QSplitter *splitter = new Core::MiniSplitter;
    splitter->setOpaqueResize(false);
    splitter->addWidget(m_sideBar);
    splitter->addWidget(mainWidget);
    splitter->setStretchFactor(0, 0);
    splitter->setStretchFactor(1, 1);
    splitter->setSizes(QList<int>() << 300 << 300);

    m_mode = new HelpMode(splitter, m_centralWidget);
    m_mode->setContext(QList<int>() << modecontext);
    addAutoReleasedObject(m_mode);

    QAction *printAction = new QAction(this);
    am->registerAction(printAction, Core::Constants::PRINT, modecontext);
    connect(printAction, SIGNAL(triggered()), m_centralWidget, SLOT(print()));

    QAction *copyAction = new QAction(this);
    cmd = am->registerAction(copyAction, Core::Constants::COPY, modecontext);
    connect(copyAction, SIGNAL(triggered()), m_centralWidget, SLOT(copy()));
    copyAction->setText(cmd->action()->text());
    copyAction->setIcon(cmd->action()->icon());
con's avatar
Fixes: - ICommand --> Command  
con committed
276 
    QMap<QString, Core::Command*> shortcutMap;
con's avatar
Initial import
con committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 
    QShortcut *shortcut = new QShortcut(splitter);
    shortcut->setWhatsThis(tr("Activate Index in Help mode"));
    cmd = am->registerShortcut(shortcut, QLatin1String("Help.IndexShortcut"), modecontext);
    cmd->setDefaultKeySequence(QKeySequence(Qt::CTRL + Qt::Key_I));
    connect(shortcut, SIGNAL(activated()), this, SLOT(activateIndex()));
    shortcutMap.insert(m_indexWidget->windowTitle(), cmd);

    shortcut = new QShortcut(splitter);
    shortcut->setWhatsThis(tr("Activate Contents in Help mode"));
    cmd = am->registerShortcut(shortcut, QLatin1String("Help.ContentsShortcut"), modecontext);
    cmd->setDefaultKeySequence(QKeySequence(Qt::CTRL + Qt::Key_T));
    connect(shortcut, SIGNAL(activated()), this, SLOT(activateContents()));
    shortcutMap.insert(m_contentWidget->windowTitle(), cmd);

    shortcut = new QShortcut(splitter);
    shortcut->setWhatsThis(tr("Activate Search in Help mode"));
    cmd = am->registerShortcut(shortcut, QLatin1String("Help.SearchShortcut"), modecontext);
    cmd->setDefaultKeySequence(QKeySequence(Qt::CTRL + Qt::Key_S));
    connect(shortcut, SIGNAL(activated()), this, SLOT(activateSearch()));
    shortcutMap.insert(m_searchWidget->windowTitle(), cmd);
    shortcutMap.insert(m_bookmarkWidget->windowTitle(), 0);

    m_sideBar->setShortcutMap(shortcutMap);

    connect(homeAction, SIGNAL(triggered()), m_centralWidget, SLOT(home()));
    connect(previousAction, SIGNAL(triggered()), m_centralWidget, SLOT(backward()));
    connect(nextAction, SIGNAL(triggered()), m_centralWidget, SLOT(forward()));
    connect(addBookmarkAction, SIGNAL(triggered()), this, SLOT(addBookmark()));
    connect(m_contentWidget, SIGNAL(linkActivated(const QUrl&)),
            m_centralWidget, SLOT(setSource(const QUrl&)));
    connect(m_indexWidget, SIGNAL(linkActivated(const QUrl&)),
            m_centralWidget, SLOT(setSource(const QUrl&)));
    connect(m_searchWidget, SIGNAL(requestShowLink(const QUrl&)),
        m_centralWidget, SLOT(setSource(const QUrl&)));
    connect(m_searchWidget, SIGNAL(requestShowLinkInNewTab(const QUrl&)),
        m_centralWidget, SLOT(setSourceInNewTab(const QUrl&)));
    connect(m_bookmarkWidget, SIGNAL(requestShowLink(const QUrl&)),
        m_centralWidget, SLOT(setSource(const QUrl&)));

    connect(m_centralWidget, SIGNAL(backwardAvailable(bool)),
        previousAction, SLOT(setEnabled(bool)));
    connect(m_centralWidget, SIGNAL(forwardAvailable(bool)),
        nextAction, SLOT(setEnabled(bool)));
    connect(m_centralWidget, SIGNAL(addNewBookmark(const QString&, const QString&)),
        this, SLOT(addNewBookmark(const QString&, const QString&)));

    QList<QAction*> actionList;
    actionList << previousAction
        << nextAction
        << homeAction
#ifndef Q_OS_MAC
        << sep
#endif
        << copyAction;
    m_centralWidget->setGlobalActions(actionList);

    connect(contextAction, SIGNAL(triggered()), this, SLOT(activateContext()));
    connect(indexAction, SIGNAL(triggered()), this, SLOT(activateIndex()));
    connect(contentsAction, SIGNAL(triggered()), this, SLOT(activateContents()));
    connect(searchAction, SIGNAL(triggered()), this, SLOT(activateSearch()));

    connect(m_core->modeManager(), SIGNAL(currentModeChanged(Core::IMode*)),
        this, SLOT(modeChanged(Core::IMode*)));

    connect(m_contentWidget, SIGNAL(linkActivated(const QUrl&)),
        m_centralWidget, SLOT(setSource(const QUrl&)));
    connect(m_indexWidget, SIGNAL(linkActivated(const QUrl&)),
        m_centralWidget, SLOT(setSource(const QUrl&)));
    connect(m_indexWidget, SIGNAL(linksActivated(const QMap<QString, QUrl>&, const QString&)),
        m_centralWidget, SLOT(showTopicChooser(const QMap<QString, QUrl>&, const QString&)));

    HelpIndexFilter *helpIndexFilter = new HelpIndexFilter(this, m_helpEngine);
    addAutoReleasedObject(helpIndexFilter);
    connect(helpIndexFilter, SIGNAL(linkActivated(QUrl)),
            this, SLOT(switchToHelpMode(QUrl)));
    connect(helpIndexFilter, SIGNAL(linksActivated(const QMap<QString, QUrl>&, const QString&)),
            this, SLOT(switchToHelpMode(const QMap<QString, QUrl>&, const QString&)));

    previousAction->setEnabled(m_centralWidget->isBackwardAvailable());
    nextAction->setEnabled(m_centralWidget->isForwardAvailable());

    createRightPaneSideBar();
Daniel Molkentin's avatar
Register as handler for qthelp://, remove obsolete started action slot.  
Daniel Molkentin committed
360 361 
    QDesktopServices::setUrlHandler("qthelp", this, "openHelpPage");
con's avatar
Initial import
con committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 
    return true;
}

void HelpPlugin::createRightPaneSideBar()
{
    QAction *switchToHelpMode = new QAction("Go to Help Mode", this);
    m_rightPaneBackwardAction = new QAction(QIcon(QLatin1String(":/help/images/previous.png")), tr("Previous"), this);
    m_rightPaneForwardAction = new QAction(QIcon(QLatin1String(":/help/images/next.png")), tr("Next"), this);

    QToolBar *rightPaneToolBar = new QToolBar();
    rightPaneToolBar->addAction(switchToHelpMode);
    rightPaneToolBar->addAction(m_rightPaneBackwardAction);
    rightPaneToolBar->addAction(m_rightPaneForwardAction);

    connect(switchToHelpMode, SIGNAL(triggered()), this, SLOT(switchToHelpMode()));
    connect(m_rightPaneBackwardAction, SIGNAL(triggered()), this, SLOT(rightPaneBackward()));
    connect(m_rightPaneForwardAction, SIGNAL(triggered()), this, SLOT(rightPaneForward()));

    QToolButton *closeButton = new QToolButton();
    closeButton->setProperty("type", QLatin1String("dockbutton"));
Thorbjørn Lindeijer's avatar
Changed coreplugin resource prefix to "/core"  
Thorbjørn Lindeijer committed
382 
    closeButton->setIcon(QIcon(":/core/images/closebutton.png"));
con's avatar
Initial import
con committed
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 

    // Dummy layout to align the close button to the right
    QHBoxLayout *hboxLayout = new QHBoxLayout();
    hboxLayout->setSpacing(0);
    hboxLayout->setMargin(0);
    hboxLayout->addStretch(5);
    hboxLayout->addWidget(closeButton);

    QWidget *w = new QWidget(rightPaneToolBar);
    w->setLayout(hboxLayout);
    rightPaneToolBar->addWidget(w);
    connect(closeButton, SIGNAL(clicked()), this, SLOT(slotHideRightPane()));

    QVBoxLayout *rightPaneLayout = new QVBoxLayout;
    rightPaneLayout->setMargin(0);
    rightPaneLayout->setSpacing(0);
    rightPaneLayout->addWidget(rightPaneToolBar);

    m_helpViewerForSideBar = new HelpViewer(m_helpEngine, 0);
con's avatar
Add find support to the help side panel.  
con committed
402 403 404 
    Aggregation::Aggregate *agg = new Aggregation::Aggregate();
    agg->add(m_helpViewerForSideBar);
    agg->add(new HelpViewerFindSupport(m_helpViewerForSideBar));
con's avatar
Initial import
con committed
405 
    rightPaneLayout->addWidget(m_helpViewerForSideBar);
con's avatar
Fixes: Copy from help sidebar doesn't work  
con committed
406 407 408 409 410 411 412 413 414 415 416 
    m_core->addContextObject(new Core::BaseContext(m_helpViewerForSideBar, QList<int>()
        << m_core->uniqueIDManager()->uniqueIdentifier(Constants::C_HELP_SIDEBAR),
        this));

    QAction *copyActionSideBar = new QAction(this);
    Core::Command *cmd = m_core->actionManager()->registerAction(copyActionSideBar,
        Core::Constants::COPY, QList<int>()
        << m_core->uniqueIDManager()->uniqueIdentifier(Constants::C_HELP_SIDEBAR));
    connect(copyActionSideBar, SIGNAL(triggered()), this, SLOT(copyFromSideBar()));
    copyActionSideBar->setText(cmd->action()->text());
    copyActionSideBar->setIcon(cmd->action()->icon());
con's avatar
Initial import
con committed
417 418 419 420 421 422 423 

    m_rightPaneSideBar = new QWidget;
    m_rightPaneSideBar->setLayout(rightPaneLayout);
    m_rightPaneSideBar->setFocusProxy(m_helpViewerForSideBar);
    addAutoReleasedObject(new Core::BaseRightPaneWidget(m_rightPaneSideBar));
}
con's avatar
Fixes: Copy from help sidebar doesn't work  
con committed
424 425 426 427 428 
void HelpPlugin::copyFromSideBar()
{
    m_helpViewerForSideBar->copy();
}
con's avatar
Initial import
con committed
429 430 431 432 433 434 435 436 437 438 
void HelpPlugin::rightPaneBackward()
{
    m_helpViewerForSideBar->backward();
}

void HelpPlugin::rightPaneForward()
{
    m_helpViewerForSideBar->forward();
}
hjk's avatar
Fixes: help: small refactoring  
hjk committed
439 440 441 442 443 
void HelpPlugin::activateHelpMode()
{
    m_core->modeManager()->activateMode(QLatin1String(Constants::ID_MODE_HELP));
}
con's avatar
Initial import
con committed
444 445 446 447 448 449 450 451 
void HelpPlugin::switchToHelpMode()
{
    switchToHelpMode(m_helpViewerForSideBar->source());
    Core::RightPaneWidget::instance()->setShown(false);
}

void HelpPlugin::switchToHelpMode(const QUrl &source)
{
hjk's avatar
Fixes: help: small refactoring  
hjk committed
452 
    activateHelpMode();
con's avatar
Initial import
con committed
453 454 455 456 457 458 
    m_centralWidget->setSource(source);
    m_centralWidget->setFocus();
}

void HelpPlugin::switchToHelpMode(const QMap<QString, QUrl> &urls, const QString &keyword)
{
hjk's avatar
Fixes: help: small refactoring  
hjk committed
459 
    activateHelpMode();
con's avatar
Initial import
con committed
460 461 462 463 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 490 491 492 493 494 
    m_centralWidget->showTopicChooser(urls, keyword);
}

void HelpPlugin::slotHideRightPane()
{
    Core::RightPaneWidget::instance()->setShown(false);
}

void HelpPlugin::extensionsInitialized()
{
    m_sideBar->readSettings(m_core->settings());
    if (!m_helpEngine->setupData()) {
        qWarning() << "Could not initialize help engine: " << m_helpEngine->error();
        return;
    }

    bool needsSetup = false;
    bool assistantInternalDocRegistered = false;

    foreach (QString ns, m_helpEngine->registeredDocumentations()) {
        if (ns == QString("com.nokia.qtcreator.%1%2")
            .arg(IDE_VERSION_MAJOR).arg(IDE_VERSION_MINOR)) {
            assistantInternalDocRegistered = true;
            break;
        }
    }

    if (!assistantInternalDocRegistered) {
        QFileInfo fi(m_helpEngine->collectionFile());

        const QString qchFileName =
            QDir::cleanPath(QCoreApplication::applicationDirPath()
#if defined(Q_OS_MAC)
            + QLatin1String("/../Resources/doc/qtcreator.qch"));
#else
Daniel Molkentin's avatar
Fixes: Find docs on Windows  
Daniel Molkentin committed
495 
            + QLatin1String("../../share/doc/qtcreator/qtcreator.qch"));
con's avatar
Initial import
con committed
496 497 498 
#endif
        QHelpEngineCore hc(fi.absoluteFilePath());
        hc.setupData();
con's avatar
Fixes: - Avoid some annoying debug output.  
con committed
499 500 501 502 503 504 
        QString fileNamespace = QHelpEngineCore::namespaceName(qchFileName);
        if (!fileNamespace.isEmpty() && !hc.registeredDocumentations().contains(fileNamespace)) {
            if (!hc.registerDocumentation(qchFileName))
                qDebug() << hc.error();
            needsSetup = true;
        }
con's avatar
Initial import
con committed
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 
    }

    int i = m_helpEngine->customValue(
        QLatin1String("UnfilteredFilterInserted")).toInt();
    if (i != 1) {
        {
            QHelpEngineCore hc(m_helpEngine->collectionFile());
            hc.setupData();
            hc.addCustomFilter(tr("Unfiltered"), QStringList());
            hc.setCustomValue(QLatin1String("UnfilteredFilterInserted"), 1);
        }
        m_helpEngine->blockSignals(true);
        m_helpEngine->setCurrentFilter(tr("Unfiltered"));
        m_helpEngine->blockSignals(false);
        needsSetup = true;
    }

    if (needsSetup)
        m_helpEngine->setupData();

    updateFilterComboBox();
    m_bookmarkManager->setupBookmarkModels();

    if (Core::Internal::WelcomeMode *welcomeMode = qobject_cast<Core::Internal::WelcomeMode*>(m_core->modeManager()->mode(Core::Constants::MODE_WELCOME))) {
Daniel Molkentin's avatar
welcome screen: tutorial section works, remember last tab  
Daniel Molkentin committed
529 
        connect(welcomeMode, SIGNAL(openHelpPage(const QString&)), this, SLOT(openHelpPage(const QString&)));
Daniel Molkentin's avatar
welcome screen: populate example combobox  
Daniel Molkentin committed
530 
        connect(welcomeMode, SIGNAL(openContextHelpPage(const QString&)), this, SLOT(openContextHelpPage(QString)));
con's avatar
Initial import
con committed
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 
    }
}

void HelpPlugin::shutdown()
{
    m_sideBar->saveSettings(m_core->settings());
    m_bookmarkManager->saveBookmarks();
    delete m_bookmarkManager;
}

void HelpPlugin::setIndexFilter(const QString &filter)
{
    m_indexWidget->setSearchLineEditText(filter);
}

QString HelpPlugin::indexFilter() const
{
    return m_indexWidget->searchLineEditText();
}

void HelpPlugin::modeChanged(Core::IMode *mode)
{
    if (mode == m_mode && !m_shownLastPages) {
        m_shownLastPages = true;
        qApp->processEvents();
        qApp->setOverrideCursor(Qt::WaitCursor);
        m_centralWidget->setLastShownPages();
        qApp->restoreOverrideCursor();
    }
}
Daniel Molkentin's avatar
welcome screen: populate example combobox  
Daniel Molkentin committed
562 563 564 565 566 567 
void HelpPlugin::openContextHelpPage(const QString &url)
{
    Core::RightPaneWidget::instance()->setShown(true);
    m_helpViewerForSideBar->setSource(QUrl(url));
}
con's avatar
Initial import
con committed
568 569 570 571 572 573 
void HelpPlugin::activateContext()
{
    using namespace Core;
    // case 1 sidebar shown and has focus, we show whatever we have in the
    // sidebar in big
    RightPanePlaceHolder* placeHolder = RightPanePlaceHolder::current();
hjk's avatar
some more whitespace changes  
hjk committed
574 
    if (placeHolder && Core::RightPaneWidget::instance()->hasFocus()) {
con's avatar
Initial import
con committed
575 576 577 578 579 580 581 582 583 584 585 586 587 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 
        switchToHelpMode();
        return;
    }

    bool useSideBar = false;
    if (placeHolder && !Core::RightPaneWidget::instance()->hasFocus())
        useSideBar = true;

    // Find out what to show
    HelpViewer *viewer = 0;
    if (IContext *context = m_core->currentContextObject()) {
        if (!m_contextHelpEngine) {
            m_contextHelpEngine = new QHelpEngineCore(m_helpEngine->collectionFile(), this);
            //m_contextHelpEngine->setAutoSaveFilter(false);
            m_contextHelpEngine->setupData();
            m_contextHelpEngine->setCurrentFilter(tr("Unfiltered"));
        }

        const QString &id = context->contextHelpId();
        QMap<QString, QUrl> links = m_contextHelpEngine->linksForIdentifier(id);
        if (!links.isEmpty()) {
            if (useSideBar) {
                Core::RightPaneWidget::instance()->setShown(true);
                viewer = m_helpViewerForSideBar;
            } else {
                viewer = m_centralWidget->currentHelpViewer();
                m_core->modeManager()->activateMode(QLatin1String(Constants::ID_MODE_HELP));
            }

            if (viewer) {
                QUrl source = *links.begin();
                if (viewer->source() != source)
                    viewer->setSource(source);
                viewer->setFocus();
            }
        } else {
            // No link found
            if (useSideBar) {
                Core::RightPaneWidget::instance()->setShown(true);
                viewer = m_helpViewerForSideBar;
            } else {
                viewer = m_centralWidget->currentHelpViewer();
hjk's avatar
Fixes: help: small refactoring  
hjk committed
617 
                activateHelpMode();
con's avatar
Initial import
con committed
618 619 620 
            }
            
            if (viewer) {
con's avatar
Fixes: - Html used for "No Documentation found" was invalid  
con committed
621 622 
                viewer->setHtml(tr("<html><head><title>No Documentation</title></head><body><br/>"
                    "<center><b>%1</b><br/>No documentation available.</center></body></html>").
con's avatar
Initial import
con committed
623 624 625 626 627 628 629 630 631 632 633 634 
                    arg(id));
                viewer->setSource(QUrl());
                //activateIndex();
            }
        }
    } else {
        // No context object
        if (useSideBar) {
            Core::RightPaneWidget::instance()->setShown(true);
            viewer = m_helpViewerForSideBar;
        } else {
            viewer = m_centralWidget->currentHelpViewer();
hjk's avatar
Fixes: help: small refactoring  
hjk committed
635 
            activateHelpMode();
con's avatar
Initial import
con committed
636 637 638 639 
        }

        if (viewer) {
            viewer->setSource(QUrl());
Oswald Buddenhagen's avatar
add missing tr()s, etc., add some //: comments  
Oswald Buddenhagen committed
640 641 
            viewer->setHtml(tr("<html><head><title>No Documentation</title></head><body><br/><br/><center>No"
                " documentation available.</center></body></html>"));
con's avatar
Initial import
con committed
642 643 644 645 646 647 648 
            //activateIndex();
        }
    }
}

void HelpPlugin::activateIndex()
{
hjk's avatar
Fixes: help: small refactoring  
hjk committed
649 
    activateHelpMode();
con's avatar
Initial import
con committed
650 651 652 653 654 
    m_sideBar->activateItem(m_indexItem);
}

void HelpPlugin::activateContents()
{
hjk's avatar
Fixes: help: small refactoring  
hjk committed
655 
    activateHelpMode();
con's avatar
Initial import
con committed
656 657 658 659 660 
    m_sideBar->activateItem(m_contentItem);
}

void HelpPlugin::activateSearch()
{
hjk's avatar
Fixes: help: small refactoring  
hjk committed
661 
    activateHelpMode();
con's avatar
Initial import
con committed
662 663 664 665 666 667 
    m_sideBar->activateItem(m_searchItem);
}

QToolBar *HelpPlugin::createToolBar()
{
    QToolBar *toolWidget = new QToolBar;
con's avatar
Fixes: - Rename ActionManagerInterface --> ActionManager  
con committed
668 
    Core::ActionManager *am = m_core->actionManager();
con's avatar
Initial import
con committed
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 
    toolWidget->addAction(am->command(QLatin1String("Help.Home"))->action());
    toolWidget->addAction(am->command(QLatin1String("Help.Previous"))->action());
    toolWidget->addAction(am->command(QLatin1String("Help.Next"))->action());
    toolWidget->addSeparator();
    toolWidget->addAction(am->command(QLatin1String("Help.AddBookmark"))->action());
    //int size = toolWidget->style()->pixelMetric(QStyle::PM_SmallIconSize);
    //toolWidget->setIconSize(QSize(size, size));
    toolWidget->setMovable(false);

    toolWidget->addSeparator();

    QWidget *w = new QWidget;
    QHBoxLayout *layout = new QHBoxLayout(w);
    layout->setMargin(0);
    layout->addSpacing(10);
    layout->addWidget(new QLabel(tr("Filtered by:")));
    m_filterComboBox = new QComboBox;
    m_filterComboBox->setMinimumContentsLength(20);
    connect(m_filterComboBox, SIGNAL(activated(const QString&)),
        this, SLOT(filterDocumentation(const QString&)));
    layout->addWidget(m_filterComboBox);
    toolWidget->addWidget(w);

    return toolWidget;
}

void HelpPlugin::updateFilterComboBox()
{
    QString curFilter = m_filterComboBox->currentText();
    if (curFilter.isEmpty())
        curFilter = m_helpEngine->currentFilter();
    m_filterComboBox->clear();
    m_filterComboBox->addItems(m_helpEngine->customFilters());
    int idx = m_filterComboBox->findText(curFilter);
    if (idx < 0)
        idx = 0;
    m_filterComboBox->setCurrentIndex(idx);
}

void HelpPlugin::checkForHelpChanges()
{
    bool changed = m_docSettingsPage->applyChanges();
    changed |= m_filterSettingsPage->applyChanges();
    if (changed)
        m_helpEngine->setupData();
}

void HelpPlugin::filterDocumentation(const QString &customFilter)
{
    m_helpEngine->setCurrentFilter(customFilter);
}

void HelpPlugin::addBookmark()
{
    addNewBookmark(m_centralWidget->currentTitle(), m_centralWidget->currentSource().toString());
}

void HelpPlugin::addNewBookmark(const QString &title, const QString &url)
{
    if (url.isEmpty())
        return;

    m_bookmarkManager->showBookmarkDialog(m_centralWidget, title, url);
}
Daniel Molkentin's avatar
Register as handler for qthelp://, remove obsolete started action slot.  
Daniel Molkentin committed
734 
void HelpPlugin::openHelpPage(const QUrl& url)
con's avatar
Initial import
con committed
735 
{
Daniel Molkentin's avatar
Register as handler for qthelp://, remove obsolete started action slot.  
Daniel Molkentin committed
736 
    openHelpPage(url.toString());
con's avatar
Initial import
con committed
737 738 
}
Daniel Molkentin's avatar
welcome screen: tutorial section works, remember last tab  
Daniel Molkentin committed
739 740 741 742 743 744 745 746 
void HelpPlugin::openHelpPage(const QString& url)
{
    activateHelpMode();
    if (m_helpEngine->findFile(url).isValid())
        m_centralWidget->setSource(url);
    else {
        QString page = url.mid(url.lastIndexOf('/')+1);
        qDebug() << url << page << url.lastIndexOf('/');
Daniel Molkentin's avatar
welcome screen: preview in news feed, Buttons added, resizing sanatized  
Daniel Molkentin committed
747 
        QDesktopServices::openUrl(QLatin1String("http://doc.trolltech.com/latest/")+page);
Daniel Molkentin's avatar
welcome screen: tutorial section works, remember last tab  
Daniel Molkentin committed
748 749 
    }
}
con's avatar
Initial import
con committed
750 751 

Q_EXPORT_PLUGIN(HelpPlugin)