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…
Synopsis#
Functions#
def
collapseExtendedSearch
()def
expandExtendedSearch
()def
isCompactMode
()def
query
()def
searchInput
()def
setCompactMode
(on)def
setQuery
(queryList)def
setSearchInput
(searchInput)
Signals#
def
search
()
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#
- class PySide6.QtHelp.QHelpSearchQueryWidget([parent=None])#
- Parameters:
parent –
PySide6.QtWidgets.QWidget
Constructs a new search query widget with the given parent
.
- PySide6.QtHelp.QHelpSearchQueryWidget.collapseExtendedSearch()#
Collapses the search query widget so that only the default search field is shown.
- PySide6.QtHelp.QHelpSearchQueryWidget.expandExtendedSearch()#
Expands the search query widget so that the extended search fields are shown.
- PySide6.QtHelp.QHelpSearchQueryWidget.isCompactMode()#
- Return type:
bool
- PySide6.QtHelp.QHelpSearchQueryWidget.query()#
- Return type:
.list of QHelpSearchQuery
Note
This function is deprecated.
Use searchInput()
instead.
See also
- PySide6.QtHelp.QHelpSearchQueryWidget.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.
- PySide6.QtHelp.QHelpSearchQueryWidget.searchInput()#
- Return type:
str
Returns a search phrase to use in combination with the QHelpSearchEngine::search(const QString &searchInput) function.
See also
- PySide6.QtHelp.QHelpSearchQueryWidget.setCompactMode(on)#
- Parameters:
on – bool
- PySide6.QtHelp.QHelpSearchQueryWidget.setQuery(queryList)#
- Parameters:
queryList – .list of QHelpSearchQuery
Note
This function is deprecated.
Use setSearchInput()
instead.
See also
- PySide6.QtHelp.QHelpSearchQueryWidget.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