Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIPluginManager Interface Reference

import "nsIPluginManager.idl";

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

List of all members.

Public Member Functions

void GetValue (in nsPluginManagerVariable variable, in nativeVoid value)
 Returns the value of a variable associated with the plugin manager.
void reloadPlugins (in boolean reloadPages)
 Causes the plugins directory to be searched again for new plugin libraries.
void UserAgent (in nativeChar resultingAgentString)
 Returns the user agent string for the browser.
NS_IMETHOD GetURL (nsISupports *pluginInst, const char *url, const char *target=NULL, nsIPluginStreamListener *streamListener=NULL, const char *altHost=NULL, const char *referrer=NULL, PRBool forceJSEnabled=PR_FALSE)=0
 Fetches a URL.
NS_IMETHOD PostURL (nsISupports *pluginInst, const char *url, PRUint32 postDataLen, const char *postData, PRBool isFile=PR_FALSE, const char *target=NULL, nsIPluginStreamListener *streamListener=NULL, const char *altHost=NULL, const char *referrer=NULL, PRBool forceJSEnabled=PR_FALSE, PRUint32 postHeadersLength=0, const char *postHeaders=NULL)=0
 Posts to a URL with post data and/or post headers.
void RegisterPlugin (in REFNSIID aCID, in string aPluginName, in string aDescription, in nativeChar aMimeTypes, in nativeChar aMimeDescriptions, in nativeChar aFileExtensions, in long aCount)
 Persistently register a plugin with the plugin manager.
void UnregisterPlugin (in REFNSIID aCID)
 Unregister a plugin from the plugin manager.
NS_IMETHOD GetURLWithHeaders (nsISupports *pluginInst, const char *url, const char *target=NULL, nsIPluginStreamListener *streamListener=NULL, const char *altHost=NULL, const char *referrer=NULL, PRBool forceJSEnabled=PR_FALSE, PRUint32 getHeadersLength=0, const char *getHeaders=NULL)=0
 Fetches a URL, with Headers.

Detailed Description

Definition at line 77 of file nsIPluginManager.idl.


Member Function Documentation

NS_IMETHOD nsIPluginManager::GetURL ( nsISupports *  pluginInst,
const char *  url,
const char *  target = NULL,
nsIPluginStreamListener streamListener = NULL,
const char *  altHost = NULL,
const char *  referrer = NULL,
PRBool  forceJSEnabled = PR_FALSE 
) [pure virtual]

Fetches a URL.

(Corresponds to NPN_GetURL and NPN_GetURLNotify.)

Parameters:
pluginInst- the plugin making the request. If NULL, the URL is fetched in the background.
url- the URL to fetch
target- the target window into which to load the URL, or NULL if the data should be returned to the plugin via streamListener.
streamListener- a stream listener to be used to return data to the plugin. May be NULL if target is not NULL.
altHost- an IP-address string that will be used instead of the host specified in the URL. This is used to prevent DNS-spoofing attacks. Can be defaulted to NULL meaning use the host in the URL.
referrer- the referring URL (may be NULL)
forceJSEnabled- forces JavaScript to be enabled for 'javascript:' URLs, even if the user currently has JavaScript disabled (usually specify PR_FALSE)
Returns:
- NS_OK if this operation was successful

Implemented in nsPluginHostImpl, CPluginManager, and CPluginManager.

Here is the caller graph for this function:

NS_IMETHOD nsIPluginManager::GetURLWithHeaders ( nsISupports *  pluginInst,
const char *  url,
const char *  target = NULL,
nsIPluginStreamListener streamListener = NULL,
const char *  altHost = NULL,
const char *  referrer = NULL,
PRBool  forceJSEnabled = PR_FALSE,
PRUint32  getHeadersLength = 0,
const char *  getHeaders = NULL 
) [pure virtual]

Fetches a URL, with Headers.

See also:
GetURL. Identical except for additional params headers and headersLen
Parameters:
getHeadersLength- the length of getHeaders (if non-NULL)
getHeaders- the headers to GET. Must be in the form of "HeaderName: HeaderValue\r\n". Each header, including the last, must be followed by "\r\n". NULL specifies that there are no get headers
Returns:
- NS_OK if this operation was successful

Implemented in nsPluginHostImpl, and CPluginManager.

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

(Corresponds to NPN_GetValue.)

Parameters:
variable- the plugin manager variable to get
value- the address of where to store the resulting value
Returns:
- NS_OK if this operation was successful
NS_IMETHOD nsIPluginManager::PostURL ( nsISupports *  pluginInst,
const char *  url,
PRUint32  postDataLen,
const char *  postData,
PRBool  isFile = PR_FALSE,
const char *  target = NULL,
nsIPluginStreamListener streamListener = NULL,
const char *  altHost = NULL,
const char *  referrer = NULL,
PRBool  forceJSEnabled = PR_FALSE,
PRUint32  postHeadersLength = 0,
const char *  postHeaders = NULL 
) [pure virtual]

Posts to a URL with post data and/or post headers.

(Corresponds to NPN_PostURL and NPN_PostURLNotify.)

Parameters:
pluginInst- the plugin making the request. If NULL, the URL is fetched in the background.
url- the URL to fetch
postDataLength- the length of postData (if non-NULL)
postData- the data to POST. NULL specifies that there is not post data
isFile- whether the postData specifies the name of a file to post instead of data. The file will be deleted afterwards.
target- the target window into which to load the URL, or NULL if the data should be returned to the plugin via streamListener.
streamListener- a stream listener to be used to return data to the plugin. May be NULL if target is not NULL.
altHost- an IP-address string that will be used instead of the host specified in the URL. This is used to prevent DNS-spoofing attacks. Can be defaulted to NULL meaning use the host in the URL.
referrer- the referring URL (may be NULL)
forceJSEnabled- forces JavaScript to be enabled for 'javascript:' URLs, even if the user currently has JavaScript disabled (usually specify PR_FALSE)
postHeadersLength- the length of postHeaders (if non-NULL)
postHeaders- the headers to POST. Must be in the form of "HeaderName: HeaderValue\r\n". Each header, including the last, must be followed by "\r\n". NULL specifies that there are no post headers
Returns:
- NS_OK if this operation was successful

Implemented in nsPluginHostImpl, CPluginManager, and CPluginManager.

void nsIPluginManager::RegisterPlugin ( in REFNSIID  aCID,
in string  aPluginName,
in string  aDescription,
in nativeChar  aMimeTypes,
in nativeChar  aMimeDescriptions,
in nativeChar  aFileExtensions,
in long  aCount 
)

Persistently register a plugin with the plugin manager.

aMimeTypes, aMimeDescriptions, and aFileExtensions are parallel arrays that contain information about the MIME types that the plugin supports.

Parameters:
aCID- the plugin's CID
aPluginName- the plugin's name
aDescription- a description of the plugin
aMimeTypes- an array of MIME types that the plugin is prepared to handle
aMimeDescriptions- an array of descriptions for the MIME types that the plugin can handle.
aFileExtensions- an array of file extensions for the MIME types that the plugin can handle.
aCount- the number of elements in the aMimeTypes, aMimeDescriptions, and aFileExtensions arrays.
Returns:
- NS_OK if the operation was successful.

Here is the caller graph for this function:

Causes the plugins directory to be searched again for new plugin libraries.

(Corresponds to NPN_ReloadPlugins.)

Parameters:
reloadPages- indicates whether currently visible pages should also be reloaded

Unregister a plugin from the plugin manager.

Parameters:
aCIDthe CID of the plugin to unregister.
Returns:
- NS_OK if the operation was successful.

Here is the caller graph for this function:

void nsIPluginManager::UserAgent ( in nativeChar  resultingAgentString)

Returns the user agent string for the browser.

(Corresponds to NPN_UserAgent.)

Parameters:
resultingAgentString- the resulting user agent string

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