RetroZilla/dom/public/idl/base/nsIDOMJSWindow.idl
2015-10-20 23:03:22 -04:00

115 lines
4.8 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla 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/MPL/
*
* 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 the Initial Developer are Copyright (C) 2000
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Johnny Stenback <jst@netscape.com> (original author)
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "domstubs.idl"
[scriptable, uuid(c8188620-1dd1-11b2-bc88-df8440498add)]
interface nsIDOMJSWindow : nsISupports
{
void dump(in DOMString str);
/**
* These methods take typeless arguments and optional arguments, the
* first argument is either a function or a string, the second
* argument must be a number (ms) and the rest of the arguments (2
* ... n) are passed to the callback function
*/
long setTimeout();
long setInterval();
/**
* These methods take one optional argument that's the timer ID to
* clear. Often in existing code these methods are passed undefined,
* which is a nop so we need to support that as well.
*/
void clearTimeout();
void clearInterval();
// This method is here for backwards compatibility with 4.x only,
// it's implementation is a no-op
void setResizable(in boolean resizable);
// These are 4.x event related methods. Deprecated.
void captureEvents(in long eventFlags);
void releaseEvents(in long eventFlags);
void routeEvent(in nsIDOMEvent evt);
void enableExternalCapture();
void disableExternalCapture();
/**
* The prompt method takes up to four arguments, the arguments are
* message, initial prompt value, title and a save password flag
*/
DOMString prompt();
/**
* These are the scriptable versions of nsIDOMWindowInternal::open() and
* nsIDOMWindowInternal::openDialog() that take 3 optional arguments. Unlike
* the nsIDOMWindowInternal methods, these methods assume that they are
* called from JavaScript and hence will look on the JS context stack to
* determine the caller and hence correct security context for doing their
* search for an existing named window. Also, these methods will set the
* default charset on the newly opened window based on the current document
* charset in the caller.
*/
nsIDOMWindow open();
nsIDOMWindow openDialog();
/**
* window.frames in Netscape 4.x and IE is just a reference to the
* window itself (i.e. window.frames === window), but this doesn't
* make sense from a generic API point of view so that's why this is
* JS specific.
*
* This property is "replaceable" in JavaScript.
*/
readonly attribute nsIDOMWindow frames;
/* Scriptable version of find(). See nsIDOMWindowInternal for the
* non-scriptable version. It takes 7 optional arguments:
* @param searchString: the search string
* @param caseSensitive: is the search case sensitive?
* @param backwards: should we search backwards?
* @param wrapAround: should wrap the search?
* @param wholeWord: should we search only for whole words?
* @param searchInFrames: should we search in all frames?
* @param showDialog: should we show the Find Dialog?
*/
boolean find();
};