PySide6.QtPdf.QPdfSearchModel

class QPdfSearchModel

The QPdfSearchModel class searches for a string in a PDF document and holds the results.

Details

This is used in the Model/View Programming paradigm to display a list of search results, to highlight them on the rendered PDF pages, and to iterate through them using the “search forward” / “search backward” buttons and shortcuts that would be found in a typical document-viewing UI:

Synopsis

Properties

• countᅟ - The number of search results found

• documentᅟ - The document to search

• searchStringᅟ - The string to search for

• statusᅟ - The search status

Methods

• def __init__()

• def count()

• def document()

• def resultAtIndex()

• def resultsOnPage()

• def searchString()

• def status()

• def updatePage()

Slots

• def setDocument()

• def setSearchString()

Signals

• def countChanged()

• def documentChanged()

• def searchStringChanged()

• def statusChanged()

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

class Role

Constant	Description
QPdfSearchModel.Role.Role.Page	The page number where the search result is found (int).
QPdfSearchModel.Role.Role.IndexOnPage	The index of the search result on the page (int).
QPdfSearchModel.Role.Role.Location	The position of the search result on the page (QPointF).
QPdfSearchModel.Role.Role.ContextBefore	The adjacent text on the page, before the search string (QString).
QPdfSearchModel.Role.Role.ContextAfter	The adjacent text on the page, after the search string (QString).

See also

QPdfLink

class Status

This enum describes the current status of the search model.

Constant	Description
QPdfSearchModel.Status.Status.Null	The initial status before the first search has begun.
QPdfSearchModel.Status.Status.Searching	The status while the search is being conducted.
QPdfSearchModel.Status.Status.Finished	The status when all possible search results have been found on all pages.

See also

status()

Added in version 6.12.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property countᅟ: int

This property holds the number of search results found.

Access functions:

• count()

• Signal countChanged()

property documentᅟ: QPdfDocument

This property holds the document to search.

Access functions:

• document()

• setDocument()

• Signal documentChanged()

property searchStringᅟ: str

This property holds the string to search for.

Access functions:

• searchString()

• setSearchString()

• Signal searchStringChanged()

property statusᅟ: QPdfSearchModel.Status

This property holds the search status.

This property tells whether a search is in progress.

See also

count()

Access functions:

• status()

• Signal statusChanged()

__init__()

__init__(parent)

Parameters:

parent – QObject

Constructs a new search model with parent object parent.

count()

Return type:

int

Getter of property countᅟ .

countChanged()

Notification signal of property countᅟ .

document()

Return type:

QPdfDocument

See also

setDocument()

Getter of property documentᅟ .

documentChanged()

Notification signal of property documentᅟ .

resultAtIndex(index)

Parameters:

index – int

Return type:

QPdfLink

Returns a result found by index in the document() , regardless of the page on which it was found. index must be less than rowCount() .

resultsOnPage(page)

Parameters:

page – int

Return type:

.list of QPdfLink

Returns the list of all results found on the given page.

searchString()

Return type:

str

See also

setSearchString()

Getter of property searchStringᅟ .

searchStringChanged()

Notification signal of property searchStringᅟ .

setDocument(document)

Parameters:

document – QPdfDocument

See also

document()

Setter of property documentᅟ .

setSearchString(searchString)

Parameters:

searchString – str

See also

searchString()

Setter of property searchStringᅟ .

status()

Return type:

Status

Getter of property statusᅟ .

statusChanged(status)

Parameters:

status – Status

Notification signal of property statusᅟ .

updatePage(page)

Parameters:

page – int