QHelpFilterData¶
The
QHelpFilterData
class provides details for the filters used byQHelpFilterEngine
. More…
New in version 5.13.
Synopsis¶
Functions¶
def
__eq__
(other)def
components
()def
setComponents
(components)def
setVersions
(versions)def
swap
(other)def
versions
()
Detailed Description¶
By using
setComponents()
you may constrain the search results to documents that belong only to components specified on the given list. By usingsetVersions()
you may constrain the search results to documents that belong only to versions specified on the given list.See also
- class PySide2.QtHelp.QHelpFilterData¶
PySide2.QtHelp.QHelpFilterData(other)
- param other:
Constructs the empty filter.
- PySide2.QtHelp.QHelpFilterData.components()¶
- Return type:
list of strings
Returns the component list that is used for filtering the search results.
See also
- PySide2.QtHelp.QHelpFilterData.__eq__(other)¶
- Parameters:
other –
PySide2.QtHelp.QHelpFilterData
- Return type:
bool
- PySide2.QtHelp.QHelpFilterData.setComponents(components)¶
- Parameters:
components – list of strings
Specifies the component list that is used for filtering the search results. Only results from components in the list
components
shall be returned.See also
- PySide2.QtHelp.QHelpFilterData.setVersions(versions)¶
- Parameters:
versions –
Specifies the version list that is used for filtering the search results. Only results from versions in the list
versions
shall be returned.See also
- PySide2.QtHelp.QHelpFilterData.swap(other)¶
- Parameters:
other –
PySide2.QtHelp.QHelpFilterData
Swaps the filter
other
with this filter. This operation is very fast and never fails.
- PySide2.QtHelp.QHelpFilterData.versions()¶
- Return type:
Returns the version list that is used for filtering the search results.
See also
© 2022 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.