gecko-dev/modules/plugin/public/nsIPluginInstancePeer.idl
2000-05-20 20:03:36 +00:00

112 lines
3.9 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"
////////////////////////////////////////////////////////////////////////////////
// Plugin Instance Peer Interface
/**
* The nsIPluginInstancePeer interface is the set of operations implemented
* by the browser to support a plugin instance. When a plugin instance is
* constructed, a nsIPluginInstancePeer is passed to its initializer
* representing the instantiation of the plugin on the page.
*
* Other interfaces may be obtained from nsIPluginInstancePeer by calling
* QueryInterface, e.g. nsIPluginTagInfo.
*/
[scriptable, uuid(f7d64b8a-2df3-11d4-8cf4-0060b0fc14a3)]
interface nsIPluginInstancePeer : nsISupports
{
/**
* Returns the MIME type of the plugin instance.
*
* (Corresponds to NPP_New's MIMEType argument.)
*
* @result - resulting MIME type
*/
readonly attribute string MIMEType;
// plugin modes:
const unsigned long MODE_EMBEDDED = 1;
const unsigned long MODE_FULL = 2;
/**
* Returns the mode of the plugin instance, i.e. whether the plugin is
* embedded in the html, or full page.
*
* (Corresponds to NPP_New's mode argument.)
*
* @result - the resulting mode
*/
readonly attribute unsigned long mode;
/**
* This operation is called by the plugin instance when it wishes to send
* a stream of data to the browser. It constructs a new output stream to which
* the plugin may send the data. When complete, the Close and Release methods
* should be called on the output stream.
*
* (Corresponds to NPN_NewStream.)
*
* @param type - type MIME type of the stream to create
* @param target - the target window name to receive the data
* @result - the resulting output stream
*/
nsIOutputStream newStream(in string mimeType,
in wstring targetWindow);
/**
* This operation causes status information to be displayed on the window
* associated with the plugin instance.
*
* (Corresponds to NPN_Status.)
*
* @param message - the status message to display
*/
void showStatus(in wstring message);
/**
* Set the desired size of the window in which the plugin instance lives.
*
* @param width - new window width
* @param height - new window height
*/
void setWindowSize(in unsigned long width,
in unsigned long height);
};