1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the Qt Assistant of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    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     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 

   123 protected:

   124     QHelpEngineCore(QHelpEngineCorePrivate *helpEngineCorePrivate,

   125         QObject *parent);

   126 

   127 private:

   128     QHelpEngineCorePrivate *d;

   129     friend class QHelpEngineCorePrivate;

   130 };

   131 

   132 QT_END_NAMESPACE

   133 

   134 QT_END_HEADER

   135 

   136 #endif // QHELPENGINECORE_H