From c8fb9e99fd2a60cf17b978ae27a1ebcfb0bd5dd8 Mon Sep 17 00:00:00 2001
From: "radha%netscape.com" <radha%netscape.com>
Date: Wed, 28 Mar 2001 03:31:13 +0000
Subject: [PATCH] Initial checkin for new SH interfaces

---
 .../shistory/public/nsIHistoryEntry.idl       | 61 +++++++++++++++++++
 .../shistory/public/nsISHistoryInternal.idl   | 59 ++++++++++++++++++
 2 files changed, 120 insertions(+)
 create mode 100644 xpfe/components/shistory/public/nsIHistoryEntry.idl
 create mode 100644 xpfe/components/shistory/public/nsISHistoryInternal.idl

diff --git a/xpfe/components/shistory/public/nsIHistoryEntry.idl b/xpfe/components/shistory/public/nsIHistoryEntry.idl
new file mode 100644
index 000000000000..fa272724f272
--- /dev/null
+++ b/xpfe/components/shistory/public/nsIHistoryEntry.idl
@@ -0,0 +1,61 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public
+ * License Version 1.1 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the License is distributed on an "AS
+ * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+ * implied. See the License for the specific language governing
+ * rights and limitations under the License.
+ *
+ * The Original Code is mozilla.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): 
+ *   Radha Kulkarni <radha@netscape.com>
+ */
+
+/**
+ * The interface to nsIHistoryEntry. Each document or subframe in 
+ * Session History will have a nsIHistoryEntry associated with it which will
+ * hold only public information like URI and title for that document.
+ * More information like post data layout data are held in the private 
+ * interface nsISHEntry
+ * @status FROZEN
+ * @version 1.0
+ */
+#include "nsISupports.idl"
+#include "nsIURI.idl"
+
+[scriptable, uuid(A41661D4-1417-11D5-9882-00C04FA02F40)]
+interface nsIHistoryEntry : nsISupports 
+{
+
+/** URI for the document */
+readonly attribute nsIURI URI;
+
+/** Title for the document */
+readonly attribute wstring title;
+
+/** Flag that indicates if the entry is for a subframe navigation */
+readonly attribute boolean isSubFrame;
+
+};
+
+
+%{ C++
+// {A41661D5-1417-11D5-9882-00C04FA02F40}
+#define NS_HISTORYENTRY_CID \
+{0xa41661d5, 0x1417, 0x11d5, {0x98, 0x82, 0x0, 0xc0, 0x4f, 0xa0, 0x2f, 0x40}}
+
+#define NS_HISTORYENTRY_CONTRACTID \
+    "@mozilla.org/browser/history-entry;1"
+
+%}
+
diff --git a/xpfe/components/shistory/public/nsISHistoryInternal.idl b/xpfe/components/shistory/public/nsISHistoryInternal.idl
new file mode 100644
index 000000000000..b1bccb23aca5
--- /dev/null
+++ b/xpfe/components/shistory/public/nsISHistoryInternal.idl
@@ -0,0 +1,59 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public
+ * License Version 1.1 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the License is distributed on an "AS
+ * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+ * implied. See the License for the specific language governing
+ * rights and limitations under the License.
+ *
+ * The Original Code is mozilla.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1999 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): Radha Kulkarni (radha@netscape.com)
+ */
+ 
+#include "nsISupports.idl"
+#include "nsIFactory.idl"
+#include "nsISHEntry.idl"
+#include "nsISHTransaction.idl"
+#include "nsIDocShell.idl"
+
+
+%{C++
+#define NS_SHISTORY_INTERNAL_CID \
+{0xdd335422, 0xb8b8, 0x11d3, {0xbd, 0xc8, 0x00, 0x50, 0x04, 0x0a, 0x9b, 0x44}}
+
+#define NS_SHISTORY_INTERNAL_CONTRACTID "@mozilla.org/browser/shistory-internal;1"
+%}
+
+[scriptable, uuid(DD335421-B8B8-11d3-BDC8-0050040A9B44)]
+interface nsISHistoryInternal: nsISupports
+{
+  /**
+   * Add a new Entry to the History List
+   * @param aEntry - The entry to add
+   * @param aPersist - If true this specifies that the entry should persist
+   * in the list.  If false, this means that when new entries are added
+   * this element will not appear in the session history list.
+   */
+   void  addEntry(in nsISHEntry aEntry, in boolean aPersist);
+
+  /**
+   * Get the root transaction
+   */
+   readonly attribute nsISHTransaction rootTransaction;
+
+  /**
+   * The toplevel docshell object to which this SHistory object belongs to.
+   */
+   attribute nsIDocShell rootDocShell;
+
+};