summaryrefslogtreecommitdiffstats
path: root/browser/components/newtab/nsIAboutNewTabService.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--browser/components/newtab/nsIAboutNewTabService.idl39
1 files changed, 39 insertions, 0 deletions
diff --git a/browser/components/newtab/nsIAboutNewTabService.idl b/browser/components/newtab/nsIAboutNewTabService.idl
new file mode 100644
index 0000000000..e8ddd0381f
--- /dev/null
+++ b/browser/components/newtab/nsIAboutNewTabService.idl
@@ -0,0 +1,39 @@
+/* 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"
+
+/**
+ * Allows to override about:newtab to point to a different location
+ * than the one specified within AboutRedirector.cpp
+ */
+
+interface nsIChannel;
+interface nsIURI;
+interface nsILoadInfo;
+
+[scriptable, uuid(dfcd2adc-7867-4d3a-ba70-17501f208142)]
+interface nsIAboutNewTabService : nsISupports
+{
+ /**
+ * Returns the default URL (local or activity stream depending on pref)
+ */
+ readonly attribute ACString defaultURL;
+
+ /**
+ * In the "privileged about content process", if about:home is being
+ * retrieved, the AboutRedirector will call this function to get the
+ * nsIChannel for the document. This gives the nsIAboutNewTabService
+ * the opportunity to provide a cached document for about:home. If
+ * no cache exists, the nsIChannel will be for the normal dynamically
+ * generated about:home document.
+ */
+ nsIChannel aboutHomeChannel(in nsIURI aURI,
+ in nsILoadInfo aLoadInfo);
+
+ /**
+ * Returns the about:welcome URL.
+ */
+ readonly attribute ACString welcomeURL;
+};