QPdfSearchModel#

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

Synopsis#

Functions#

def document ()
def resultAtIndex (index)
def resultsOnPage (page)
def searchString ()
def updatePage (page)

Slots#

def setDocument (document)
def setSearchString (searchString)

Detailed Description#

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:

class PySide6.QtPdf.QPdfSearchModel#

PySide6.QtPdf.QPdfSearchModel(parent)

Parameters: parent – PySide6.QtCore.QObject

Constructs a new search model with parent object parent.

PySide6.QtPdf.QPdfSearchModel.Role#

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