The QHelpFilterSettingsWidget class provides a widget that allows for creating, editing and removing filters. More...
| Header: | #include <QHelpFilterSettingsWidget> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake: | QT += help |
| Since: | Qt 5.15 |
| Inherits: | QWidget |
| QHelpFilterSettingsWidget(QWidget *parent = nullptr) | |
| virtual | ~QHelpFilterSettingsWidget() |
| bool | applySettings(QHelpFilterEngine *filterEngine) const |
| void | readSettings(const QHelpFilterEngine *filterEngine) |
| void | setAvailableComponents(const QStringList &components) |
| void | setAvailableVersions(const QList<QVersionNumber> &versions) |
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().
Constructs a filter settings widget with parent as parent widget.
[virtual] QHelpFilterSettingsWidget::~QHelpFilterSettingsWidget()Destroys the filter settings widget.
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.
Reads the filter settings stored inside filterEngine and sets up this filter settings widget accordingly.
Sets the list of all available components to components.
See also QHelpFilterEngine::availableComponents().
Sets the list of all available version numbers to versions.
See also QHelpFilterEngine::availableVersions().
As part of the free Business evaluation, we offer a free welcome call for companies, to talk about your requirements, and how the Felgo SDK & Services can help you. Just sign up and schedule your call.
Sign up now to start your free Business evaluation:
