summaryrefslogtreecommitdiffstats
path: root/docshell/shistory/nsIPartialSHistory.idl
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /docshell/shistory/nsIPartialSHistory.idl
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'docshell/shistory/nsIPartialSHistory.idl')
-rw-r--r--docshell/shistory/nsIPartialSHistory.idl62
1 files changed, 62 insertions, 0 deletions
diff --git a/docshell/shistory/nsIPartialSHistory.idl b/docshell/shistory/nsIPartialSHistory.idl
new file mode 100644
index 000000000..99359794e
--- /dev/null
+++ b/docshell/shistory/nsIPartialSHistory.idl
@@ -0,0 +1,62 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsISupports.idl"
+
+interface nsIFrameLoader;
+
+/**
+ * nsIPartialSHistory represents a part of nsIGroupedSHistory. It associates to
+ * a "partial" nsISHistory in either local or remote process.
+ */
+[scriptable, builtinclass, uuid(5cd75e28-838c-4a0a-972e-6005f736ef7a)]
+interface nsIPartialSHistory : nsISupports
+{
+ // The number of entries of its corresponding nsISHistory.
+ [infallible] readonly attribute unsigned long count;
+
+ // If it's part of a grouped session history, globalIndexOffset denotes the
+ // number of entries ahead.
+ [infallible] readonly attribute unsigned long globalIndexOffset;
+
+ // The frameloader which owns this partial session history.
+ readonly attribute nsIFrameLoader ownerFrameLoader;
+
+ /**
+ * Notify that it's been added to a grouped session history. It also implies
+ * it's becoming the active partial history of the group.
+ *
+ * @param aOffset The number of entries in preceding partial
+ * session histories.
+ */
+ void onAttachGroupedSessionHistory(in unsigned long aOffset);
+
+ /**
+ * Notify that one or more entries in its associated nsISHistory object
+ * have been changed (i.e. add / remove / replace). It's mainly used for
+ * cross-process case, since in the in-process case we can just register an
+ * nsISHistoryListener instead.
+ *
+ * @param aCount The number of entries in the associated session history.
+ * It can be the same as the old value if entries were replaced.
+ */
+ void onSessionHistoryChange(in unsigned long aCount);
+
+ /**
+ * Notify that the partial session history has been swapped in as the active
+ * session history. Only an active session history can possibly add / remove /
+ * replace its history entries.
+ *
+ * @param aGlobalLength The up-to-date global length.
+ * @param aTargetLocalIndex The local index to navigate to.
+ */
+ void onActive(in unsigned long aGlobalLength, in unsigned long aTargetLocalIndex);
+
+ /**
+ * Notify that the partial session history has been swapped out and is no
+ * longer active.
+ */
+ void onDeactive();
+};