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 PySide2.QtHelp.QHelpSearchQueryWidget([parent=None])

param parent:

PySide2.QtWidgets.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

setQuery()

PySide2.QtHelp.QHelpSearchQueryWidget.search()

PySide2.QtHelp.QHelpSearchQueryWidget.searchInput()

Return type:

str

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

See also

setSearchInput()

PySide2.QtHelp.QHelpSearchQueryWidget.setCompactMode(on)

Parameters:

on – bool

PySide2.QtHelp.QHelpSearchQueryWidget.setQuery(queryList)

Parameters:

queryList –

Note

This function is deprecated.

Use setSearchInput() instead.

See also

query()

PySide2.QtHelp.QHelpSearchQueryWidget.setSearchInput(searchInput)

Parameters:

searchInput – 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()