QHelpIndexWidget#

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

Inheritance diagram of PySide6.QtHelp.QHelpIndexWidget

Synopsis#

Slots#

Signals#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

class PySide6.QtHelp.QHelpIndexWidget#
PySide6.QtHelp.QHelpIndexWidget.activateCurrentItem()#

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

PySide6.QtHelp.QHelpIndexWidget.documentActivated(document, keyword)#
Parameters:

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.

PySide6.QtHelp.QHelpIndexWidget.documentsActivated(documents, keyword)#
Parameters:

  • documents – .list of QHelpLink

  • keyword – str

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.

PySide6.QtHelp.QHelpIndexWidget.filterIndices(filter[, wildcard=""])#
Parameters:

  • filter – str

  • wildcard – str

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

See also

filter()

PySide6.QtHelp.QHelpIndexWidget.linkActivated(link, keyword)#
Parameters:

Note

This function is deprecated.

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.

PySide6.QtHelp.QHelpIndexWidget.linksActivated(links, keyword)#
Parameters:

  • links – .QMultiMapQString,QUrl

  • keyword – str

Note

This function is deprecated.