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 QHELPINDEXWIDGET_H

    43 #define QHELPINDEXWIDGET_H

    44 

    45 #include <QtHelp/qhelp_global.h>

    46 

    47 #include <QtCore/QUrl>

    48 #include <QtGui/QStringListModel>

    49 #include <QtGui/QListView>

    50 

    51 QT_BEGIN_HEADER

    52 

    53 QT_BEGIN_NAMESPACE

    54 

    55 QT_MODULE(Help)

    56 

    57 class QHelpEnginePrivate;

    58 class QHelpIndexModelPrivate;

    59 

    60 class QHELP_EXPORT QHelpIndexModel : public QStringListModel

    61 {

    62     Q_OBJECT

    63 

    64 public:

    65     void createIndex(const QString &customFilterName);

    66     QModelIndex filter(const QString &filter,

    67         const QString &wildcard = QString());

    68 

    69     QMap<QString, QUrl> linksForKeyword(const QString &keyword) const;

    70     bool isCreatingIndex() const;

    71 

    72 Q_SIGNALS:

    73     void indexCreationStarted();

    74     void indexCreated();

    75 

    76 private Q_SLOTS:

    77     void insertIndices();

    78     void invalidateIndex(bool onShutDown = false);

    79 

    80 private:

    81     QHelpIndexModel(QHelpEnginePrivate *helpEngine);

    82     ~QHelpIndexModel();

    83 

    84     QHelpIndexModelPrivate *d;

    85     friend class QHelpEnginePrivate;

    86 };

    87 

    88 class QHELP_EXPORT QHelpIndexWidget : public QListView

    89 {

    90     Q_OBJECT

    91 

    92 Q_SIGNALS:

    93     void linkActivated(const QUrl &link, const QString &keyword);

    94     void linksActivated(const QMap<QString, QUrl> &links,

    95         const QString &keyword);

    96 

    97 public Q_SLOTS:

    98     void filterIndices(const QString &filter,

    99         const QString &wildcard = QString());

   100     void activateCurrentItem();

   101 

   102 private Q_SLOTS:

   103     void showLink(const QModelIndex &index);

   104 

   105 private:

   106     QHelpIndexWidget();

   107     friend class QHelpEngine;

   108 };

   109 

   110 QT_END_NAMESPACE

   111 

   112 QT_END_HEADER

   113 

   114 #endif