modules/plugin/base/public/nsplugin.h

   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 /* INTERFACE TO NETSCAPE COMMUNICATOR PLUGINS (NEW C++ API)
  39  *
  40  * This interface was an attempt to supersede npapi.h, npupp.h but it failed. It
  41  * would have eliminated the need for glue files: npunix.c, npwin.cpp and
  42  * npmac.cpp that get linked with the plugin.
  43  *
  44  * This is the master header file that includes most of the other headers
  45  * you'd have needed to write a plugin.
  46  */
  47
  48 /**
  49  * The following diagram depicts the relationships between various objects
  50  * implementing the new plugin interfaces. QueryInterface can be used to switch
  51  * between interfaces in the same box:
  52  *
  53  *
  54  *         the plugin (only 1)
  55  *  +----------------------+
  56  *  | nsIPlugin or         |<- - - - - -NSGetFactory()
  57  *  +----------------------+
  58  *    |
  59  *    |
  60  *    |              instances (many)
  61  *    |          +-------------------+
  62  *    |          | nsIPluginInstance |+
  63  *    |          +-------------------+|
  64  *    |            +------|-----------+
  65  *    |                   |
  66  *    | PLUGIN SIDE       |peer
  67  *~~~~|~~~~~~~~~~~~~~~~~~~|~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  68  *    | BROWSER SIDE      |
  69  *    |                   v
  70  *    |     +---------------------------------+
  71  *    |     | nsIPluginInstancePeer           |+
  72  *    |     | nsIWindowlessPluginInstancePeer ||
  73  *    |     | nsIPluginTagInfo                ||
  74  *    |     | nsIPluginTagInfo2               ||
  75  *    |     +---------------------------------+|
  76  *    |       +--------------------------------+
  77  *    |
  78  *    |
  79  *    v    the browser (only 1)
  80  *  +---------------------+
  81  *  | nsIPluginManager    |
  82  *  | nsIPluginManager2   |
  83  *  | nsIFileUtilities    |
  84  *  | nsIPref             |
  85  *  | nsICacheManager ... |
  86  *  +---------------------+
  87  */
  88
  89 #ifndef nsplugins_h___
  90 #define nsplugins_h___
  91 #include "nsIComponentManager.h"       // for NSGetFactory
  92
  93 ////////////////////////////////////////////////////////////////////////////////
  94 /**
  95  * <B>Interfaces which must be implemented by a plugin</B>
  96  * These interfaces have NPP equivalents in pre-5.0 browsers (see npapi.h).
  97  */
  98
  99 /**
 100  * A plugin object is used to create new plugin instances. It manages the
 101  * global state of all plugins with the same implementation.
 102  */
 103 #include "nsIPlugin.h"
 104
 105 /**
 106  * A plugin instance represents a particular activation of a plugin on a page.
 107  */
 108 #include "nsIPluginInstance.h"
 109
 110 ////////////////////////////////////////////////////////////////////////////////
 111 /**
 112  * <B>Interfaces implemented by the browser:
 113  * These interfaces have NPN equivalents in pre-5.0 browsers (see npapi.h).
 114  */
 115 ////////////////////////////////////////////////////////////////////////////////
 116
 117 /**
 118  * The plugin manager which is the main point of interaction with the browser
 119  * and provides general operations needed by a plugin.
 120  */
 121 #include "nsIPluginManager.h"
 122
 123 /**
 124  * A plugin instance peer gets created by the browser and associated with each
 125  * plugin instance to represent tag information and other callbacks needed by
 126  * the plugin instance.
 127  */
 128 #include "nsIPluginInstancePeer.h"
 129
 130 /**
 131  * The nsIPluginTagInfo interface provides information about the html tag
 132  * that was used to instantiate the plugin instance.
 133  *
 134  * To obtain: QueryInterface on nsIPluginInstancePeer
 135  */
 136 #include "nsIPluginTagInfo.h"
 137
 138 /**
 139  * The nsIWindowlessPluginInstancePeer provides additional operations for
 140  * windowless plugins.
 141  *
 142  * To obtain: QueryInterface on nsIPluginInstancePeer
 143  */
 144 #include "nsIWindowlessPlugInstPeer.h"
 145
 146 ////////////////////////////////////////////////////////////////////////////////
 147 /**
 148  * <B>Interfaces implemented by the browser (new for 5.0):
 149  */
 150 ////////////////////////////////////////////////////////////////////////////////
 151
 152 /**
 153  * The nsIPluginManager2 interface provides additional plugin manager features
 154  * only available in Communicator 5.0.
 155  *
 156  * To obtain: QueryInterface on nsIPluginManager
 157  */
 158 #include "nsIPluginManager2.h"
 159
 160 /**
 161  * The nsIFileUtilities interface provides operations to manage temporary
 162  * files and directories.
 163  *
 164  * To obtain: QueryInterface on nsIPluginManager
 165  */
 166 #include "nsIFileUtilities.h"
 167
 168 /**
 169  * The nsIPluginTagInfo2 interface provides additional html tag information
 170  * only available in Communicator 5.0.
 171  *
 172  * To obtain: QueryInterface on nsIPluginTagInfo
 173  */
 174 #include "nsIPluginTagInfo2.h"
 175
 176 #include "nsIOutputStream.h"
 177
 178 ////////////////////////////////////////////////////////////////////////////////
 179 #endif // nsplugins_h___