mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 08:35:26 +00:00
128 lines
4.3 KiB
Plaintext
128 lines
4.3 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
|
|
* Mozilla Corporation
|
|
* Portions created by the Initial Developer are Copyright (C) 2010
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either 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 "nsISupports.idl"
|
|
|
|
interface nsIDOMWindow;
|
|
interface nsIDocShell;
|
|
interface nsIContent;
|
|
|
|
[scriptable, function, uuid(938fcb95-3d63-46be-aa72-94d08fd3b418)]
|
|
interface nsIFrameMessageListener : nsISupports
|
|
{
|
|
/**
|
|
* This is for JS only.
|
|
* receiveMessage is called with one parameter, which has the following
|
|
* properties:
|
|
* {
|
|
* name: %message name%,
|
|
* sync: %true or false%.
|
|
* json: %json object or null%,
|
|
* objects: %array of handles or null, always null if sync is false%
|
|
* }
|
|
* @note objects property isn't implemented yet.
|
|
*
|
|
* if the message is synchronous, possible return value is sent back
|
|
* as JSON.
|
|
*
|
|
* When the listener is called, 'this' value is the target of the message.
|
|
*/
|
|
void receiveMessage();
|
|
};
|
|
|
|
[scriptable, uuid(6b736edb-863d-40bd-bca2-62f44da803c0)]
|
|
interface nsIFrameMessageManager : nsISupports
|
|
{
|
|
void addMessageListener(in AString aMessage, in nsIFrameMessageListener aListener);
|
|
void removeMessageListener(in AString aMessage, in nsIFrameMessageListener aListener);
|
|
void sendAsyncMessage(/*in messageName, in JSON*/);
|
|
};
|
|
|
|
[scriptable, uuid(cdb1a40b-9862-426c-ae8a-f5ab84e20e32)]
|
|
interface nsISyncMessageSender : nsIFrameMessageManager
|
|
{
|
|
/**
|
|
* Returns an array of JSON objects.
|
|
*/
|
|
void sendSyncMessage(/*in messageName, in JSON*/);
|
|
};
|
|
|
|
[scriptable, uuid(c56e85b8-6736-4ae2-ae90-66bcef952a82)]
|
|
interface nsIContentFrameMessageManager : nsISyncMessageSender
|
|
{
|
|
/**
|
|
* The current top level window in the frame or null.
|
|
*/
|
|
readonly attribute nsIDOMWindow content;
|
|
|
|
/**
|
|
* The top level docshell or null.
|
|
*/
|
|
readonly attribute nsIDocShell docShell;
|
|
|
|
/**
|
|
* Print a string to stdout.
|
|
*/
|
|
void dump(in DOMString aStr);
|
|
|
|
/**
|
|
* If leak detection is enabled, print a note to the leak log that this
|
|
* process will intentionally crash.
|
|
*/
|
|
void privateNoteIntentionalCrash();
|
|
};
|
|
|
|
[uuid(9c48d557-92fe-4edb-95fc-bfe97e77bdc3)]
|
|
interface nsIInProcessContentFrameMessageManager : nsIContentFrameMessageManager
|
|
{
|
|
[notxpcom] nsIContent getOwnerContent();
|
|
};
|
|
|
|
[scriptable, uuid(ed6522fd-ffb6-4920-b50d-cf629309616b)]
|
|
interface nsIChromeFrameMessageManager : nsIFrameMessageManager
|
|
{
|
|
/*
|
|
* Load a script in the (remote) frame. aURL must be the absolute URL.
|
|
* data: URLs are also supported. For example data:,dump("foo\n");
|
|
* If aAllowDelayedLoad is true, script will be loaded when the
|
|
* remote frame becomes available. Otherwise the script will be loaded
|
|
* only if the frame is already available.
|
|
*/
|
|
void loadFrameScript(in AString aURL, in boolean aAllowDelayedLoad);
|
|
};
|
|
|