source: branches/vendor/trolltech/qt/current/tools/assistant/lib/qhelpindexwidget.h @ 2

Last change on this file since 2 was 2, checked in by Dmitry A. Kuminov, 13 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.

File size: 3.4 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information (qt-info@nokia.com)
5**
6** This file is part of the Qt Assistant of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file.  Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file.  Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at qt-sales@nokia.com.
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QHELPINDEXWIDGET_H
43#define QHELPINDEXWIDGET_H
44
45#include <QtHelp/qhelp_global.h>
46
47#include <QtCore/QUrl>
48#include <QtGui/QStringListModel>
49#include <QtGui/QListView>
50
51QT_BEGIN_HEADER
52
53QT_BEGIN_NAMESPACE
54
55QT_MODULE(Help)
56
57class QHelpEnginePrivate;
58class QHelpIndexModelPrivate;
59
60class QHELP_EXPORT QHelpIndexModel : public QStringListModel
61{
62    Q_OBJECT
63
64public:
65    void createIndex(const QString &customFilterName);
66    QModelIndex filter(const QString &filter,
67        const QString &wildcard = QString());
68
69    QMap<QString, QUrl> linksForKeyword(const QString &keyword) const;
70    bool isCreatingIndex() const;
71
72Q_SIGNALS:
73    void indexCreationStarted();
74    void indexCreated();
75
76private Q_SLOTS:
77    void insertIndices();
78    void invalidateIndex(bool onShutDown = false);
79
80private:
81    QHelpIndexModel(QHelpEnginePrivate *helpEngine);
82    ~QHelpIndexModel();
83
84    QHelpIndexModelPrivate *d;
85    friend class QHelpEnginePrivate;
86};
87
88class QHELP_EXPORT QHelpIndexWidget : public QListView
89{
90    Q_OBJECT
91
92Q_SIGNALS:
93    void linkActivated(const QUrl &link, const QString &keyword);
94    void linksActivated(const QMap<QString, QUrl> &links,
95        const QString &keyword);
96
97public Q_SLOTS:
98    void filterIndices(const QString &filter,
99        const QString &wildcard = QString());
100    void activateCurrentItem();
101
102private Q_SLOTS:
103    void showLink(const QModelIndex &index);
104
105private:
106    QHelpIndexWidget();
107    friend class QHelpEngine;
108};
109
110QT_END_NAMESPACE
111
112QT_END_HEADER
113
114#endif
Note: See TracBrowser for help on using the repository browser.