summaryrefslogtreecommitdiff
path: root/src/plugins/help/indextoolwindow.cpp
blob: fdae72b95967108d47bc3c1e20602b61e38255b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
**
** Non-Open Source Usage
**
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the packaging
** of this file.  Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt GPL Exception
** version 1.3, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/

#include "indextoolwindow.h"
#include "helpengine.h"
#include "topicchooser.h"

#include <QtCore/QDebug>
#include <QtGui/QKeyEvent>
#include <QtGui/QFocusEvent>
#include <QtGui/QLayout>
#include <QtGui/QLabel>
#include <QtGui/QLineEdit>
#include <QtGui/QListView>
#include <QtGui/QApplication>

using namespace Help::Internal;

IndexToolWidget::IndexToolWidget()
{
    wasInitialized = false;

    QVBoxLayout *layout = new QVBoxLayout(this);
    layout->setMargin(0);

    QLabel *l = new QLabel(tr("Look for:"), this);
    layout->addWidget(l);

    findLineEdit = new QLineEdit(this);
    findLineEdit->installEventFilter(this);
    layout->addWidget(findLineEdit);

    indicesView = new QListView(this);
    indicesView->setLayoutMode(QListView::Batched);
    indicesView->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);

    layout->addWidget(indicesView);

    setWindowTitle(tr("Index"));
    setWindowIcon(QIcon(":/help/images/find.png"));
}

void IndexToolWidget::focusInEvent(QFocusEvent *e)
{
    showEvent(0);
    if (e && e->reason() != Qt::MouseFocusReason) {
        findLineEdit->selectAll();
        findLineEdit->setFocus();
    }
}

void IndexToolWidget::showEvent(QShowEvent *)
{
    if (!wasInitialized) {
        wasInitialized = true;
        setCursor(QCursor(Qt::WaitCursor));
        emit buildRequested();
    }
}

bool IndexToolWidget::eventFilter(QObject * o, QEvent * e)
{
    if (o == findLineEdit && e->type() == QEvent::KeyPress) {
        switch (static_cast<QKeyEvent*>(e)->key()) {
            case Qt::Key_Up:
            case Qt::Key_Down:
            case Qt::Key_PageDown:
            case Qt::Key_PageUp:
                QApplication::sendEvent(indicesView, e);
                break;
            case Qt::Key_Escape:
                emit escapePressed();
                break;
            default:
                break;
        }
    }
    return QWidget::eventFilter(o, e);
}


IndexToolWindow::IndexToolWindow(const QList<int> &context, HelpEngine *help)
{
    m_context = context;
    m_context << 0;

    m_widget = new IndexToolWidget;

    helpEngine = help;
    connect(helpEngine, SIGNAL(indexInitialized()), this, SLOT(indexDone()));
    model = 0;

    connect(m_widget->findLineEdit, SIGNAL(textEdited(const QString&)),
        this, SLOT(searchInIndex(const QString &)));
    connect(m_widget->findLineEdit, SIGNAL(returnPressed()), this, SLOT(indexRequested()));    
    connect(m_widget, SIGNAL(buildRequested()), helpEngine, SLOT(buildIndex()));    
    
    connect(m_widget->indicesView, SIGNAL(activated(const QModelIndex&)),
        this, SLOT(indexRequested()));    
    connect(m_widget, SIGNAL(escapePressed()), this, SIGNAL(escapePressed()));    
    
}

IndexToolWindow::~IndexToolWindow()
{
    delete m_widget;
}

const QList<int> &IndexToolWindow::context() const
{
    return m_context;
}

QWidget *IndexToolWindow::widget()
{
    return m_widget;
}

void IndexToolWindow::indexDone()
{
    model = helpEngine->indices();
    m_widget->indicesView->setModel(model);
    m_widget->setCursor(QCursor(Qt::ArrowCursor));
}

void IndexToolWindow::searchInIndex(const QString &str)
{
    if (!model)
        return;
    QRegExp atoz("[A-Z]");
    int matches = str.count(atoz);
    if (matches > 0 && !str.contains(".*"))
    {
        int start = 0;
        QString newSearch;
        for (; matches > 0; --matches) {
            int match = str.indexOf(atoz, start+1);
            if (match <= start)
                continue;
            newSearch += str.mid(start, match-start);
            newSearch += ".*";
            start = match;
        }
        newSearch += str.mid(start);
        m_widget->indicesView->setCurrentIndex(model->filter(newSearch, str));
    }
    else
        m_widget->indicesView->setCurrentIndex(model->filter(str, str));
}

void IndexToolWindow::indexRequested()
{
    if (!model)
        return;
    int row = m_widget->indicesView->currentIndex().row();
    if (row == -1 || row >= model->rowCount())
        return;

    QString description = model->description(row);
    QStringList links = model->links(row);

    bool blocked = m_widget->findLineEdit->blockSignals(true);
    m_widget->findLineEdit->setText(description);
    m_widget->findLineEdit->blockSignals(blocked);

    if (links.count() == 1) {
        emit showLinkRequested(links.first(), false);
    } else {
        qSort(links);
        QStringList::Iterator it = links.begin();
        QStringList linkList;
        QStringList linkNames;
        for (; it != links.end(); ++it) {
            linkList << *it;
            linkNames << helpEngine->titleOfLink(*it);
        }
        QString link = TopicChooser::getLink(m_widget, linkNames, linkList, description);
        if (!link.isEmpty())
            emit showLinkRequested(link, false);
    }

    model->publish();
    m_widget->indicesView->setCurrentIndex(model->index(model->stringList().indexOf(description)));
    m_widget->indicesView->scrollTo(m_widget->indicesView->currentIndex(), QAbstractItemView::PositionAtTop);
}