FreeWRL/FreeX3D  3.0.0
nsIPlugin Interface Reference
Inheritance diagram for nsIPlugin:

Public Member Functions

void createPluginInstance (out nsIPluginInstance aResult)
 Creates a new plugin instance, based on a MIME type. More...
 
void initialize ()
 Initializes the plugin and will be called before any new instances are created. More...
 
void shutdown ()
 Called when the browser is done with the plugin factory, or when the plugin is disabled by the user. More...
 
void getMIMEDescription (out constCharPtr aMIMEDescription)
 Returns the MIME description for the plugin. More...
 
void getValue (in nsPluginVariable aVariable, in voidPtr aValue)
 Returns the value of a variable associated with the plugin. More...
 

Detailed Description

Definition at line 51 of file nsIPlugin.idl.

Member Function Documentation

void nsIPlugin::createPluginInstance ( out nsIPluginInstance  aResult)

Creates a new plugin instance, based on a MIME type.

This allows different impelementations to be created depending on the specified MIME type.

void nsIPlugin::getMIMEDescription ( out constCharPtr  aMIMEDescription)

Returns the MIME description for the plugin.

The MIME description is a colon-separated string containg the plugin MIME type, plugin data file extension, and plugin name, e.g.:

"application/x-simple-plugin:smp:Simple Sample Plug-in"

(Corresponds to NPP_GetMIMEDescription.)

Parameters
aMIMEDescription- the resulting MIME description
Returns
- NS_OK if this operation was successful
void nsIPlugin::getValue ( in nsPluginVariable  aVariable,
in voidPtr  aValue 
)

Returns the value of a variable associated with the plugin.

(Corresponds to NPP_GetValue.)

Parameters
aVariable- the plugin variable to get
aValue- the address of where to store the resulting value
Returns
- NS_OK if this operation was successful
void nsIPlugin::initialize ( )

Initializes the plugin and will be called before any new instances are created.

It is passed browserInterfaces on which QueryInterface may be used to obtain an nsIPluginManager, and other interfaces.

Parameters
browserInterfaces- an object that allows access to other browser interfaces via QueryInterface
Returns
- NS_OK if this operation was successful
void nsIPlugin::shutdown ( )

Called when the browser is done with the plugin factory, or when the plugin is disabled by the user.

(Corresponds to NPP_Shutdown.)

Returns
- NS_OK if this operation was successful

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