PySide6.QtHelp.QHelpFilterData¶

class QHelpFilterData¶

The QHelpFilterData class provides details for the filters used by QHelpFilterEngine . More…

Synopsis¶

Methods¶

def __init__()
def components()
def __eq__()
def setComponents()
def setVersions()
def swap()
def versions()

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¶

By using setComponents() you may constrain the search results to documents that belong only to components specified on the given list. By using setVersions() you may constrain the search results to documents that belong only to versions specified on the given list.

See also

QHelpFilterEngine

__init__()¶

Constructs the empty filter.

__init__(other)

Parameters:: other – QHelpFilterData

Constructs a copy of other.

components()¶

Return type:: list of strings

Returns the component list that is used for filtering the search results.

See also

setComponents()

__eq__(other)¶

Parameters:: other – QHelpFilterData
Return type:: bool

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

components()

setVersions(versions)¶

Parameters:: versions – .list of QVersionNumber

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

versions()

swap(other)¶

Parameters:: other – QHelpFilterData

Swaps the filter other with this filter. This operation is very fast and never fails.

versions()¶

Return type:: .list of QVersionNumber

Returns the version list that is used for filtering the search results.

See also

setVersions()