summaryrefslogtreecommitdiffstats
path: root/docshell/shistory/nsIGroupedSHistory.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/nsIGroupedSHistory.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/nsIGroupedSHistory.idl')
-rw-r--r--docshell/shistory/nsIGroupedSHistory.idl47
1 files changed, 47 insertions, 0 deletions
diff --git a/docshell/shistory/nsIGroupedSHistory.idl b/docshell/shistory/nsIGroupedSHistory.idl
new file mode 100644
index 000000000..4001dcc34
--- /dev/null
+++ b/docshell/shistory/nsIGroupedSHistory.idl
@@ -0,0 +1,47 @@
+/* -*- 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;
+interface nsIPartialSHistory;
+
+/**
+ * nsIGroupedSHistory represent a combined session history across multiple
+ * root docshells (usually browser tabs). The participating nsISHistory can
+ * either be in chrome process or in content process, but nsIGroupedSHistory
+ * itself lives in chrome process. The communication is proxyed through
+ * nsIPartialSHistory.
+ */
+[scriptable, builtinclass, uuid(813e498d-73a8-449a-be09-6187e62c5352)]
+interface nsIGroupedSHistory : nsISupports
+{
+ // The total number of entries of all its partial session histories.
+ [infallible] readonly attribute unsigned long count;
+
+ /**
+ * Remove all partial histories after currently active one (if any) and then
+ * append the given partial session history to the end of the list.
+ */
+ void appendPartialSessionHistory(in nsIPartialSHistory aPartialHistory);
+
+ /**
+ * Notify the grouped session history that the active partial session history
+ * has been modified. All partial session histories after the active one
+ * will be removed and destroy.
+ */
+ void onPartialSessionHistoryChange(in nsIPartialSHistory aPartialHistory);
+
+ /**
+ * Find the proper partial session history and navigate to the entry
+ * corresponding to the given global index. Note it doesn't swap frameloaders,
+ * but rather return the target loader for the caller to swap.
+ *
+ * @param aGlobalIndex The global index to navigate to.
+ * @param aTargetLoaderToSwap The owner frameloader of the to-be-navigate
+ * partial session history.
+ */
+ void gotoIndex(in unsigned long aGlobalIndex, out nsIFrameLoader aTargetLoaderToSwap);
+};