summaryrefslogtreecommitdiffstats
path: root/src/pdf/quick/qquickpdfnavigationstack.cpp
blob: c19fae7357ba47b0735f310d59b000643f575764 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtPDF module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qquickpdfnavigationstack_p.h"
#include <QLoggingCategory>

QT_BEGIN_NAMESPACE

Q_LOGGING_CATEGORY(qLcNav, "qt.pdf.navigationstack")

/*!
    \qmltype PdfNavigationStack
    \instantiates QQuickPdfNavigationStack
    \inqmlmodule QtQuick.Pdf
    \ingroup pdf
    \brief History of the pages visited within a PDF Document.
    \since 5.15

    PdfNavigationStack remembers which pages the user has visited in a PDF
    document, and provides the ability to traverse backward and forward.
*/

QQuickPdfNavigationStack::QQuickPdfNavigationStack(QObject *parent)
    : QObject(parent)
{
}

/*!
    \qmlmethod void PdfNavigationStack::forward()

    Goes back to the page that was being viewed before back() was called, and
    then emits the \l currentPageJumped() signal.

    If \l currentPage was set by assignment or binding since the last time
    \l back() was called, the forward() function does nothing, because there is
    a branch in the timeline which causes the "future" to be lost.
*/
void QQuickPdfNavigationStack::forward()
{
    if (m_nextHistoryIndex >= m_pageHistory.count())
        return;
    bool backAvailableWas = backAvailable();
    bool forwardAvailableWas = forwardAvailable();
    m_changing = true;
    setCurrentPage(m_pageHistory.at(++m_nextHistoryIndex));
    m_changing = false;
    emit currentPageJumped(m_currentPage);
    if (backAvailableWas != backAvailable())
        emit backAvailableChanged();
    if (forwardAvailableWas != forwardAvailable())
        emit forwardAvailableChanged();
}

/*!
    \qmlmethod void PdfNavigationStack::back()

    Pops the stack and causes the \l currentPage property to change to the
    most-recently-viewed page, and then emits the \l currentPageJumped()
    signal.
*/
void QQuickPdfNavigationStack::back()
{
    if (m_nextHistoryIndex <= 0)
        return;
    bool backAvailableWas = backAvailable();
    bool forwardAvailableWas = forwardAvailable();
    m_changing = true;
    // TODO don't do that when going back after going forward
    m_pageHistory.append(m_currentPage);
    setCurrentPage(m_pageHistory.at(--m_nextHistoryIndex));
    m_changing = false;
    emit currentPageJumped(m_currentPage);
    if (backAvailableWas != backAvailable())
        emit backAvailableChanged();
    if (forwardAvailableWas != forwardAvailable())
        emit forwardAvailableChanged();
}

/*!
    \qmlproperty int PdfNavigationStack::currentPage

    This property holds the current page that is being viewed.

    It should be set when the viewer's current page changes. Every time this
    property is set, it pushes the current page number onto the stack, such
    that the history of pages that have been viewed will grow.
*/
void QQuickPdfNavigationStack::setCurrentPage(int currentPage)
{
    if (m_currentPage == currentPage)
        return;
    bool backAvailableWas = backAvailable();
    bool forwardAvailableWas = forwardAvailable();
    if (!m_changing) {
        if (m_nextHistoryIndex >= 0 && m_nextHistoryIndex < m_pageHistory.count())
            m_pageHistory.remove(m_nextHistoryIndex, m_pageHistory.count() - m_nextHistoryIndex);
        m_pageHistory.append(m_currentPage);
        m_nextHistoryIndex = m_pageHistory.count();
    }
    m_currentPage = currentPage;
    emit currentPageChanged();
    if (backAvailableWas != backAvailable())
        emit backAvailableChanged();
    if (forwardAvailableWas != forwardAvailable())
        emit forwardAvailableChanged();
    qCDebug(qLcNav) << "current" << m_currentPage << "history" << m_pageHistory;
}

bool QQuickPdfNavigationStack::backAvailable() const
{
    return m_nextHistoryIndex > 0;
}

bool QQuickPdfNavigationStack::forwardAvailable() const
{
    return m_nextHistoryIndex < m_pageHistory.count();
}

/*!
    \qmlsignal PdfNavigationStack::currentPageJumped(int page)

    This signal is emitted when either forward() or back() is called, to
    distinguish navigational jumps from cases when the \l currentPage property
    is set by means of a binding or assignment. Contrast with the
    \c currentPageChanged signal, which is emitted in all cases, and does not
    include the \c page argument.
*/

QT_END_NAMESPACE