Plugin Manager 2 Interface These extensions to nsIPluginManager are only available in Communicator 5.0. More...

import"nsIPluginManager2.idl";

Inheritance diagram for nsIPluginManager2:

Public Member Functions
void	beginWaitCursor ()
	Puts up a wait cursor. More...

void	endWaitCursor ()
	Restores the previous (non-wait) cursor. More...

void	supportsURLProtocol (in string aProtocol, out boolean aResult)
	Returns true if a URL protocol (e.g. More...

void	notifyStatusChange (in nsIPlugin aPlugin, in nsresult aStatus)
	This method may be called by the plugin to indicate that an error has occurred, e.g. More...

void	findProxyForURL (in string aURL, out string aResult)
	Returns the proxy info for a given URL. More...

void	registerWindow (in nsIEventHandler aHandler, in nsPluginPlatformWindowRef aWindow)
	Registers a top-level window with the browser. More...

void	unregisterWindow (in nsIEventHandler aHandler, in nsPluginPlatformWindowRef aWindow)
	Unregisters a top-level window with the browser. More...

void	allocateMenuID (in nsIEventHandler aHandler, in boolean aIsSubmenu, out short aResult)
	Allocates a new menu ID (for the Mac). More...

void	deallocateMenuID (in nsIEventHandler aHandler, in short aMenuID)
	Deallocates a menu ID (for the Mac). More...

void	hasAllocatedMenuID (in nsIEventHandler aHandler, in short aMenuID, out boolean aResult)
	Indicates whether this event handler has allocated the given menu ID. More...

Public Member Functions inherited from nsIPluginManager
void	GetValue (in nsPluginManagerVariable variable, in nativeVoid value)
	Returns the value of a variable associated with the plugin manager. More...

void	reloadPlugins (in boolean reloadPages)
	Causes the plugins directory to be searched again for new plugin libraries. More...

void	UserAgent (in nativeChar resultingAgentString)
	Returns the user agent string for the browser. More...

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

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

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

void	UnregisterPlugin (in REFNSIID aCID)
	Unregister a plugin from the plugin manager. More...

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

Detailed Description

Plugin Manager 2 Interface These extensions to nsIPluginManager are only available in Communicator 5.0.

Definition at line 50 of file nsIPluginManager2.idl.

Member Function Documentation

void nsIPluginManager2::allocateMenuID	(	in nsIEventHandler	aHandler,
		in boolean	aIsSubmenu,
		out short	aResult
	)

Allocates a new menu ID (for the Mac).

Parameters

aHandler	- the event handler for the window
aIsSubmenu	- whether this is a sub-menu ID or not
aResult	- the resulting menu ID

Returns: - NS_OK if this operation was successful

void nsIPluginManager2::beginWaitCursor ( )

Puts up a wait cursor.

Returns: - NS_OK if this operation was successful

void nsIPluginManager2::deallocateMenuID	(	in nsIEventHandler	aHandler,
		in short	aMenuID
	)

Deallocates a menu ID (for the Mac).

Parameters

aHandler	- the event handler for the window
aMenuID	- the menu ID

Returns: - NS_OK if this operation was successful

void nsIPluginManager2::endWaitCursor ( )

Restores the previous (non-wait) cursor.

Returns: - NS_OK if this operation was successful

void nsIPluginManager2::findProxyForURL	(	in string	aURL,
		out string	aResult
	)

Returns the proxy info for a given URL.

The caller is required to free the resulting memory with nsIMalloc::Free. The result will be in the following format

i) "DIRECT" – no proxy ii) "PROXY xxx.xxx.xxx.xxx" – use proxy iii) "SOCKS xxx.xxx.xxx.xxx" – use SOCKS iv) Mixed. e.g. "PROXY 111.111.111.111;PROXY 112.112.112.112", "PROXY 111.111.111.111;SOCKS 112.112.112.112"....

Which proxy/SOCKS to use is determined by the plugin.

void nsIPluginManager2::hasAllocatedMenuID	(	in nsIEventHandler	aHandler,
		in short	aMenuID,
		out boolean	aResult
	)

Indicates whether this event handler has allocated the given menu ID.

Parameters

aHandler	- the event handler for the window
aMenuID	- the menu ID
aResult	- returns PR_TRUE if the menu ID is allocated

Returns: - NS_OK if this operation was successful

void nsIPluginManager2::notifyStatusChange	(	in nsIPlugin	aPlugin,
		in nsresult	aStatus
	)

This method may be called by the plugin to indicate that an error has occurred, e.g.

that the plugin has failed or is shutting down spontaneously. This allows the browser to clean up any plugin-specific state.

Parameters

aPlugin	- the plugin whose status is changing
aStatus	- the error status value

Returns: - NS_OK if this operation was successful

void nsIPluginManager2::registerWindow	(	in nsIEventHandler	aHandler,
		in nsPluginPlatformWindowRef	aWindow
	)

Registers a top-level window with the browser.

Events received by that window will be dispatched to the event handler specified.

Parameters

aHandler	- the event handler for the window
aWindow	- the platform window reference

Returns: - NS_OK if this operation was successful

void nsIPluginManager2::supportsURLProtocol	(	in string	aProtocol,
		out boolean	aResult
	)

Returns true if a URL protocol (e.g.

"http") is supported.

Parameters

aProtocol	- the protocol name
aResult	- true if the protocol is supported

Returns: - NS_OK if this operation was successful

void nsIPluginManager2::unregisterWindow	(	in nsIEventHandler	aHandler,
		in nsPluginPlatformWindowRef	aWindow
	)

Unregisters a top-level window with the browser.

The handler and window pair should be the same as that specified to RegisterWindow.

Parameters

aHandler	- the event handler for the window
aWindow	- the platform window reference

Returns: - NS_OK if this operation was successful

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

src/plugin_win32/include/nsIPluginManager2.idl

Public Member Functions

Detailed Description

Member Function Documentation