aboutsummaryrefslogtreecommitdiff
path: root/tools/addon-sdk-1.7/packages/addon-kit/docs/private-browsing.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/addon-sdk-1.7/packages/addon-kit/docs/private-browsing.md')
-rw-r--r--tools/addon-sdk-1.7/packages/addon-kit/docs/private-browsing.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/tools/addon-sdk-1.7/packages/addon-kit/docs/private-browsing.md b/tools/addon-sdk-1.7/packages/addon-kit/docs/private-browsing.md
new file mode 100644
index 0000000..e553357
--- /dev/null
+++ b/tools/addon-sdk-1.7/packages/addon-kit/docs/private-browsing.md
@@ -0,0 +1,50 @@
+<!-- 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/. -->
+
+<!-- contributed by Paul O'Shannessy [paul@oshannessy.com] -->
+<!-- edited by Noelle Murata [fiveinchpixie@gmail.com] -->
+<!-- contributed by Irakli Gozalishvili [gozala@mozilla.com] -->
+
+The `private-browsing` module allows you to access Firefox's private browsing
+mode, detecting if it is active and when its state changes.
+
+This module is available in all applications. However, only Firefox will ever
+transition into or out of private browsing mode. For all other applications,
+`pb.isActive` will always be `false`, and none of the events will be emitted.
+
+<api name="isActive">
+@property {boolean}
+ This read-only boolean is true if private browsing mode is turned on.
+</api>
+
+<api name="activate">
+@function
+ Turns on private browsing mode.
+</api>
+
+<api name="deactivate">
+@function
+ Turns off private browsing mode.
+</api>
+
+<api name="start">
+@event
+Emitted immediately after the browser enters private browsing mode.
+
+ var pb = require("private-browsing");
+ pb.on("start", function() {
+ // Do something when the browser starts private browsing mode.
+ });
+
+</api>
+
+<api name="stop">
+@event
+Emitted immediately after the browser exits private browsing mode.
+
+ var pb = require("private-browsing");
+ pb.on("stop", function() {
+ // Do something when the browser stops private browsing mode.
+ });
+</api> \ No newline at end of file