Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIPluginInstancePeer2 Interface Reference

The nsIPluginInstancePeer2 interface extends the nsIPluginInstancePeer interface, providing access to functionality provided by newer browsers. More...

import "nsIPluginInstancePeer2.idl";

Inheritance diagram for nsIPluginInstancePeer2:
Inheritance graph
[legend]
Collaboration diagram for nsIPluginInstancePeer2:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void getValue (in nsPluginInstancePeerVariable aVariable, in voidPtr aValue)
 Returns the value of a variable associated with the plugin manager.
void newStream (in nsMIMEType aType, in string aTarget, out nsIOutputStream aResult)
 This operation is called by the plugin instance when it wishes to send a stream of data to the browser.
void showStatus (in string aMessage)
 This operation causes status information to be displayed on the window associated with the plugin instance.
void setWindowSize (in unsigned long aWidth, in unsigned long aHeight)
 Set the desired size of the window in which the plugin instance lives.

Public Attributes

readonly attribute JSObjectPtr JSWindow
 Get the JavaScript window object corresponding to this plugin instance.
readonly attribute unsigned long JSThread
 Get the JavaScript execution thread corresponding to this plugin instance.
readonly attribute JSContextPtr JSContext
 Get the JavaScript context to this plugin instance.
readonly attribute nsMIMEType MIMEType
 Returns the MIME type of the plugin instance.
readonly attribute nsPluginMode mode
 Returns the mode of the plugin instance, i.e.

Detailed Description

The nsIPluginInstancePeer2 interface extends the nsIPluginInstancePeer interface, providing access to functionality provided by newer browsers.

All functionality in nsIPluginInstancePeer can be mapped to the 4.X plugin API.

Definition at line 65 of file nsIPluginInstancePeer2.idl.


Member Function Documentation

void nsIPluginInstancePeer::getValue ( in nsPluginInstancePeerVariable  aVariable,
in voidPtr  aValue 
) [inherited]

Returns the value of a variable associated with the plugin manager.

(Corresponds to NPN_GetValue.)

Parameters:
aVariable- the plugin manager variable to get
aValue- the address of where to store the resulting value
Returns:
- NS_OK if this operation was successful
void nsIPluginInstancePeer::newStream ( in nsMIMEType  aType,
in string  aTarget,
out nsIOutputStream  aResult 
) [inherited]

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.)

Parameters:
aType- MIME type of the stream to create
aTarget- the target window name to receive the data
aResult- the resulting output stream
Returns:
- NS_OK if this operation was successful
void nsIPluginInstancePeer::setWindowSize ( in unsigned long  aWidth,
in unsigned long  aHeight 
) [inherited]

Set the desired size of the window in which the plugin instance lives.

Parameters:
aWidth- new window width
aHeight- new window height
Returns:
- NS_OK if this operation was successful
void nsIPluginInstancePeer::showStatus ( in string  aMessage) [inherited]

This operation causes status information to be displayed on the window associated with the plugin instance.

(Corresponds to NPN_Status.)

Parameters:
aMessage- the status message to display
Returns:
- NS_OK if this operation was successful

Member Data Documentation

Get the JavaScript context to this plugin instance.

Parameters:
aJSContext- the resulting JavaScript context
Returns:
- NS_OK if this operation was successful

Definition at line 89 of file nsIPluginInstancePeer2.idl.

Get the JavaScript execution thread corresponding to this plugin instance.

Parameters:
aJSThread- the resulting JavaScript thread id
Returns:
- NS_OK if this operation was successful

Definition at line 81 of file nsIPluginInstancePeer2.idl.

Get the JavaScript window object corresponding to this plugin instance.

Parameters:
aJSWindow- the resulting JavaScript window object
Returns:
- NS_OK if this operation was successful

Definition at line 73 of file nsIPluginInstancePeer2.idl.

Returns the MIME type of the plugin instance.

(Corresponds to NPP_New's MIMEType argument.)

Parameters:
aMIMEType- resulting MIME type
Returns:
- NS_OK if this operation was successful

Definition at line 88 of file nsIPluginInstancePeer.idl.

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.)

Parameters:
result- the resulting mode
Returns:
- NS_OK if this operation was successful

Definition at line 99 of file nsIPluginInstancePeer.idl.


The documentation for this interface was generated from the following file: