S60 3rd Edition API Reference: MPluginAdapter Class Reference

MPluginAdapter Class Reference

API published in: S60 2nd Ed FP 2

Link against:

Capability Information

Required Capabilities

DRM LocalServices NetworkControl NetworkServices ReadDeviceData ReadUserData SwEvent UserEnvironment WriteDeviceData WriteUserData

Exceptions

#include <pluginadapterinterface.h>

Detailed Description

The plug-in can use this interface to communicate with the browser.

Public Member Functions

virtual TUint16 GetVersion ()=0
 Gets the pointer to the minor version number of the plug-in version number of the Browser Plug-in API.
virtual void PluginConstructedL (CCoeControl *aPluginControl)=0
 Called when the plug-in has completed its creation.
virtual void PluginFinishedL ()=0
 Called after the plug-in has been deleted.
virtual CCoeControl * GetParentControl ()=0
 Returns the window system level control object for the plug-in.
virtual MCoeControlObserver * GetParentControlObserver ()=0
 Returns the observer for the plug-in control.
virtual void SetPluginNotifier (MPluginNotifier *aNotifier)=0
 Sets the plug-in notifier allowing the plug-in to control portions of the browser.
virtual void SetOptionMenuHandler (MOptionMenuHandler *)
 Sets the plug-in option menu handler allowing the plug-in to handle the custom menu commands from the browser.

Member Function Documentation

virtual CCoeControl* MPluginAdapter::GetParentControl (   )  [pure virtual]
 

Returns the window system level control object for the plug-in.

Returns:
A pointer to the parent control window.
virtual MCoeControlObserver* MPluginAdapter::GetParentControlObserver (   )  [pure virtual]
 

Returns the observer for the plug-in control.

Returns:
Observer that the plug-in can use to send events to the browser.
virtual TUint16 MPluginAdapter::GetVersion (   )  [pure virtual]
 

Gets the pointer to the minor version number of the plug-in version number of the Browser Plug-in API.

Returns:
Series 60 returns 1. Series 80 and the Nokia 7710 smartphone return 101.
virtual void MPluginAdapter::PluginConstructedL ( CCoeControl *  aPluginControl  )  [pure virtual]
 

Called when the plug-in has completed its creation.

This function is called from the constructL function of the plug-in.

Parameters:
aPluginControl A pointer to the plug-in control window
Returns:
None
virtual void MPluginAdapter::PluginFinishedL (   )  [pure virtual]
 

Called after the plug-in has been deleted.

This function is called from the destructor of the plug-in.

Returns:
None
virtual void MPluginAdapter::SetOptionMenuHandler ( MOptionMenuHandler *   )  [inline, virtual]
 

Sets the plug-in option menu handler allowing the plug-in to handle the custom menu commands from the browser.

Public Since 3rd Ed FP1

Parameters:
aOptionMenuHandler Pointer to an interface that the browser can use to send option menu commands to the plug-in.
Returns:
None
virtual void MPluginAdapter::SetPluginNotifier ( MPluginNotifier *  aNotifier  )  [pure virtual]
 

Sets the plug-in notifier allowing the plug-in to control portions of the browser.

Parameters:
aNotifier Pointer to an interface that the browser can use to send events to the plug-in.
Returns:
None
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top