qhelpindexwidget.h

Enable keyboard shortcuts

// Copyright (C) 2016 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

// Qt-Security score:significant reason:default

#ifndef QHELPINDEXWIDGET_H

#define QHELPINDEXWIDGET_H

#include <QtHelp/qhelp_global.h>

#include <QtCore/qstringlistmodel.h>

#include <QtCore/qurl.h>

#include <QtWidgets/qlistview.h>

QT_BEGIN_NAMESPACE

class QHelpEngineCore;

class QHelpEnginePrivate;

class QHelpIndexModelPrivate;

struct QHelpLink;

class QHELP_EXPORT QHelpIndexModel : public QStringListModel

    Q_OBJECT

public:

    void createIndexForCurrentFilter();

    void createIndex(const QString &customFilterName);

    QModelIndex filter(const QString &filter, const QString &wildcard = {});

    bool isCreatingIndex() const;

    QHelpEngineCore *helpEngine() const;

Q_SIGNALS:

    void indexCreationStarted();

    void indexCreated();

private Q_SLOTS:

    void insertIndices();

private:

    QHelpIndexModel(QHelpEngineCore *helpEngine);

    ~QHelpIndexModel();

    QHelpIndexModelPrivate *d;

    friend class QHelpEnginePrivate;

};

class QHELP_EXPORT QHelpIndexWidget : public QListView

    Q_OBJECT

    Q_MOC_INCLUDE(<QtHelp/qhelplink.h>)

Q_SIGNALS:

#if QT_DEPRECATED_SINCE(5, 15)

    QT_DEPRECATED_X("Use documentActivated() instead")

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

    QT_DEPRECATED_X("Use documentsActivated() instead")

    void linksActivated(const QMultiMap<QString, QUrl> &links, const QString &keyword);

#endif

    void documentActivated(const QHelpLink &document, const QString &keyword);

    void documentsActivated(const QList<QHelpLink> &documents, const QString &keyword);

public Q_SLOTS:

    void filterIndices(const QString &filter, const QString &wildcard = {});

    void activateCurrentItem();

private Q_SLOTS:

    void showLink(const QModelIndex &index);

private:

    QHelpIndexWidget();

    friend class QHelpEngine;

};

QT_END_NAMESPACE

#endif // QHELPINDEXWIDGET_H