QHelpSearchResult

The QHelpSearchResult class provides the data associated with the search result. More

Inheritance diagram of PySide2.QtHelp.QHelpSearchResult

Synopsis

Functions

Detailed Description

The QHelpSearchResult object is a data object that describes a single search result. The vector of search result objects is returned by searchResults() . The description of the search result contains the document title and URL that the search input matched. It also contains the snippet from the document content containing the best match of the search input.

class PySide2.QtHelp.QHelpSearchResult

PySide2.QtHelp.QHelpSearchResult(other)

PySide2.QtHelp.QHelpSearchResult(url, title, snippet)

param url

PySide2.QtCore.QUrl

param title

str

param snippet

str

param other

PySide2.QtHelp.QHelpSearchResult

Constructs a new empty QHelpSearchResult .

Constructs a copy of other .

Constructs the search result containing url , title and snippet as the description of the result.

PySide2.QtHelp.QHelpSearchResult.snippet()
Return type

str

Returns the document snippet containing the search phrase of the search result.

PySide2.QtHelp.QHelpSearchResult.title()
Return type

str

Returns the document title of the search result.

PySide2.QtHelp.QHelpSearchResult.url()
Return type

PySide2.QtCore.QUrl

Returns the document URL of the search result.