The nsIPluginInstance interface is the minimum interface plugin developers need to support in order to implement a plugin instance. More...

import"nsIPluginInstanceOld.idl";

Inheritance diagram for nsIPluginInstanceOld:

Public Member Functions
void	initialize (in nsIPluginInstancePeer aPeer)
	Initializes a newly created plugin instance, passing to it the plugin instance peer which it should use for all communication back to the browser. More...

void	start ()
	Called to instruct the plugin instance to start. More...

void	stop ()
	Called to instruct the plugin instance to stop, thereby suspending its state. More...

void	destroy ()
	Called to instruct the plugin instance to destroy itself. More...

void	setWindow (in nsPluginWindowPtr aWindow)
	Called when the window containing the plugin instance changes. More...

void	newStream (out nsIPluginStreamListener aListener)
	Called to tell the plugin that the initial src/data stream is ready. More...

void	print (in nsPluginPrintPtr aPlatformPrint)
	Called to instruct the plugin instance to print itself to a printer. More...

void	getValue (in nsPluginInstanceVariable aVariable, in voidPtr aValue)
	Returns the value of a variable associated with the plugin instance. More...

void	handleEvent (in nsPluginEventPtr aEvent, out boolean aHandled)
	Handles an event. More...

Data Fields
readonly attribute nsIPluginInstancePeer	peer
	Returns a reference back to the plugin instance peer. More...

Detailed Description

The nsIPluginInstance interface is the minimum interface plugin developers need to support in order to implement a plugin instance.

The plugin manager may QueryInterface for more specific types, e.g. nsILiveConnectPluginInstance.

(Corresponds to NPP object.)

The old NPP_Destroy call has been factored into two plugin instance methods:

Stop – called when the plugin instance is to be stopped (e.g. by displaying another plugin manager window, causing the page containing the plugin to become removed from the display).

Destroy – called once, before the plugin instance peer is to be destroyed. This method is used to destroy the plugin instance.

Definition at line 75 of file nsIPluginInstanceOld.idl.

Member Function Documentation

void nsIPluginInstanceOld::destroy ( )

Called to instruct the plugin instance to destroy itself.

This is called when it become no longer possible to return to the plugin instance, either because the browser window's history list of pages is being trimmed, or because the window containing this page in the history is being closed.

Returns: - NS_OK if this operation was successful

void nsIPluginInstanceOld::getValue	(	in nsPluginInstanceVariable	aVariable,
		in voidPtr	aValue
	)

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

Parameters

aVariable	- the plugin instance variable to get
aValue	- the address of where to store the resulting value

Returns: - NS_OK if this operation was successful

void nsIPluginInstanceOld::handleEvent	(	in nsPluginEventPtr	aEvent,
		out boolean	aHandled
	)

Handles an event.

An nsIEventHandler can also get registered with with nsIPluginManager2::RegisterWindow and will be called whenever an event comes in for that window.

Note that for Unix and Mac the nsPluginEvent structure is different from the old NPEvent structure – it's no longer the native event record, but is instead a struct. This was done for future extensibility, and so that the Mac could receive the window argument too. For Windows and OS2, it's always been a struct, so there's no change for them.

(Corresponds to NPP_HandleEvent.)

Parameters

aEvent	- the event to be handled
aHandled	- set to PR_TRUE if event was handled

Returns: - NS_OK if this operation was successful

void nsIPluginInstanceOld::initialize ( in nsIPluginInstancePeer aPeer )

Initializes a newly created plugin instance, passing to it the plugin instance peer which it should use for all communication back to the browser.

Parameters

aPeer - the corresponding plugin instance peer

Returns: - NS_OK if this operation was successful

void nsIPluginInstanceOld::newStream ( out nsIPluginStreamListener aListener )

Called to tell the plugin that the initial src/data stream is ready.

Expects the plugin to return a nsIPluginStreamListener.

(Corresponds to NPP_NewStream.)

Parameters

aListener - listener the browser will use to give the plugin the data

Returns: - NS_OK if this operation was successful

void nsIPluginInstanceOld::print ( in nsPluginPrintPtr aPlatformPrint )

Called to instruct the plugin instance to print itself to a printer.

(Corresponds to NPP_Print.)

Parameters

aPlatformPrint - platform-specific printing information

Returns: - NS_OK if this operation was successful

void nsIPluginInstanceOld::setWindow ( in nsPluginWindowPtr aWindow )

Called when the window containing the plugin instance changes.

(Corresponds to NPP_SetWindow.)

Parameters

aWindow - the plugin window structure

Returns: - NS_OK if this operation was successful

void nsIPluginInstanceOld::start ( )

Called to instruct the plugin instance to start.

This will be called after the plugin is first created and initialized, and may be called after the plugin is stopped (via the Stop method) if the plugin instance is returned to in the browser window's history.

Returns: - NS_OK if this operation was successful

void nsIPluginInstanceOld::stop ( )

Called to instruct the plugin instance to stop, thereby suspending its state.

This method will be called whenever the browser window goes on to display another page and the page containing the plugin goes into the window's history list.

Returns: - NS_OK if this operation was successful

Field Documentation

readonly attribute nsIPluginInstancePeer nsIPluginInstanceOld::peer

Returns a reference back to the plugin instance peer.

This method is used whenever the browser needs to obtain the peer back from a plugin instance. The implementation of this method should be sure to increment the reference count on the peer by calling AddRef.

Parameters

aPeer - the resulting plugin instance peer

Returns: - NS_OK if this operation was successful

Definition at line 96 of file nsIPluginInstanceOld.idl.

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

src/plugin_win32/include/nsIPluginInstanceOld.idl

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation