source: branches/vendor/trolltech/qt/current/tools/assistant/lib/qhelpengine_p.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: 4.0 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 QHELPENGINE_P_H
43#define QHELPENGINE_P_H
44
45//
46//  W A R N I N G
47//  -------------
48//
49// This file is not part of the Qt API. It exists for the convenience
50// of the help generator tools. This header file may change from version
51// to version without notice, or even be removed.
52//
53// We mean it.
54//
55
56#include <QtCore/QMap>
57#include <QtCore/QStringList>
58#include <QtCore/QObject>
59
60QT_BEGIN_NAMESPACE
61
62class QSqlQuery;
63
64class QHelpEngineCore;
65class QHelpDBReader;
66class QHelpContentModel;
67class QHelpContentWidget;
68class QHelpIndexModel;
69class QHelpIndexWidget;
70class QHelpSearchEngine;
71class QHelpCollectionHandler;
72
73class QHelpEngineCorePrivate : public QObject
74{
75    Q_OBJECT
76
77public:
78    QHelpEngineCorePrivate();
79    virtual ~QHelpEngineCorePrivate();
80
81    virtual void init(const QString &collectionFile,
82        QHelpEngineCore *helpEngineCore);
83
84    void clearMaps();
85    bool setup();
86
87    QMap<QString, QHelpDBReader*> readerMap;
88    QMap<QString, QHelpDBReader*> fileNameReaderMap;
89    QMultiMap<QString, QHelpDBReader*> virtualFolderMap;
90    QStringList orderedFileNameList;
91
92    QHelpCollectionHandler *collectionHandler;
93    QString currentFilter;
94    QString error;
95    bool needsSetup;
96    bool autoSaveFilter;
97
98protected:
99    QHelpEngineCore *q;
100
101private slots:
102    void errorReceived(const QString &msg);
103};
104
105
106class QHelpEnginePrivate : public QHelpEngineCorePrivate
107{
108    Q_OBJECT
109
110public:
111    QHelpEnginePrivate();
112    ~QHelpEnginePrivate();
113
114    void init(const QString &collectionFile,
115        QHelpEngineCore *helpEngineCore);
116
117    QHelpContentModel *contentModel;
118    QHelpContentWidget *contentWidget;
119
120    QHelpIndexModel *indexModel;
121    QHelpIndexWidget *indexWidget;
122
123    QHelpSearchEngine *searchEngine;
124
125    void stopDataCollection();
126
127    friend class QHelpContentProvider;
128    friend class QHelpContentModel;
129    friend class QHelpIndexProvider;
130    friend class QHelpIndexModel;
131
132public slots:
133    void setContentsWidgetBusy();
134    void unsetContentsWidgetBusy();
135    void setIndexWidgetBusy();
136    void unsetIndexWidgetBusy();
137
138private slots:
139    void applyCurrentFilter();
140};
141
142QT_END_NAMESPACE
143
144#endif
Note: See TracBrowser for help on using the repository browser.