QHelpIndexWidget Class

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

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

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)

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)

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