QHelpSearchQueryWidget

PyQt5.QtHelp.QHelpSearchQueryWidget

Inherits from QWidget.

Description

The QHelpSearchQueryWidget class provides a simple line edit or an advanced widget to enable the user to input a search term in a standardized input mask.

Methods

__init__(parent: QWidget = None)

Constructs a new search query widget with the given parent.


collapseExtendedSearch()

Collapses the search query widget so that only the default search field is shown.


expandExtendedSearch()

Expands the search query widget so that the extended search fields are shown.


isCompactMode() → bool

TODO


query() → List[QHelpSearchQuery]

TODO


searchInput() → str

Returns a search phrase to use in combination with the search()(const QString &) function.

See also

setSearchInput().


setCompactMode(bool)

See also

isCompactMode().


setQuery(Iterable[QHelpSearchQuery])

TODO


setSearchInput(str)

Sets the QHelpSearchQueryWidget input field to the value specified by searchInput.

Note: The search()(const QString &searchInput()) function has to be called to perform the actual search.

See also

searchInput().

Signals

TODO