QHelpFilterSettingsWidget

The QHelpFilterSettingsWidget class provides a widget that allows for creating, editing and removing filters. More…

New in version 5.15.

Synopsis

Functions

• def applySettings (filterEngine)

• def readSettings (filterEngine)

• def setAvailableComponents (components)

• def setAvailableVersions (versions)

Detailed Description

The instance of QHelpFilterSettingsWidget may be a part of a preferences dialog. Before showing the dialog, setAvailableComponents() and setAvailableVersions() should be called, otherwise the filter settings widget will only offer a creation of empty filters, which wouldn’t be useful. In addition, readSettings should also be called to fill up the filter settings widget with the list of filters already stored in the filter engine. The creation of new filters, modifications to existing filters and removal of unneeded filters are handled by the widget automatically. If you want to store the current state of the widget and apply it to the filter engine e.g. after the user clicked the apply button - call applySettings() .

class PySide6.QtHelp.QHelpFilterSettingsWidget([parent=None])

Parameters

parent – PySide6.QtWidgets.QWidget

Constructs a filter settings widget with parent as parent widget.

PySide6.QtHelp.QHelpFilterSettingsWidget.applySettings(filterEngine)

Parameters

filterEngine – PySide6.QtHelp.QHelpFilterEngine

Return type

bool

Writes the filter settings, currently presented in this filter settings widget, to the filterEngine. The old settings stored in the filter engine will be overwritten. Returns true on success.

PySide6.QtHelp.QHelpFilterSettingsWidget.readSettings(filterEngine)

Parameters

filterEngine – PySide6.QtHelp.QHelpFilterEngine

Reads the filter settings stored inside filterEngine and sets up this filter settings widget accordingly.

PySide6.QtHelp.QHelpFilterSettingsWidget.setAvailableComponents(components)

Parameters

components – list of strings

Sets the list of all available components to components.

See also

availableComponents()

PySide6.QtHelp.QHelpFilterSettingsWidget.setAvailableVersions(versions)

Parameters

versions –

Sets the list of all available version numbers to versions.

See also

availableVersions()