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

Detailed Description¶
The
QHelpSearchResult
object is a data object that describes a single search result. The vector of search result objects is returned bysearchResults()
. 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.See also
-
class
QHelpSearchResult
¶ QHelpSearchResult(other)
QHelpSearchResult(url, title, snippet)
- param url
QUrl
- param title
unicode
- param snippet
unicode
- param other
Constructs a new empty
QHelpSearchResult
.Constructs a copy of
other
.Constructs the search result containing
url
,title
andsnippet
as the description of the result.
-
PySide2.QtHelp.QHelpSearchResult.
snippet
()¶ - Return type
unicode
Returns the document snippet containing the search phrase of the search result.
-
PySide2.QtHelp.QHelpSearchResult.
title
()¶ - Return type
unicode
Returns the document title of the search result.
-
PySide2.QtHelp.QHelpSearchResult.
url
()¶ - Return type
QUrl
Returns the document URL of the search result.