aboutsummaryrefslogtreecommitdiff
path: root/tools/addon-sdk-1.7/packages/api-utils/docs/window-utils.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/addon-sdk-1.7/packages/api-utils/docs/window-utils.md')
-rw-r--r--tools/addon-sdk-1.7/packages/api-utils/docs/window-utils.md88
1 files changed, 0 insertions, 88 deletions
diff --git a/tools/addon-sdk-1.7/packages/api-utils/docs/window-utils.md b/tools/addon-sdk-1.7/packages/api-utils/docs/window-utils.md
deleted file mode 100644
index 1435fd2..0000000
--- a/tools/addon-sdk-1.7/packages/api-utils/docs/window-utils.md
+++ /dev/null
@@ -1,88 +0,0 @@
-<!-- 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 Drew Willcoxon [adw@mozilla.com] -->
-<!-- edited by Erik Vold [erikvvold@gmail.com] -->
-
-The `window-utils` module provides helpers for accessing and tracking
-application windows. These windows implement the [`nsIDOMWindow`][nsIDOMWindow]
-interface.
-
-[nsIDOMWindow]: http://mxr.mozilla.org/mozilla-central/source/dom/interfaces/base/nsIDOMWindow.idl
-
-<api name="WindowTracker">
-@class
-`WindowTracker` objects make it easy to "monkeypatch" windows when a program is
-loaded and "un-monkeypatch" those windows when the program is unloaded. For
-example, if a Firefox add-on needs to add a status bar icon to all browser
-windows, it can use a single `WindowTracker` object to gain access to windows
-when they are opened and closed and also when the add-on is loaded and unloaded.
-
-When a window is opened or closed, a `WindowTracker` notifies its delegate
-object, which is passed to the constructor. The delegate is also notified of
-all windows that are open at the time that the `WindowTracker` is created and
-all windows that are open at the time that the `WindowTracker` is unloaded. The
-caller can therefore use the same code to act on all windows, regardless of
-whether they are currently open or are opened in the future, or whether they are
-closed while the parent program is loaded or remain open when the program is
-unloaded.
-
-When a window is opened or when a window is open at the time that the
-`WindowTracker` is created, the delegate's `onTrack()` method is called and
-passed the window.
-
-When a window is closed or when a window is open at the time that the
-`WindowTracker` is unloaded, the delegate's `onUntrack()` method is called and
-passed the window. (The `WindowTracker` is unloaded when its its `unload()`
-method is called, or when its parent program is unloaded, disabled, or
-uninstalled, whichever comes first.)
-
-**Example**
-
- var delegate = {
- onTrack: function (window) {
- console.log("Tracking a window: " + window.location);
- // Modify the window!
- },
- onUntrack: function (window) {
- console.log("Untracking a window: " + window.location);
- // Undo your modifications!
- }
- };
- var winUtils = require("window-utils");
- var tracker = new winUtils.WindowTracker(delegate);
-
-<api name="WindowTracker">
-@constructor
- A `WindowTracker` object listens for openings and closings of application
- windows.
-@param delegate {object}
- An object that implements `onTrack()` and `onUntrack()` methods.
-@prop onTrack {function}
- A function to be called when a window is open or loads, with the window as the
- first and only argument.
-@prop [onUntrack] {function}
- A function to be called when a window unloads, with the window as the first
- and only argument.
-</api>
-</api>
-
-<api name="windowIterator">
-@function
- An iterator for windows currently open in the application.
-
-**Example**
-
- var winUtils = require("window-utils");
- for (window in winUtils.windowIterator())
- console.log("An open window! " + window.location);
-
-</api>
-
-<api name="closeOnUnload">
-@function
- Marks an application window to be closed when the program is unloaded.
-@param window {window}
- The window to close.
-</api>