PySide6.QtHelp.QHelpIndexModel¶

class QHelpIndexModel¶

The QHelpIndexModel class provides a model that supplies index keywords to views. More…

Synopsis¶

Methods¶

def createIndex()
def createIndexForCurrentFilter()
def filter()
def helpEngine()
def isCreatingIndex()

Signals¶

def indexCreated()
def indexCreationStarted()

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¶

createIndex(customFilterName)¶

Parameters:: customFilterName – str

Creates a new index by querying the help system for keywords for the specified custom filter name.

createIndexForCurrentFilter()¶

Creates a new index by querying the help system for keywords for the current filter.

filter(filter[, wildcard={}])¶

Parameters:

filter – str
wildcard – str

Return type:

QModelIndex

Filters the indices and returns the model index of the best matching keyword. In a first step, only the keywords containing filter are kept in the model’s index list. Analogously, if wildcard is not empty, only the keywords matched are left in the index list. In a second step, the best match is determined and its index model returned. When specifying a wildcard expression, the filter string is used to search for the best match.

helpEngine()¶

Return type:: QHelpEngineCore

Returns the associated help engine that manages this model.

indexCreated()¶

This signal is emitted when the index has been created.

indexCreationStarted()¶

This signal is emitted when the creation of a new index has started. The current index is invalid from this point on until the signal indexCreated() is emitted.

See also

isCreatingIndex()

isCreatingIndex()¶

Return type:: bool

Returns true if the index is currently built up, otherwise false.