summaryrefslogtreecommitdiffstats
path: root/xpfe/appshell/nsIWindowlessBrowser.idl
diff options
context:
space:
mode:
Diffstat (limited to 'xpfe/appshell/nsIWindowlessBrowser.idl')
-rw-r--r--xpfe/appshell/nsIWindowlessBrowser.idl41
1 files changed, 41 insertions, 0 deletions
diff --git a/xpfe/appshell/nsIWindowlessBrowser.idl b/xpfe/appshell/nsIWindowlessBrowser.idl
new file mode 100644
index 0000000000..c8c08a3499
--- /dev/null
+++ b/xpfe/appshell/nsIWindowlessBrowser.idl
@@ -0,0 +1,41 @@
+/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * 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 "nsIWebNavigation.idl"
+
+interface nsIDocShell;
+webidl BrowsingContext;
+
+/**
+ * This interface represents a nsIWebBrowser instance with no associated OS
+ * window. Its main function is to manage the lifetimes of those windows.
+ * A strong reference to this object must be held until the window is
+ * ready to be destroyed.
+ */
+[scriptable, builtinclass, uuid(abb46f48-abfc-41bf-aa9a-7feccefcf977)]
+interface nsIWindowlessBrowser : nsIWebNavigation
+{
+ /**
+ * "Closes" the windowless browser and destroys its associated nsIWebBrowser
+ * and docshell.
+ *
+ * This method *must* be called for every windowless browser before its last
+ * reference is released.
+ */
+ void close();
+
+ /**
+ * Get the docshell for this browser. This is the docshell that gets
+ * navigated when the browser's nsIWebNavigation interface is used.
+ */
+ readonly attribute nsIDocShell docShell;
+
+ /**
+ * Get the Browsing Context for this browser. This is the Browsing Context
+ * that owns the docshell used for navigation.
+ */
+ readonly attribute BrowsingContext browsingContext;
+};