qwebenginehistory.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. /****************************************************************************
  2. **
  3. ** Copyright (C) 2016 The Qt Company Ltd.
  4. ** Contact: https://www.qt.io/licensing/
  5. **
  6. ** This file is part of the QtWebEngine module of the Qt Toolkit.
  7. **
  8. ** $QT_BEGIN_LICENSE:LGPL$
  9. ** Commercial License Usage
  10. ** Licensees holding valid commercial Qt licenses may use this file in
  11. ** accordance with the commercial license agreement provided with the
  12. ** Software or, alternatively, in accordance with the terms contained in
  13. ** a written agreement between you and The Qt Company. For licensing terms
  14. ** and conditions see https://www.qt.io/terms-conditions. For further
  15. ** information use the contact form at https://www.qt.io/contact-us.
  16. **
  17. ** GNU Lesser General Public License Usage
  18. ** Alternatively, this file may be used under the terms of the GNU Lesser
  19. ** General Public License version 3 as published by the Free Software
  20. ** Foundation and appearing in the file LICENSE.LGPL3 included in the
  21. ** packaging of this file. Please review the following information to
  22. ** ensure the GNU Lesser General Public License version 3 requirements
  23. ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
  24. **
  25. ** GNU General Public License Usage
  26. ** Alternatively, this file may be used under the terms of the GNU
  27. ** General Public License version 2.0 or (at your option) the GNU General
  28. ** Public license version 3 or any later version approved by the KDE Free
  29. ** Qt Foundation. The licenses are as published by the Free Software
  30. ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
  31. ** included in the packaging of this file. Please review the following
  32. ** information to ensure the GNU General Public License requirements will
  33. ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
  34. ** https://www.gnu.org/licenses/gpl-3.0.html.
  35. **
  36. ** $QT_END_LICENSE$
  37. **
  38. ****************************************************************************/
  39. #ifndef QWEBENGINEHISTORY_H
  40. #define QWEBENGINEHISTORY_H
  41. #include <QtCore/qurl.h>
  42. #include <QtCore/qstring.h>
  43. #include <QtCore/qdatetime.h>
  44. #include <QtCore/qshareddata.h>
  45. #include <QtGui/qicon.h>
  46. #include <QtWebEngineWidgets/qtwebenginewidgetsglobal.h>
  47. QT_BEGIN_NAMESPACE
  48. class QWebEngineHistory;
  49. class QWebEngineHistoryItemPrivate;
  50. class QWebEnginePage;
  51. class QWebEnginePagePrivate;
  52. class QWEBENGINEWIDGETS_EXPORT QWebEngineHistoryItem {
  53. public:
  54. QWebEngineHistoryItem(const QWebEngineHistoryItem &other);
  55. QWebEngineHistoryItem &operator=(const QWebEngineHistoryItem &other);
  56. ~QWebEngineHistoryItem();
  57. QUrl originalUrl() const;
  58. QUrl url() const;
  59. QString title() const;
  60. QDateTime lastVisited() const;
  61. QUrl iconUrl() const;
  62. bool isValid() const;
  63. void swap(QWebEngineHistoryItem &other) Q_DECL_NOTHROW { qSwap(d, other.d); }
  64. private:
  65. QWebEngineHistoryItem(QWebEngineHistoryItemPrivate *priv);
  66. Q_DECLARE_PRIVATE_D(d.data(), QWebEngineHistoryItem)
  67. QExplicitlySharedDataPointer<QWebEngineHistoryItemPrivate> d;
  68. friend class QWebEngineHistory;
  69. friend class QWebEngineHistoryPrivate;
  70. };
  71. #if QT_VERSION >= QT_VERSION_CHECK(5,6,0)
  72. Q_DECLARE_SHARED_NOT_MOVABLE_UNTIL_QT6(QWebEngineHistoryItem)
  73. #endif
  74. class QWebEngineHistoryPrivate;
  75. class QWEBENGINEWIDGETS_EXPORT QWebEngineHistory {
  76. public:
  77. void clear();
  78. QList<QWebEngineHistoryItem> items() const;
  79. QList<QWebEngineHistoryItem> backItems(int maxItems) const;
  80. QList<QWebEngineHistoryItem> forwardItems(int maxItems) const;
  81. bool canGoBack() const;
  82. bool canGoForward() const;
  83. void back();
  84. void forward();
  85. void goToItem(const QWebEngineHistoryItem &item);
  86. QWebEngineHistoryItem backItem() const;
  87. QWebEngineHistoryItem currentItem() const;
  88. QWebEngineHistoryItem forwardItem() const;
  89. QWebEngineHistoryItem itemAt(int i) const;
  90. int currentItemIndex() const;
  91. int count() const;
  92. private:
  93. QWebEngineHistory(QWebEngineHistoryPrivate *d);
  94. ~QWebEngineHistory();
  95. Q_DISABLE_COPY(QWebEngineHistory)
  96. Q_DECLARE_PRIVATE(QWebEngineHistory)
  97. QScopedPointer<QWebEngineHistoryPrivate> d_ptr;
  98. friend QWEBENGINEWIDGETS_EXPORT QDataStream& operator>>(QDataStream&, QWebEngineHistory&);
  99. friend QWEBENGINEWIDGETS_EXPORT QDataStream& operator<<(QDataStream&, const QWebEngineHistory&);
  100. friend class QWebEnginePage;
  101. friend class QWebEnginePagePrivate;
  102. };
  103. QWEBENGINEWIDGETS_EXPORT QDataStream& operator<<(QDataStream& stream, const QWebEngineHistory& history);
  104. QWEBENGINEWIDGETS_EXPORT QDataStream& operator>>(QDataStream& stream, QWebEngineHistory& history);
  105. QT_END_NAMESPACE
  106. #endif // QWEBENGINEHISTORY_H