Qt 5.7Qt HelpC++ ClassesQHelpIndexWidget
Qt 5.7.1 Reference Documentation

Contents

QHelpIndexWidget Class

The QHelpIndexWidget class provides a list view displaying the QHelpIndexModel. More...

Header: #include <QHelpIndexWidget>
qmake: QT += help
Since: Qt 4.4
Inherits: QListView

Public Slots

void activateCurrentItem()
void filterIndices(const QString &filter, const QString &wildcard = QString())

Signals

void linkActivated(const QUrl &link, const QString &keyword)
void linksActivated(const QMap<QString, QUrl> &links, const QString &keyword)

Additional Inherited Members

Detailed Description

The QHelpIndexWidget class provides a list view displaying the QHelpIndexModel.

Member Function Documentation

[slot] void QHelpIndexWidget::activateCurrentItem()

Activates the current item which will result eventually in the emitting of a linkActivated() or linksActivated() signal.

[slot] void QHelpIndexWidget::filterIndices(const QString &filter, const QString &wildcard = QString())

Filters the indices according to filter or wildcard. The item with the best match is set as current item.

See also QHelpIndexModel::filter().

[signal] void QHelpIndexWidget::linkActivated(const QUrl &link, const QString &keyword)

This signal is emitted when an item is activated and its associated link should be shown. To know where the link belongs to, the keyword is given as a second paremeter.

[signal] void QHelpIndexWidget::linksActivated(const QMap<QString, QUrl> &links, const QString &keyword)

This signal is emitted when the item representing the keyword is activated and the item has more than one link associated. The links consist of the document title and their URL.

© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.
The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.
Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.