summaryrefslogtreecommitdiff
path: root/src/plugins/help/indextoolwindow.h
blob: 4d4eb8f6b25695bec1b8e16b0547970a91e4b82c (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
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008 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.2, included in the file GPL_EXCEPTION.txt in this package.  
** 
***************************************************************************/
#ifndef INDEXTOOLWINDOW_H
#define INDEXTOOLWINDOW_H

#include <QtCore/QModelIndex>
#include <QtGui/QWidget>

#include <coreplugin/iview.h>

class QListView;
class QLineEdit;

namespace Help {
namespace Internal {

class HelpEngine;
class IndexListModel;
class IndexToolWindow;

class IndexToolWidget : public QWidget
{
    Q_OBJECT
public:
    IndexToolWidget();

signals:
    void buildRequested();
    void escapePressed();

private:
    friend class IndexToolWindow;

    bool eventFilter(QObject * o, QEvent * e);
    void showEvent(QShowEvent *e);
    void focusInEvent(QFocusEvent *e);

    bool wasInitialized;
    QLineEdit *findLineEdit;
    QListView *indicesView;
};


class IndexToolWindow : public Core::IView
{
    Q_OBJECT

public:
    IndexToolWindow(const QList<int> &context, HelpEngine *help);
    ~IndexToolWindow();

    const QList<int> &context() const;
    QWidget *widget();

    QList<QWidget*> dockToolBarWidgets() const { return QList<QWidget*>(); }

    const char *uniqueViewName() const { return "Help.IndexToolWindow"; }
    const char *globalMenuGroup() const { return "Help.Group"; }
    inline QKeySequence defaultShortcut() const { return QKeySequence(); }
    Qt::DockWidgetArea defaultArea() const { return Qt::RightDockWidgetArea; }
    IView::ViewPosition defaultPosition() const { return IView::Second; }

signals:
    void showLinkRequested(const QString &link, bool newWindow);
    void escapePressed();

private slots:
    void indexDone();
    void searchInIndex(const QString &str);
    void indexRequested();

private:
    HelpEngine *helpEngine;
    IndexListModel *model;

    QList<int> m_context;
    IndexToolWidget *m_widget;
};

} // namespace Internal
} // namespace Help

#endif // INDEXTOOLWINDOW_H