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

    60 QT_BEGIN_NAMESPACE

    61 

    62 class QSqlQuery;

    63 

    64 class QHelpEngineCore;

    65 class QHelpDBReader;

    66 class QHelpContentModel;

    67 class QHelpContentWidget;

    68 class QHelpIndexModel;

    69 class QHelpIndexWidget;

    70 class QHelpSearchEngine;

    71 class QHelpCollectionHandler;

    72 

    73 class QHelpEngineCorePrivate : public QObject

    74 {

    75     Q_OBJECT

    76 

    77 public:

    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 

    98 protected:

    99     QHelpEngineCore *q;

   100 

   101 private slots:

   102     void errorReceived(const QString &msg);

   103 };

   104 

   105 

   106 class QHelpEnginePrivate : public QHelpEngineCorePrivate

   107 {

   108     Q_OBJECT

   109 

   110 public:

   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 

   132 public slots:

   133     void setContentsWidgetBusy();

   134     void unsetContentsWidgetBusy();

   135     void setIndexWidgetBusy();

   136     void unsetIndexWidgetBusy();

   137 

   138 private slots:

   139     void applyCurrentFilter();

   140 };

   141 

   142 QT_END_NAMESPACE

   143 

   144 #endif