modules/plugin/base/public/nsIPluginInstancePeer2.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /**
  39  * nsIPluginInstancePeer2
  40  *
  41  * @status DEPRECATED
  42  *
  43  * Originally published XPCOM Plugin API is now deprecated
  44  * Developers are welcome to use NPAPI, please refer to:
  45  * http://mozilla.org/projects/plugins/
  46  */
  47
  48 #include "nsIPluginInstancePeer.idl"
  49
  50 %{C++
  51 struct JSObject;
  52 struct JSContext;
  53 %}
  54
  55 [ptr] native JSObjectPtr(JSObject);
  56 [ptr] native JSContextPtr(JSContext);
  57
  58 /**
  59  * The nsIPluginInstancePeer2 interface extends the nsIPluginInstancePeer
  60  * interface, providing access to functionality provided by newer browsers.
  61  * All functionality in nsIPluginInstancePeer can be mapped to the 4.X
  62  * plugin API.
  63  */
  64 [uuid(e7d48c00-e1f1-11d2-8360-fbc8abc4ae7c)]
  65 interface nsIPluginInstancePeer2 : nsIPluginInstancePeer
  66 {
  67     /**
  68      * Get the JavaScript window object corresponding to this plugin instance.
  69      *
  70    * @param aJSWindow - the resulting JavaScript window object
  71    * @result          - NS_OK if this operation was successful
  72      */
  73   readonly attribute JSObjectPtr JSWindow;
  74
  75         /**
  76          * Get the JavaScript execution thread corresponding to this plugin instance.
  77          *
  78    * @param aJSThread - the resulting JavaScript thread id
  79    * @result            - NS_OK if this operation was successful
  80          */
  81     readonly attribute unsigned long JSThread;
  82
  83         /**
  84          * Get the JavaScript context to this plugin instance.
  85          *
  86    * @param aJSContext - the resulting JavaScript context
  87    * @result           - NS_OK if this operation was successful
  88          */
  89   readonly attribute JSContextPtr JSContext;
  90 };