PdfSearchModel QML Type
A representation of text search results within a PDF Document. More...
| Import Statement: | import QtQuick.Pdf 5.15 |
| Since: | Qt 5.15 |
Properties
- currentPage : int
- currentPageBoundingPolygons : list<list<point>>
- currentResult : int
- currentResultBoundingPolygons : list<list<point>>
- currentResultBoundingRect : point
- searchString : string
Detailed Description
PdfSearchModel provides the ability to search for text strings within a document and get the geometric locations of matches on each page.
Property Documentation
A set of paths in a form that can be bound to the paths property of a PathMultiline instance to render a batch of rectangles around all the regions where search results are found on currentPage:
PdfDocument {
id: doc
}
PdfSearchModel {
id: searchModel
document: doc
}
Shape {
ShapePath {
PathMultiline {
paths: searchModel.matchGeometry(view.currentPage)
}
}
}
See also PathMultiline.
The result index on currentPage for which currentResultBoundingPolygons should provide the regions to highlight.
A set of paths in a form that can be bound to the paths property of a PathMultiline instance to render a batch of rectangles around the regions comprising the search result currentResult on currentPage. This is normally used to highlight one search result at a time, in a UI that allows stepping through the results:
PdfDocument {
id: doc
}
PdfSearchModel {
id: searchModel
document: doc
currentPage: view.currentPage
currentResult: ...
}
Shape {
ShapePath {
PathMultiline {
paths: searchModel.currentResultBoundingPolygons
}
}
}
See also PathMultiline.
The bounding box containing all currentResultBoundingPolygons.
When this property changes, a scrollable view should automatically scroll itself in such a way as to ensure that this region is visible; for example, it could try to position the upper-left corner near the upper-left of its own viewport, subject to the constraints of the scrollable area.