Fix crash when accessing the content model.
[qt:qt.git] / tools / assistant / lib / qhelpenginecore.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the Qt Assistant of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QHELPENGINECORE_H
43 #define QHELPENGINECORE_H
44
45 #include <QtHelp/qhelp_global.h>
46
47 #include <QtCore/QUrl>
48 #include <QtCore/QMap>
49 #include <QtCore/QObject>
50 #include <QtCore/QVariant>
51
52 QT_BEGIN_HEADER
53
54 QT_BEGIN_NAMESPACE
55
56 QT_MODULE(Help)
57
58 class QHelpEngineCorePrivate;
59
60 class QHELP_EXPORT QHelpEngineCore : public QObject
61 {
62     Q_OBJECT
63     Q_PROPERTY(bool autoSaveFilter READ autoSaveFilter WRITE setAutoSaveFilter)
64     Q_PROPERTY(QString collectionFile READ collectionFile WRITE setCollectionFile)
65     Q_PROPERTY(QString currentFilter READ currentFilter WRITE setCurrentFilter)
66     
67 public:
68     explicit QHelpEngineCore(const QString &collectionFile, QObject *parent = 0);
69     virtual ~QHelpEngineCore();
70
71     bool setupData();
72
73     QString collectionFile() const;
74     void setCollectionFile(const QString &fileName);
75
76     bool copyCollectionFile(const QString &fileName);
77
78     static QString namespaceName(const QString &documentationFileName);
79     bool registerDocumentation(const QString &documentationFileName);
80     bool unregisterDocumentation(const QString &namespaceName);
81     QString documentationFileName(const QString &namespaceName);
82
83     QStringList customFilters() const;
84     bool removeCustomFilter(const QString &filterName);
85     bool addCustomFilter(const QString &filterName,
86         const QStringList &attributes);
87
88     QStringList filterAttributes() const;
89     QStringList filterAttributes(const QString &filterName) const;
90
91     QString currentFilter() const;
92     void setCurrentFilter(const QString &filterName);
93
94     QStringList registeredDocumentations() const;
95     QList<QStringList> filterAttributeSets(const QString &namespaceName) const;
96     QList<QUrl> files(const QString namespaceName,
97         const QStringList &filterAttributes,
98         const QString &extensionFilter = QString());
99     QUrl findFile(const QUrl &url) const;
100     QByteArray fileData(const QUrl &url) const;
101
102     QMap<QString, QUrl> linksForIdentifier(const QString &id) const;
103
104     bool removeCustomValue(const QString &key);
105     QVariant customValue(const QString &key,
106         const QVariant &defaultValue = QVariant()) const;
107     bool setCustomValue(const QString &key, const QVariant &value);
108
109     static QVariant metaData(const QString &documentationFileName,
110         const QString &name);
111
112     QString error() const;
113
114     void setAutoSaveFilter(bool save);
115     bool autoSaveFilter() const;
116
117 Q_SIGNALS:
118     void setupStarted();
119     void setupFinished();
120     void currentFilterChanged(const QString &newFilter);
121     void warning(const QString &msg);
122     void readersAboutToBeInvalidated();
123
124 protected:
125     QHelpEngineCore(QHelpEngineCorePrivate *helpEngineCorePrivate,
126         QObject *parent);
127
128 private:
129     QHelpEngineCorePrivate *d;
130     friend class QHelpEngineCorePrivate;
131 };
132
133 QT_END_NAMESPACE
134
135 QT_END_HEADER
136
137 #endif // QHELPENGINECORE_H