nsIPluginInstance.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla 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/MPL/
 *
 * 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 the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "nsIPluginStreamListener.idl"

interface nsIPluginInstanceOwner;
interface nsIOutputStream;

%{C++
#include "nsplugindefs.h"
#include "nsStringGlue.h"
struct JSContext;
struct JSObject;

#define NPRUNTIME_JSCLASS_NAME "NPObject JS wrapper class"
%}

[ptr] native JSContextPtr(JSContext);
[ptr] native JSObjectPtr(JSObject);

[uuid(67D606F4-1D6D-4FE2-A2D6-10BDA65788E1)]
interface nsIPluginInstance : nsISupports
{
    void initialize(in nsIPluginInstanceOwner aOwner, in string aMIMEType);

    void start();

    void stop();

    void setWindow(in nsPluginWindowPtr aWindow);

    void newStreamToPlugin(out nsIPluginStreamListener aListener);

    void newStreamFromPlugin(in string aType, in string aTarget, out nsIOutputStream aResult);

    void print(in nsPluginPrintPtr aPlatformPrint);

    void getValue(in nsPluginInstanceVariable aVariable, in voidPtr aValue);

    void handleEvent(in nsPluginEventPtr aEvent, out boolean aHandled);

    void invalidateRect(in nsPluginRectPtr aRect);

    void invalidateRegion(in nsPluginRegion aRegion);

    void forceRedraw();
    
    void getMIMEType([const, shared] out string aValue);

    readonly attribute JSContextPtr JSContext;

    attribute nsIPluginInstanceOwner owner;
    
    void showStatus(in string aMessage);

    void invalidateOwner();

    JSObjectPtr GetJSObject(in JSContextPtr cx);

    readonly attribute AString formValue;

    void pushPopupsEnabledState(in boolean aEnabled);
    void popPopupsEnabledState();

    readonly attribute PRUint16 pluginAPIVersion;

    void defineJavaProperties();
};