PySide6.QtHelp.QHelpSearchResult

class QHelpSearchResult

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

Synopsis

Methods

• def __init__()

• def snippet()

• def title()

• def url()

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

QHelpSearchEngine

__init__()

Constructs a new empty QHelpSearchResult .

__init__(other)

Parameters:

other – QHelpSearchResult

Constructs a copy of other.

__init__(url, title, snippet)

Parameters:

• url – QUrl

• title – str

• snippet – str

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

snippet()

Return type:

str

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

title()

Return type:

str

Returns the document title of the search result.

url()

Return type:

QUrl

Returns the document URL of the search result.