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>

3 files changed, 14 insertions, 14 deletions

diff --git a/src/pdfwidgets/qpdfview.cpp b/src/pdfwidgets/qpdfview.cpp
index bab70c773..ce4c42469 100644
--- a/src/pdfwidgets/qpdfview.cpp
+++ b/src/pdfwidgets/qpdfview.cpp
@@ -47,7 +47,7 @@
 #include <QPainter>
 #include <QPaintEvent>
 #include <QPdfDocument>
-#include <QPdfNavigationStack>
+#include <QPdfPageNavigator>
 #include <QScreen>
 #include <QScrollBar>
 #include <QScroller>
@@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
 QPdfViewPrivate::QPdfViewPrivate(QPdfView *q)
     : q_ptr(q)
     , m_document(nullptr)
-    , m_pageNavigation(nullptr)
+    , m_pageNavigator(nullptr)
     , m_pageRenderer(nullptr)
     , m_pageMode(QPdfView::PageMode::SinglePage)
     , m_zoomMode(QPdfView::ZoomMode::Custom)
@@ -74,7 +74,7 @@ void QPdfViewPrivate::init()
 {
     Q_Q(QPdfView);
 
-    m_pageNavigation = new QPdfNavigationStack(q);
+    m_pageNavigator = new QPdfPageNavigator(q);
     m_pageRenderer = new QPdfPageRenderer(q);
     m_pageRenderer->setRenderMode(QPdfPageRenderer::RenderMode::MultiThreaded);
 }
@@ -130,7 +130,7 @@ void QPdfViewPrivate::setViewport(QRect viewport)
     if (m_pageMode == QPdfView::PageMode::MultiPage) {
         // An imaginary, 2px height line at the upper half of the viewport, which is used to
         // determine which page is currently located there -> we propagate that as 'current' page
-        // to the QPdfNavigationStack object
+        // to the QPdfPageNavigator object
         const QRect currentPageLine(m_viewport.x(), m_viewport.y() + m_viewport.height() * 0.4, m_viewport.width(), 2);
 
         int currentPage = 0;
@@ -142,10 +142,10 @@ void QPdfViewPrivate::setViewport(QRect viewport)
             }
         }
 
-        if (currentPage != m_pageNavigation->currentPage()) {
+        if (currentPage != m_pageNavigator->currentPage()) {
             m_blockPageScrolling = true;
             // ΤODO give location on the page
-            m_pageNavigation->jump(currentPage, {}, m_zoomFactor);
+            m_pageNavigator->jump(currentPage, {}, m_zoomFactor);
             m_blockPageScrolling = false;
         }
     }
@@ -216,8 +216,8 @@ QPdfViewPrivate::DocumentLayout QPdfViewPrivate::calculateDocumentLayout() const
 
     int totalWidth = 0;
 
-    const int startPage = (m_pageMode == QPdfView::PageMode::SinglePage ? m_pageNavigation->currentPage() : 0);
-    const int endPage = (m_pageMode == QPdfView::PageMode::SinglePage ? m_pageNavigation->currentPage() + 1 : pageCount);
+    const int startPage = (m_pageMode == QPdfView::PageMode::SinglePage ? m_pageNavigator->currentPage() : 0);
+    const int endPage = (m_pageMode == QPdfView::PageMode::SinglePage ? m_pageNavigator->currentPage() + 1 : pageCount);
 
     // calculate page sizes
     for (int page = startPage; page < endPage; ++page) {
@@ -307,7 +307,7 @@ QPdfView::QPdfView(QWidget *parent)
 
     d->init();
 
-    connect(d->m_pageNavigation, &QPdfNavigationStack::currentPageChanged, this,
+    connect(d->m_pageNavigator, &QPdfPageNavigator::currentPageChanged, this,
             [d](int page){ d->currentPageChanged(page); });
 
     connect(d->m_pageRenderer, &QPdfPageRenderer::pageRendered, this,
@@ -367,11 +367,11 @@ QPdfDocument *QPdfView::document() const
 /*!
     This accessor returns the navigation stack that will handle back/forward navigation.
 */
-QPdfNavigationStack *QPdfView::pageNavigation() const
+QPdfPageNavigator *QPdfView::pageNavigator() const
 {
     Q_D(const QPdfView);
 
-    return d->m_pageNavigation;
+    return d->m_pageNavigator;
 }
 
 /*!
diff --git a/src/pdfwidgets/qpdfview.h b/src/pdfwidgets/qpdfview.h
index 7571aec9a..899113294 100644
--- a/src/pdfwidgets/qpdfview.h
+++ b/src/pdfwidgets/qpdfview.h
@@ -46,7 +46,7 @@
 QT_BEGIN_NAMESPACE
 
 class QPdfDocument;
-class QPdfNavigationStack;
+class QPdfPageNavigator;
 class QPdfViewPrivate;
 
 class Q_PDF_WIDGETS_EXPORT QPdfView : public QAbstractScrollArea
@@ -85,7 +85,7 @@ public:
     void setDocument(QPdfDocument *document);
     QPdfDocument *document() const;
 
-    QPdfNavigationStack *pageNavigation() const;
+    QPdfPageNavigator *pageNavigator() const;
 
     PageMode pageMode() const;
     ZoomMode zoomMode() const;
diff --git a/src/pdfwidgets/qpdfview_p.h b/src/pdfwidgets/qpdfview_p.h
index 4e6a68581..91198e2d3 100644
--- a/src/pdfwidgets/qpdfview_p.h
+++ b/src/pdfwidgets/qpdfview_p.h
@@ -91,7 +91,7 @@ public:
 
     QPdfView *q_ptr;
     QPointer<QPdfDocument> m_document;
-    QPdfNavigationStack* m_pageNavigation;
+    QPdfPageNavigator* m_pageNavigator;
     QPdfPageRenderer *m_pageRenderer;
 
     QPdfView::PageMode m_pageMode;