gecko-dev/modules/plugin/public/nsIPluginStreamListener.idl

96 строки
3.8 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"
/**
* The nsIPluginStreamListener interface defines the minimum set of functionality that
* the browser will support if it allows plugins. Plugins can call QueryInterface
* to determine if a plugin manager implements more specific APIs or other
* browser interfaces for the plugin to use (e.g. nsINetworkManager).
*/
[scriptable, uuid(faa328a8-2dfb-11d4-8cf4-0060b0fc14a3)]
interface nsIPluginStreamListener : nsISupports
{
/**
* Notify the observer that the URL has started to load. This method is
* called only once, at the beginning of a URL load.<BR><BR>
*/
void onStartBinding(in nsIPluginStreamInfo pluginInfo);
/**
* Notify the client that data is available in the input stream. This
* method is called whenver data is written into the input stream by the
* networking library...<BR><BR>
*
* @param aIStream The input stream containing the data. This stream can
* be either a blocking or non-blocking stream.
* @param length The amount of data that was just pushed into the stream.
*/
void onDataAvailable(in nsIPluginStreamInfo pluginInfo,
in nsIInputStream input,
in unsigned long sourceOffset,
in unsigned long length);
void onFileAvailable(in nsIPluginStreamInfo pluginInfo,
in nsIFile fileName);
/**
* Notify the observer that the URL has finished loading. This method is
* called once when the networking library has finished processing the
* URL transaction.<BR><BR>
*
* This method is called regardless of whether the URL loaded successfully.<BR><BR>
*
* @param status Status code for the URL load.
* @param msg A text string describing the error.
*/
void onStopBinding(in nsIPluginStreamInfo pluginInfo,
in nsresult status);
const unsigned long STREAMTYPE_NORMAL = 1;
const unsigned long STREAMTYPE_SEEK = 2;
const unsigned long STREAMTYPE_ASFILE = 3;
const unsigned long STREAMTYPE_ASFILEONLY = 4;
readonly attribute unsigned long streamType;
};
////////////////////////////////////////////////////////////////////////////////
#endif /* nsIPluginStreamListener_h___ */