QHelpIndexWidget¶

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

Inheritance diagram of PySide2.QtHelp.QHelpIndexWidget

Detailed Description¶

class PySide2.QtHelp.QHelpIndexWidget¶
PySide2.QtHelp.QHelpIndexWidget.activateCurrentItem()¶

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

PySide2.QtHelp.QHelpIndexWidget.documentActivated(document, keyword)¶
Parameters:
PySide2.QtHelp.QHelpIndexWidget.documentsActivated(documents, keyword)¶
Parameters:
  • documents –

  • keyword – str

PySide2.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()

PySide2.QtHelp.QHelpIndexWidget.linkActivated(link, keyword)¶
Parameters:

Note

This function is deprecated.

PySide2.QtHelp.QHelpIndexWidget.linksActivated(links, keyword)¶
Parameters:
  • links –

  • keyword – str

Note

This function is deprecated.