helpindexfilter.cpp 3.01 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
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.
15
**
16
** GNU Lesser General Public License Usage
17
**
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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
31
#include "helpindexfilter.h"

32
33
34
#include "centralwidget.h"
#include "topicchooser.h"

con's avatar
con committed
35
36
#include <extensionsystem/pluginmanager.h>
#include <coreplugin/icore.h>
kh1's avatar
kh1 committed
37
#include <coreplugin/helpmanager.h>
con's avatar
con committed
38

39
40
#include <QtGui/QIcon>

con's avatar
con committed
41
using namespace Locator;
con's avatar
con committed
42
43
44
using namespace Help;
using namespace Help::Internal;

45
Q_DECLARE_METATYPE(ILocatorFilter*);
con's avatar
con committed
46

47
HelpIndexFilter::HelpIndexFilter()
con's avatar
con committed
48
49
{
    setIncludedByDefault(false);
50
    setShortcutString(QString(QLatin1Char('?')));
kh1's avatar
kh1 committed
51
    m_icon = QIcon(QLatin1String(":/help/images/bookmark.png"));
con's avatar
con committed
52
53
}

54
HelpIndexFilter::~HelpIndexFilter()
con's avatar
con committed
55
56
57
{
}

58
QString HelpIndexFilter::displayName() const
con's avatar
con committed
59
60
61
62
{
    return tr("Help index");
}

63
QString HelpIndexFilter::id() const
con's avatar
con committed
64
65
66
67
{
    return QLatin1String("HelpIndexFilter");
}

68
ILocatorFilter::Priority HelpIndexFilter::priority() const
con's avatar
con committed
69
70
71
72
73
74
{
    return Medium;
}

QList<FilterEntry> HelpIndexFilter::matchesFor(const QString &entry)
{
kh1's avatar
kh1 committed
75
    QStringList keywords;
76
    if (entry.length() < 2)
kh1's avatar
kh1 committed
77
        keywords = Core::HelpManager::instance()->findKeywords(entry, 200);
kh1's avatar
kh1 committed
78
79
80
81
82
83
84
85
    else
        keywords = Core::HelpManager::instance()->findKeywords(entry);

    QList<FilterEntry> entries;
    foreach (const QString &keyword, keywords)
        entries.append(FilterEntry(this, keyword, QVariant(), m_icon));

    return entries;
con's avatar
con committed
86
87
88
89
}

void HelpIndexFilter::accept(FilterEntry selection) const
{
90
    const QString &key = selection.displayName;
kh1's avatar
kh1 committed
91
    const QMap<QString, QUrl> &links = Core::HelpManager::instance()->linksForKeyword(key);
92

con's avatar
con committed
93
94
95
    if (links.size() == 1) {
        emit linkActivated(links.begin().value());
    } else if (!links.isEmpty()) {
96
97
98
        TopicChooser tc(CentralWidget::instance(), key, links);
        if (tc.exec() == QDialog::Accepted)
            emit linkActivated(tc.link());
con's avatar
con committed
99
100
101
102
103
    }
}

void HelpIndexFilter::refresh(QFutureInterface<void> &future)
{
104
    Q_UNUSED(future)
con's avatar
con committed
105
106
    // Nothing to refresh
}