QHelpIndexWidget Class▲
-
Header: QHelpIndexWidget
-
CMake:
find_package(Qt6 REQUIRED COMPONENTS Help)
target_link_libraries(mytarget PRIVATE Qt6::Help)
-
qmake: QT += help
-
Inherits: QListView
Detailed Description▲
Member Function Documentation▲
void QHelpIndexWidget::activateCurrentItem()▲
Activates the current item which will result eventually in the emitting of a linkActivated() or linksActivated() signal.
[since 5.15] void QHelpIndexWidget::documentActivated(const QHelpLink &document, const QString &keyword)▲
This signal is emitted when an item is activated and its associated document should be shown. To know where the link belongs to, the keyword is given as a second parameter.
This function was introduced in Qt 5.15.
[since 5.15] void QHelpIndexWidget::documentsActivated(const QList<QHelpLink> &documents, const QString &keyword)▲
This signal is emitted when the item representing the keyword is activated and the item has more than one document associated. The documents consist of the document titles and their URLs.
This function was introduced in Qt 5.15.
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▲
See also QHelpIndexModel::filter()
Obsolete Members for QHelpIndexWidget▲
The following members of class QHelpIndexWidget are deprecated. We strongly advise against using them in new code.
Obsolete Member Function Documentation▲
void QHelpIndexWidget::linkActivated(const QUrl &link, const QString &keyword)▲
This function is deprecated. We strongly advise against using it in new code.
Use documentActivated() instead.
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 parameter.