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
()
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
Note
This function is deprecated.
Use searchInput()
instead.
See also
- PySide6.QtHelp.QHelpSearchQueryWidget.search()¶
- PySide6.QtHelp.QHelpSearchQueryWidget.searchInput()¶
- Return type
str
Returns a search phrase to use in combination with the (const QString
&) function.
See also
- PySide6.QtHelp.QHelpSearchQueryWidget.setCompactMode(on)¶
- Parameters
on – bool
- PySide6.QtHelp.QHelpSearchQueryWidget.setQuery(queryList)¶
- Parameters
queryList –
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 (const QString
& searchInput
) function has to be called to perform the actual search.
See also