modules/plugin/base/public/nsIJRILiveConnectPIPeer.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  * nsIJRILiveConnectPluginInstancePeer
  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 "nsISupports.idl"
  49 #include "nspluginroot.idl"
  50
  51 %{C++
  52 #include "nsplugindefs.h"
  53 #include "jri.h"
  54 %}
  55
  56 ////////////////////////////////////////////////////////////////////////////////
  57 // JRI-Based LiveConnect Classes
  58 ////////////////////////////////////////////////////////////////////////////////
  59 //
  60 // This stuff is here so that the browser can support older JRI-based
  61 // LiveConnected plugins (when using old plugin to new C++-style plugin
  62 // adapter code).
  63 //
  64 // Warning: Don't use this anymore, unless you're sure that you have to!
  65 ////////////////////////////////////////////////////////////////////////////////
  66
  67 %{C++
  68 // QueryInterface for this IID on nsIPluginManager to get a JRIEnv
  69 // XXX change this
  70 #define NS_IJRIENV_IID                               \
  71 { /* f9d4ea00-a1bc-11d1-85b1-00805f0e4dfe */         \
  72     0xf9d4ea00,                                      \
  73     0xa1bc,                                          \
  74     0x11d1,                                          \
  75     {0x85, 0xb1, 0x00, 0x80, 0x5f, 0x0e, 0x4d, 0xfe} \
  76 }
  77 %}
  78
  79 /**
  80  * The nsIJRILiveConnectPluginInstancePeer interface is implemented by browsers
  81  * that support JRI-based LiveConnect. Note that for 5.0, LiveConnect support
  82  * has become JNI-based, so this interface is effectively deprecated.
  83  *
  84  * To obtain: QueryInterface on nsIPluginInstancePeer
  85  */
  86 [uuid(25b63f40-f773-11d1-815b-006008119d7a)]
  87 interface nsIJRILiveConnectPluginInstancePeer : nsISupports
  88 {
  89     /**
  90      * Returns a JRI env corresponding to the current Java thread of the
  91      * browser.
  92      *
  93      * (Corresponds to NPN_GetJavaEnv.)
  94          */
  95   void getJavaEnv(out JRIEnvPtr aEnv);
  96
  97     /**
  98      * Returns a JRI reference to the Java peer object associated with the
  99      * plugin instance. This object is an instance of the class specified
 100      * by nsIJRILiveConnectPlugin::GetJavaClass.
 101      *
 102      * (Corresponds to NPN_GetJavaPeer.)
 103      */
 104   void getJavaPeer(out jref aJavaPeer);
 105 };