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

Synopsis¶
Functions¶
def
createIndex
(customFilterName)def
filter
(filter[, wildcard=””])def
isCreatingIndex
()def
linksForKeyword
(keyword)
Signals¶
def
indexCreated
()def
indexCreationStarted
()
Detailed Description¶
-
PySide2.QtHelp.QHelpIndexModel.
createIndex
(customFilterName)¶ - Parameters
customFilterName – unicode
Creates a new index by querying the help system for keywords for the specified
customFilterName
.
-
PySide2.QtHelp.QHelpIndexModel.
filter
(filter[, wildcard=""])¶ - Parameters
filter – unicode
wildcard – unicode
- 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, ifwildcard
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, thefilter
string is used to search for the best match.
-
PySide2.QtHelp.QHelpIndexModel.
indexCreated
()¶
-
PySide2.QtHelp.QHelpIndexModel.
indexCreationStarted
()¶
-
PySide2.QtHelp.QHelpIndexModel.
isCreatingIndex
()¶ - Return type
bool
Returns true if the index is currently built up, otherwise false.
-
PySide2.QtHelp.QHelpIndexModel.
linksForKeyword
(keyword)¶ - Parameters
keyword – unicode
- Return type
Use
linksForKeyword()
instead.