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)
Detailed Description¶
-
class
QHelpSearchQueryWidget
([parent=None])¶ - param parent
QWidget
Constructs a new search query widget with the given
parent
.
-
PySide2.QtHelp.QHelpSearchQueryWidget.
collapseExtendedSearch
()¶ Collapses the search query widget so that only the default search field is shown.
-
PySide2.QtHelp.QHelpSearchQueryWidget.
expandExtendedSearch
()¶ Expands the search query widget so that the extended search fields are shown.
-
PySide2.QtHelp.QHelpSearchQueryWidget.
isCompactMode
()¶ - Return type
bool
-
PySide2.QtHelp.QHelpSearchQueryWidget.
query
()¶ - Return type
Note
This function is deprecated.
Use
searchInput()
instead.See also
-
PySide2.QtHelp.QHelpSearchQueryWidget.
search
()¶
-
PySide2.QtHelp.QHelpSearchQueryWidget.
searchInput
()¶ - Return type
unicode
Returns a search phrase to use in combination with the
search
(constQString
&) function.See also
-
PySide2.QtHelp.QHelpSearchQueryWidget.
setCompactMode
(on)¶ - Parameters
on –
bool
See also
-
PySide2.QtHelp.QHelpSearchQueryWidget.
setQuery
(queryList)¶ - Parameters
queryList –
Note
This function is deprecated.
Use
setSearchInput()
instead.See also
-
PySide2.QtHelp.QHelpSearchQueryWidget.
setSearchInput
(searchInput)¶ - Parameters
searchInput – unicode
Sets the
QHelpSearchQueryWidget
input field to the value specified bysearchInput
.Note
The
search
(constQString
&searchInput
) function has to be called to perform the actual search.See also