QHelpSearchResult#
The QHelpSearchResult
class provides the data associated with the search result. More…
Synopsis#
Functions#
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 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.
See also
- class PySide6.QtHelp.QHelpSearchResult#
PySide6.QtHelp.QHelpSearchResult(other)
PySide6.QtHelp.QHelpSearchResult(url, title, snippet)
- Parameters:
other –
PySide6.QtHelp.QHelpSearchResult
url –
PySide6.QtCore.QUrl
snippet – str
title – str
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.
- PySide6.QtHelp.QHelpSearchResult.snippet()#
- Return type:
str
Returns the document snippet containing the search phrase of the search result.
- PySide6.QtHelp.QHelpSearchResult.title()#
- Return type:
str
Returns the document title of the search result.
- PySide6.QtHelp.QHelpSearchResult.url()#
- Return type:
Returns the document URL of the search result.