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 QHELPCOLLECTIONHANDLER_H

    43 #define QHELPCOLLECTIONHANDLER_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/QList>

    57 #include <QtCore/QString>

    58 #include <QtCore/QObject>

    59 #include <QtCore/QVariant>

    60 #include <QtCore/QStringList>

    61 

    62 #include <QtSql/QSqlQuery>

    63 

    64 QT_BEGIN_NAMESPACE

    65 

    66 class QHelpCollectionHandler : public QObject

    67 {

    68     Q_OBJECT

    69 

    70 public:

    71     struct DocInfo

    72     {

    73         QString fileName;

    74         QString folderName;

    75         QString namespaceName;

    76     };

    77     typedef QList<DocInfo> DocInfoList;

    78 

    79     QHelpCollectionHandler(const QString &collectionFile, QObject *parent = 0);

    80     ~QHelpCollectionHandler();

    81 

    82     QString collectionFile() const;

    83 

    84     bool openCollectionFile();

    85     bool copyCollectionFile(const QString &fileName);

    86 

    87     QStringList customFilters() const;

    88     bool removeCustomFilter(const QString &filterName);

    89     bool addCustomFilter(const QString &filterName,

    90         const QStringList &attributes);

    91 

    92     DocInfoList registeredDocumentations() const;

    93     bool registerDocumentation(const QString &fileName);

    94     bool unregisterDocumentation(const QString &namespaceName);

    95 

    96     bool removeCustomValue(const QString &key);

    97     QVariant customValue(const QString &key, const QVariant &defaultValue) const;

    98     bool setCustomValue(const QString &key, const QVariant &value);

    99 

   100     bool addFilterAttributes(const QStringList &attributes);

   101     QStringList filterAttributes() const;

   102     QStringList filterAttributes(const QString &filterName) const;

   103     

   104     int registerNamespace(const QString &nspace, const QString &fileName);

   105     bool registerVirtualFolder(const QString &folderName, int namespaceId);

   106     void optimizeDatabase(const QString &fileName);

   107 

   108 signals:

   109     void error(const QString &msg);

   110 

   111 private:

   112     bool isDBOpened();

   113     bool createTables(QSqlQuery *query);

   114 

   115     bool m_dbOpened;

   116     QString m_collectionFile;

   117     QString m_connectionName;

   118     mutable QSqlQuery m_query;

   119 };

   120 

   121 QT_END_NAMESPACE

   122 

   123 #endif  //QHELPCOLLECTIONHANDLER_H