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 QHELPCONTENTWIDGET_H

    43 #define QHELPCONTENTWIDGET_H

    44 

    45 #include <QtHelp/qhelp_global.h>

    46 

    47 #include <QtCore/QQueue>

    48 #include <QtCore/QString>

    49 #include <QtGui/QTreeView>

    50 

    51 QT_BEGIN_HEADER

    52 

    53 QT_BEGIN_NAMESPACE

    54 

    55 QT_MODULE(Help)

    56 

    57 class QHelpEnginePrivate;

    58 class QHelpDBReader;

    59 class QHelpContentItemPrivate;

    60 class QHelpContentModelPrivate;

    61 class QHelpEngine;

    62 class QHelpContentProvider;

    63 

    64 class QHELP_EXPORT QHelpContentItem

    65 {

    66 public:

    67     ~QHelpContentItem();

    68 

    69     QHelpContentItem *child(int row) const;

    70     int childCount() const;

    71     QString title() const;

    72     QUrl url() const;

    73     int row() const;

    74     QHelpContentItem *parent() const;

    75     int childPosition(QHelpContentItem *child) const;

    76 

    77 private:

    78     QHelpContentItem(const QString &name, const QString &link,

    79         QHelpDBReader *reader, QHelpContentItem *parent = 0);

    80     void appendChild(QHelpContentItem *child);

    81 

    82     QHelpContentItemPrivate *d;

    83     friend class QHelpContentProvider;

    84 };

    85 

    86 class QHELP_EXPORT QHelpContentModel : public QAbstractItemModel

    87 {

    88     Q_OBJECT

    89 

    90 public:

    91     ~QHelpContentModel();

    92 

    93     void createContents(const QString &customFilterName);

    94     QHelpContentItem *contentItemAt(const QModelIndex &index) const;

    95 

    96     QVariant data(const QModelIndex &index, int role) const;

    97     QModelIndex index(int row, int column,

    98         const QModelIndex &parent = QModelIndex()) const;

    99     QModelIndex parent(const QModelIndex &index) const;

   100     int rowCount(const QModelIndex &parent = QModelIndex()) const;

   101     int columnCount(const QModelIndex &parent = QModelIndex()) const;

   102     bool isCreatingContents() const;

   103 

   104 Q_SIGNALS:

   105     void contentsCreationStarted();

   106     void contentsCreated();

   107 

   108 private Q_SLOTS:

   109     void insertContents();

   110     void invalidateContents(bool onShutDown = false);

   111 

   112 private:

   113     QHelpContentModel(QHelpEnginePrivate *helpEngine);

   114     QHelpContentModelPrivate *d;

   115     friend class QHelpEnginePrivate;

   116 };

   117 

   118 class QHELP_EXPORT QHelpContentWidget : public QTreeView

   119 {

   120     Q_OBJECT

   121 

   122 public:

   123     QModelIndex indexOf(const QUrl &link);

   124 

   125 Q_SIGNALS:

   126     void linkActivated(const QUrl &link);

   127 

   128 private Q_SLOTS:

   129     void showLink(const QModelIndex &index);

   130 

   131 private:

   132     bool searchContentItem(QHelpContentModel *model,

   133         const QModelIndex &parent, const QString &path);

   134     QModelIndex m_syncIndex;

   135 

   136 private:

   137     QHelpContentWidget();

   138     friend class QHelpEngine;

   139 };

   140 

   141 QT_END_NAMESPACE

   142 

   143 QT_END_HEADER

   144 

   145 #endif

   146