mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-07 20:17:37 +00:00
121 lines
4.3 KiB
Plaintext
121 lines
4.3 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape 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/NPL/
|
|
*
|
|
* 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 Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/**
|
|
* <B>INTERFACE TO NETSCAPE COMMUNICATOR PLUGINS (NEW C++ API).</B>
|
|
*
|
|
* <P>This supersedes the old plugin API (npapi.h, npupp.h), and
|
|
* eliminates the need for glue files: npunix.c, npwin.cpp and npmac.cpp that
|
|
* get linked with the plugin. You will however need to link with the "backward
|
|
* adapter" (badapter.cpp) in order to allow your plugin to run in pre-5.0
|
|
* browsers.
|
|
*
|
|
* <P>See nsPlugin.idl for an overview of how this interface fits with the
|
|
* overall plugin architecture.
|
|
*/
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#include "nsPluginDefs.idl"
|
|
#include "nsIFactory.idl"
|
|
|
|
%{C++
|
|
// {ffc63200-cf09-11d2-a5a0-bc8f7ad21dfc}
|
|
#define NS_PLUGIN_CID \
|
|
{ 0xffc63200, 0xcf09, 0x11d2, { 0xa5, 0xa0, 0xbc, 0x8f, 0x7a, 0xd2, 0x1d, 0xfc } }
|
|
|
|
// Prefix for ContractID of all plugins
|
|
#define NS_INLINE_PLUGIN_CONTRACTID_PREFIX "@mozilla.org/inline-plugin/"
|
|
%}
|
|
|
|
/**
|
|
* The nsIPlugin interface is the minimum interface plugin developers need to
|
|
* support in order to implement a plugin. The plugin manager may QueryInterface
|
|
* for more specific plugin types, e.g. nsILiveConnectPlugin.
|
|
*
|
|
* The old NPP_New plugin operation is now subsumed by two operations:
|
|
*
|
|
* CreateInstance -- called once, after the plugin instance is created. This
|
|
* method is used to initialize the new plugin instance (although the actual
|
|
* plugin instance object will be created by the plugin manager).
|
|
*
|
|
* nsIPluginInstance::Start -- called when the plugin instance is to be
|
|
* started. This happens in two circumstances: (1) after the plugin instance
|
|
* is first initialized, and (2) after a plugin instance is returned to
|
|
* (e.g. by going back in the window history) after previously being stopped
|
|
* by the Stop method.
|
|
*/
|
|
[scriptable, uuid(0e2c3ce4-2de7-11d4-8cf4-0060b0fc14a3)]
|
|
interface nsIPlugin : nsIFactory
|
|
{
|
|
/**
|
|
* Creates a new plugin instance, based on a MIME type. This
|
|
* allows different impelementations to be created depending on
|
|
* the specified MIME type.
|
|
*/
|
|
void createPluginInstance(in nsISupports aOuter,
|
|
in nsIIDRef iid,
|
|
in string pluginMIMEType,
|
|
[retval, iid_is(iid)] out nsQIResult result);
|
|
|
|
/**
|
|
* Initializes the plugin and will be called before any new instances are
|
|
* created.
|
|
*/
|
|
void initialize();
|
|
|
|
/**
|
|
* Called when the browser is done with the plugin factory, or when
|
|
* the plugin is disabled by the user.
|
|
*
|
|
* (Corresponds to NPP_Shutdown.)
|
|
*/
|
|
void shutdown();
|
|
|
|
/**
|
|
* Returns the MIME description for the plugin. The MIME description
|
|
* is a colon-separated string containg the plugin MIME type, plugin
|
|
* data file extension, and plugin name, e.g.:
|
|
*
|
|
* "application/x-simple-plugin:smp:Simple LiveConnect Sample Plug-in"
|
|
*
|
|
* (Corresponds to NPP_GetMIMEDescription.)
|
|
*
|
|
* @result - the resulting MIME description (freed with nsIAllocator::Free)
|
|
*/
|
|
readonly attribute string MIMEDescription;
|
|
|
|
/**
|
|
* Returns the name of the plugin.
|
|
*
|
|
* (Supersedes NPP_GetValue with NPPVpluginNameString.)
|
|
*/
|
|
readonly attribute wstring name;
|
|
|
|
/**
|
|
* Returns the name of the plugin.
|
|
*
|
|
* (Supersedes NPP_GetValue with NPPVpluginDescriptionString.)
|
|
*/
|
|
readonly attribute wstring description;
|
|
};
|