QHelpFilterData#

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

New in version 5.13.

Synopsis#

Functions#

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.

class PySide6.QtHelp.QHelpFilterData#

PySide6.QtHelp.QHelpFilterData(other)

Parameters

otherPySide6.QtHelp.QHelpFilterData

Constructs the empty filter.

Constructs a copy of other.

PySide6.QtHelp.QHelpFilterData.components()#
Return type

list of strings

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

See also

setComponents()

PySide6.QtHelp.QHelpFilterData.__eq__(other)#
Parameters

otherPySide6.QtHelp.QHelpFilterData

Return type

bool

PySide6.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

components()

PySide6.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

versions()

PySide6.QtHelp.QHelpFilterData.swap(other)#
Parameters

otherPySide6.QtHelp.QHelpFilterData

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

PySide6.QtHelp.QHelpFilterData.versions()#
Return type

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

See also

setVersions()