class QHelpSearchQuery#

The QHelpSearchQuery class contains the field name and the associated search term. More…

Synopsis#

Methods#

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#

The QHelpSearchQuery class contains the field name and the associated search term. Depending on the field the search term might get split up into separate terms to be parsed differently by the search engine.

Note

This class has been deprecated in favor of QString.

See also

QHelpSearchQueryWidget

class FieldName#

This enum type specifies the field names that are handled by the search engine.

Constant

Description

QHelpSearchQuery.DEFAULT

the default field provided by the search widget, several terms should be split and stored in the word list except search terms enclosed in quotes.

QHelpSearchQuery.FUZZY

Terms should be split in separate words and passed to the search engine.

QHelpSearchQuery.WITHOUT

Terms should be split in separate words and passed to the search engine.

QHelpSearchQuery.PHRASE

Terms should not be split in separate words.

QHelpSearchQuery.ALL

Terms should be split in separate words and passed to the search engine

QHelpSearchQuery.ATLEAST

Terms should be split in separate words and passed to the search engine
PySide6.QtHelp.QHelpSearchQuery.fieldName#
PySide6.QtHelp.QHelpSearchQuery.wordList#
__init__()#

Note

This function is deprecated.

Constructs a new empty QHelpSearchQuery .

__init__(field, wordList_)
Parameters:

  • field – FieldName

  • wordList – list of strings

Note

This function is deprecated.

Constructs a new QHelpSearchQuery and initializes it with the given field and wordList.