CPslnFWPluginInterface Class Reference
| class CPslnFWPluginInterface : public CAknView |
Interface class for Psln plugin. All Psln plugins will implement this class.
The main functionality Psln framework will use from CAknView is: -DoActivate() -DoDeactivate() -Id() functions.
Id() function must return the value of the plugin implementation UID. This means that the main view of the plugin will have the same UID as the plugin implementation. This will prevent multiple plugins from having same view UIDs as their main view. If plugin has more views, it is plugin's responsibility to ensure that the UIDs of the other views are unique.
This class is mutually exclusive with CPslnFWPluginInterface as defined in the PslnPluginInterfaceNoBaseView.h.
PslnFramework.lib
- Since
- S60 v3.1
| Inherited Functions |
|---|
| | CAknView::ActivateViewL(const TVwsViewId &) |
| | CAknView::ActivateViewL(const TVwsViewId &,TUid,const TDesC8 &) |
| | CAknView::AknViewActivatedL(const TVwsViewId &,TUid,const TDesC8 &) |
| | CAknView::AknViewDeactivated() |
| | CAknView::AppUi()const |
| | CAknView::BaseConstructL(TInt) |
| | CAknView::CAknView() |
| | CAknView::Cba()const |
| | CAknView::ClientRect()const |
| | CAknView::ConstructMenuAndCbaEarlyL() |
| | CAknView::CreateAndSetToolbarL(TInt) |
| | CAknView::DoActivateL(const TVwsViewId &,TUid,const TDesC8 &) |
| | CAknView::DoDeactivate() |
| | CAknView::HandleCommandL(TInt) |
| | CAknView::HandleForegroundEventL(TBool) |
| | CAknView::HandleStatusPaneSizeChange() |
| | CAknView::HandleViewRectChange() |
| | CAknView::Id()const |
| | CAknView::IsForeground()const |
| | CAknView::MenuBar()const |
| | CAknView::MopNext() |
| | CAknView::MopSupplyObject(TTypeUid) |
| | CAknView::ProcessCommandL(TInt) |
| | CAknView::ProcessForegroundEventL(TBool) |
| | CAknView::Redraw()const |
| | CAknView::SaveToolbarStatus(TBool,TBool) |
| | CAknView::SetEmphasis(CCoeControl *,TBool) |
| | CAknView::SetToolbar(CAknToolbar *) |
| | CAknView::ShowToolbarOnViewActivation(TBool) |
| | CAknView::StatusPane()const |
| | CAknView::StopDisplayingMenuBar() |
| | CAknView::StopDisplayingToolbar() |
| | CAknView::Toolbar()const |
| | CAknView::ToolbarShownOnViewActivation()const |
| | CAknView::ViewActivatedL(const TVwsViewId &,TUid,const TDesC8 &) |
| | CAknView::ViewDeactivated() |
| | CAknView::ViewId()const |
| | CAknView::ViewScreenDeviceChangedL() |
| | CAknView::~CAknView() |
| | CBase::CBase() |
| | CBase::Delete(CBase *) |
| | CBase::Extension_(TUint,TAny *&,TAny *) |
| | CBase::operator new(TUint) |
| | CBase::operator new(TUint,TAny *) |
| | CBase::operator new(TUint,TLeave) |
| | CBase::operator new(TUint,TLeave,TUint) |
| | CBase::operator new(TUint,TUint) |
| | CBase::~CBase() |
Constructor & Destructor Documentation
~CPslnFWPluginInterface()
| ~CPslnFWPluginInterface | ( | ) | [inline] |
Member Functions Documentation
CreateIconL()
Creates a new icon. This icon is shown in Personalization app's main view. Ownership of the created icon is transferred to the caller.
CustomOperationL(TAny *, TAny *)
|
TAny * | CustomOperationL | ( | TAny * | aParam1, |
| | TAny * | aParam2 |
| | ) | [inline, virtual] |
Reserved for future use/plugin's custom functionality. This can be overwritten if plugin needs to have custom functionality which cannot be fulfilled otherwise.
GetCaptionL(TDes &)
| void | GetCaptionL | ( | TDes & | aCaption | ) | const [pure virtual] |
Method for getting caption of this plugin. This should be the localized name of the plugin view to be shown in main view.
Parameters
| TDes & aCaption | pointer to Caption variable |
GetLocationTypeAndIndex(TPslnFWLocationType &, TInt &)
Method for getting the plugin view's location within Psln application. Do not override, unless plugin view should be in certain location. By default the plugins are appended to the end of the main view.
GetTabTextL(TDes &)
| void | GetTabTextL | ( | TDes & | aCaption | ) | const [pure virtual] |
Method for getting tab text for this plugin. This should be the localized name of the plugin view to be shown in tab group.
Parameters
| TDes & aCaption | pointer to Caption variable |
NewL(const TUid, CAknViewAppUi *)
Creates new Psln plugin having the given UID. Uses Leave code KErrNotFound if implementation is not found.
Parameters
| const TUid aImplementationUid | Implementation UID of the plugin to be created. |
| CAknViewAppUi * aAppUi | Pointer to the Psln application UI that can be used to switch to another view. |
Member Enumerations Documentation
Enum TPslnFWLocationType
Specifies the location of the plugin in the Personalization application. By default the plugins are appended to the end of the main view.
Enumerators
| EPslnFWNotSpecified = 0 | |
| EPslnFWSpecified | |
Member Data Documentation
CAknViewAppUi * iAppUi
Pointer to application UI. This is protected, so that classes implementing the interface inherit pointer to AppUi. Not own.
TUid
iDtor_ID_Key
|
TUid
| iDtor_ID_Key | [private] |
ECOM plugin instance UID.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.