summaryrefslogtreecommitdiffstats
path: root/src/pdf/doc/src/qtpdf-index.qdoc
diff options
context:
space:
mode:
authorShawn Rutledge <shawn.rutledge@qt.io>2022-04-24 10:54:05 +0200
committerShawn Rutledge <shawn.rutledge@qt.io>2022-05-27 14:20:50 +0200
commit90f43fd25ec4de4d18da40c214ddb366da5c798a (patch)
tree3cdc847db7f455134c174c02e2d5f13a07ef54de /src/pdf/doc/src/qtpdf-index.qdoc
parent567739fda232c28992962f32a9e652eab723a4d4 (diff)
Rename QPdfNavigationStack to QPdfPageNavigator; QML type too
This might reduce some confusion about the fact that the back/forward "stack" isn't strictly a stack in the data structure sense: it's more like QUndoStack. It causes a QML source incompatibility relative to Qt 5, but keeps the C++ class name the same as it has been in QtPdf for a long time. Amends 3ad445f9f24a9d3f259ed1781460a63346a728e4 [ChangeLog][QtPDF] The PdfNavigationStack QML type has been renamed to PdfPageNavigator, matching the C++ type QPdfPageNavigator. These remember navigation history within a document, and are helpful to implement back/forward buttons similar to those on a web browser in both Qt Quick and widget-based viewer applications. Change-Id: Id8dc17aa416bb7064b1f0f300a47c07c83b7f47e Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
Diffstat (limited to 'src/pdf/doc/src/qtpdf-index.qdoc')
-rw-r--r--src/pdf/doc/src/qtpdf-index.qdoc4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/pdf/doc/src/qtpdf-index.qdoc b/src/pdf/doc/src/qtpdf-index.qdoc
index a03146569..986a8011b 100644
--- a/src/pdf/doc/src/qtpdf-index.qdoc
+++ b/src/pdf/doc/src/qtpdf-index.qdoc
@@ -36,7 +36,7 @@
and renders pages from it according to the options provided by
the \l QPdfDocumentRenderOptions class. The \l QPdfPageRenderer
class manages a queue that collects all render requests. The
- \l QPdfNavigationStack class handles the navigation through a
+ \l QPdfPageNavigator class handles the navigation through a
PDF document. The \l QPdfSearchModel class searches for a string
and holds the search results. The \l QPdfView widget is a complete
PDF viewer, and the \l {PDF Viewer Example} shows how to use it.
@@ -51,7 +51,7 @@
The full-featured viewer components are composed of lower-level
QML components that can be used separately if you need to write a
more customized PDF viewing application: \l PdfDocument,
- \l PdfPageImage, \l PdfNavigationStack, \l PdfSelection,
+ \l PdfPageImage, \l PdfPageNavigator, \l PdfSelection,
\l PdfSearchModel, \l PdfLinkModel, and \l PdfBookmarkModel.
If you only need to render page images, without features such as