modules/plugin/base/public/nsIPlugin.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  * nsIPlugin
  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 "nsIFactory.idl"
  49 #include "nspluginroot.idl"
  50
  51 %{C++
  52 #include "nsplugindefs.h"
  53 %}
  54
  55 %{C++
  56 // {ffc63200-cf09-11d2-a5a0-bc8f7ad21dfc}
  57 #define NS_PLUGIN_CID \
  58 { 0xffc63200, 0xcf09, 0x11d2, { 0xa5, 0xa0, 0xbc, 0x8f, 0x7a, 0xd2, 0x1d, 0xfc } }
  59
  60 // Prefix for ContractID of all plugins
  61 #define NS_INLINE_PLUGIN_CONTRACTID_PREFIX "@mozilla.org/inline-plugin/"
  62 %}
  63
  64 /**
  65  * The nsIPlugin interface is the minimum interface plugin developers need to
  66  * support in order to implement a plugin. The plugin manager may QueryInterface
  67  * for more specific plugin types, e.g. nsILiveConnectPlugin.
  68  *
  69  * The old NPP_New plugin operation is now subsumed by two operations:
  70  *
  71  * CreateInstance -- called once, after the plugin instance is created. This
  72  * method is used to initialize the new plugin instance (although the actual
  73  * plugin instance object will be created by the plugin manager).
  74  *
  75  * nsIPluginInstance::Start -- called when the plugin instance is to be
  76  * started. This happens in two circumstances: (1) after the plugin instance
  77  * is first initialized, and (2) after a plugin instance is returned to
  78  * (e.g. by going back in the window history) after previously being stopped
  79  * by the Stop method.
  80  */
  81 [uuid(df773070-0199-11d2-815b-006008119d7a)]
  82 interface nsIPlugin : nsIFactory
  83 {
  84     /**
  85      * Creates a new plugin instance, based on a MIME type. This
  86      * allows different impelementations to be created depending on
  87      * the specified MIME type.
  88      */
  89     void createPluginInstance(in nsISupports aOuter,
  90                             in nsIIDRef aIID,
  91                             in string aPluginMIMEType,
  92                             [retval, iid_is(aIID)] out nsQIResult aResult);
  93
  94     /**
  95      * Initializes the plugin and will be called before any new instances are
  96    * created. It is passed browserInterfaces on which QueryInterface
  97    * may be used to obtain an nsIPluginManager, and other interfaces.
  98    *
  99    * @param browserInterfaces - an object that allows access to other browser
 100    * interfaces via QueryInterface
 101    * @result - NS_OK if this operation was successful
 102      */
 103     void initialize();
 104
 105     /**
 106      * Called when the browser is done with the plugin factory, or when
 107      * the plugin is disabled by the user.
 108      *
 109      * (Corresponds to NPP_Shutdown.)
 110    *
 111    * @result - NS_OK if this operation was successful
 112      */
 113     void shutdown();
 114
 115     /**
 116      * Returns the MIME description for the plugin. The MIME description
 117      * is a colon-separated string containg the plugin MIME type, plugin
 118      * data file extension, and plugin name, e.g.:
 119      *
 120      * "application/x-simple-plugin:smp:Simple LiveConnect Sample Plug-in"
 121      *
 122      * (Corresponds to NPP_GetMIMEDescription.)
 123      *
 124    * @param aMIMEDescription - the resulting MIME description
 125    * @result                 - NS_OK if this operation was successful
 126      */
 127   //readonly attribute string MIMEDescription;
 128   void getMIMEDescription(out constCharPtr aMIMEDescription);
 129
 130     /**
 131    * Returns the value of a variable associated with the plugin.
 132      *
 133    * (Corresponds to NPP_GetValue.)
 134      *
 135    * @param aVariable - the plugin variable to get
 136    * @param aValue    - the address of where to store the resulting value
 137    * @result          - NS_OK if this operation was successful
 138      */
 139    void getValue(in nsPluginVariable aVariable, in voidPtr aValue);
 140 };