PySide6.QtHelp.QHelpSearchQueryWidget

class QHelpSearchQueryWidget

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. More…

Inheritance diagram of PySide6.QtHelp.QHelpSearchQueryWidget

Synopsis

Methods

Slots

Signals

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

__init__([parent=None])
Parameters:

parent – QWidget

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()
Return type:

bool

query()
Return type:

.list of QHelpSearchQuery

Note

This function is deprecated.

Use searchInput() instead.

See also

setQuery()

search()

This signal is emitted when a the user has the search button invoked. After receiving the signal you can ask the QHelpSearchQueryWidget for the search input that you may pass to the QHelpSearchEngine::search() function.

searchInput()
Return type:

str

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

See also

setSearchInput()

setCompactMode(on)
Parameters:

on – bool

setQuery(queryList)
Parameters:

queryList – .list of QHelpSearchQuery

Note

This function is deprecated.

Use setSearchInput() instead.

See also

query()

setSearchInput(searchInput)
Parameters:

searchInput – str

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

Note

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

See also

searchInput()