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

Synopsis¶
Functions¶
def
createIndex
(customFilterName)def
filter
(filter[, wildcard=””])def
helpEngine
()def
isCreatingIndex
()def
linksForKeyword
(keyword)
Signals¶
def
indexCreated
()def
indexCreationStarted
()
Detailed Description¶
-
class
PySide2.QtHelp.
QHelpIndexModel
¶
-
PySide2.QtHelp.QHelpIndexModel.
createIndex
(customFilterName)¶ - Parameters
customFilterName – str
Creates a new index by querying the help system for keywords for the specified
customFilterName
.
-
PySide2.QtHelp.QHelpIndexModel.
filter
(filter[, wildcard=""])¶ - Parameters
filter – str
wildcard – str
- Return type
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.
helpEngine
()¶ - Return type
Returns the associated help engine that manages this model.
-
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 – str
- Return type
Note
This function is deprecated.
Use
documentsForKeyword()
instead.
© 2020 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.