nsIPluginInstancePeer Interface Reference

The nsIPluginInstancePeer interface is the set of operations implemented by the browser to support a plugin instance. More...

import"nsIPluginInstancePeer.idl";

Inheritance diagram for nsIPluginInstancePeer:

Public Member Functions
void	getValue (in nsPluginInstancePeerVariable aVariable, in voidPtr aValue)
	Returns the value of a variable associated with the plugin manager. More...
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. More...
void	showStatus (in string aMessage)
	This operation causes status information to be displayed on the window associated with the plugin instance. More...
void	setWindowSize (in unsigned long aWidth, in unsigned long aHeight)
	Set the desired size of the window in which the plugin instance lives. More...

Data Fields
readonly attribute nsMIMEType	MIMEType
	Returns the MIME type of the plugin instance. More...
readonly attribute nsPluginMode	mode
	Returns the mode of the plugin instance, i.e. More...

Detailed Description

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.

Definition at line 68 of file nsIPluginInstancePeer.idl.

Member Function Documentation

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

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
	)

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
	)

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

)

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

Field Documentation

readonly attribute nsMIMEType nsIPluginInstancePeer::MIMEType

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.

readonly attribute nsPluginMode nsIPluginInstancePeer::mode

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:

• src/plugin_win32/include/nsIPluginInstancePeer.idl