| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the Qt Assistant of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #ifndef QHELPCONTENTWIDGET_H |
| #define QHELPCONTENTWIDGET_H |
| |
| #include <QtHelp/qhelp_global.h> |
| |
| #include <QtCore/QQueue> |
| #include <QtCore/QString> |
| #include <QtWidgets/QTreeView> |
| |
| QT_BEGIN_NAMESPACE |
| |
| |
| class QHelpEnginePrivate; |
| class QHelpContentItemPrivate; |
| class QHelpContentModelPrivate; |
| class QHelpEngine; |
| class QHelpContentProvider; |
| |
| class QHELP_EXPORT QHelpContentItem |
| { |
| public: |
| ~QHelpContentItem(); |
| |
| QHelpContentItem *child(int row) const; |
| int childCount() const; |
| QString title() const; |
| QUrl url() const; |
| int row() const; |
| QHelpContentItem *parent() const; |
| int childPosition(QHelpContentItem *child) const; |
| |
| private: |
| QHelpContentItem(const QString &name, const QUrl &link, |
| QHelpContentItem *parent = nullptr); |
| |
| QHelpContentItemPrivate *d; |
| friend class QHelpContentProvider; |
| }; |
| |
| class QHELP_EXPORT QHelpContentModel : public QAbstractItemModel |
| { |
| Q_OBJECT |
| |
| public: |
| ~QHelpContentModel() override; |
| |
| void createContents(const QString &customFilterName); |
| QHelpContentItem *contentItemAt(const QModelIndex &index) const; |
| |
| QVariant data(const QModelIndex &index, int role) const override; |
| QModelIndex index(int row, int column, |
| const QModelIndex &parent = QModelIndex()) const override; |
| QModelIndex parent(const QModelIndex &index) const override; |
| int rowCount(const QModelIndex &parent = QModelIndex()) const override; |
| int columnCount(const QModelIndex &parent = QModelIndex()) const override; |
| bool isCreatingContents() const; |
| |
| Q_SIGNALS: |
| void contentsCreationStarted(); |
| void contentsCreated(); |
| |
| private Q_SLOTS: |
| void insertContents(); |
| |
| private: |
| QHelpContentModel(QHelpEnginePrivate *helpEngine); |
| QHelpContentModelPrivate *d; |
| friend class QHelpEnginePrivate; |
| }; |
| |
| class QHELP_EXPORT QHelpContentWidget : public QTreeView |
| { |
| Q_OBJECT |
| |
| public: |
| QModelIndex indexOf(const QUrl &link); |
| |
| Q_SIGNALS: |
| void linkActivated(const QUrl &link); |
| |
| private Q_SLOTS: |
| void showLink(const QModelIndex &index); |
| |
| private: |
| bool searchContentItem(QHelpContentModel *model, |
| const QModelIndex &parent, const QString &path); |
| QModelIndex m_syncIndex; |
| |
| private: |
| QHelpContentWidget(); |
| friend class QHelpEngine; |
| }; |
| |
| QT_END_NAMESPACE |
| |
| #endif |
| |