CGSParentPlugin Class Reference

class CGSParentPlugin : public CGSPluginInterface

CGSParentPlugin view class. Thus is a base class for plugins owning other plugins as their sub-views.

GSFramework.lib
Since
Series60_3.1

Inherits from

Nested Classes and Structures

  • CGSParentPlugin::TListBoxPosition
Public Member Functions
~CGSParentPlugin ()
IMPORT_C void BaseConstructL ( TInt , TInt )
void CheckMiddleSoftkeyLabelL ()
IMPORT_C void GetHelpContext ( TCoeHelpContext &)
IMPORT_C void HandlePluginLoaded (KGSPluginLoaderStatus)
IMPORT_C TGSListboxTypes ListBoxType ()
IMPORT_C void OpenLocalizedResourceFileL (const TDesC &, RConeResourceLoader &)
IMPORT_C const TBitFlags & OptionFlags ()
void RequestPriority ( CActive::TPriority )
IMPORT_C void ResetSelectedItemIndex ()
IMPORT_C CGSPluginInterface * SelectedPlugin ()
void SetMiddleSoftKeyLabelL (const TInt , const TInt )
void SetMiddleSoftKeyLabelTextL (const TPtr , const TInt )
IMPORT_C void SetOptionFlags ( TBitFlags &)
IMPORT_C void TransferDynamicPluginL ( CGSPluginInterface *)
IMPORT_C void UpdateView ()
IMPORT_C TUid UpperLevelViewUid ()
Protected Member Functions
CGSParentPlugin ()
IMPORT_C void DoActivateL (const TVwsViewId &, TUid , const TDesC8 &)
IMPORT_C void DoDeactivate ()
IMPORT_C void DynInitMenuPaneL ( TInt , CEikMenuPane *)
IMPORT_C void HandleCommandL ( TInt )
Private Member Functions
void ConstructContainerL ()
void RemoveCommandFromMSK ( TInt )
void StartAsyncPluginLoadL ()
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::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()
CGSPluginInterface::CGSPluginInterface()
CGSPluginInterface::CreateIconL(const TUid)
CGSPluginInterface::CustomOperationL(TAny *,TAny *)
CGSPluginInterface::GetCaptionL(TDes &)const
CGSPluginInterface::GetEcomDestructorKey()
CGSPluginInterface::GetValue(const TGSPluginValueKeys,TDes &)
CGSPluginInterface::HandleSelection(const TGSSelectionTypes)
CGSPluginInterface::ItemType()
CGSPluginInterface::MenuActivationItem()
CGSPluginInterface::NewL(const TUid,TAny *)
CGSPluginInterface::PluginProviderCategory()const
CGSPluginInterface::SetOrder(TInt)
CGSPluginInterface::Visible()const
CGSPluginInterface::~CGSPluginInterface()
Inherited Enumerations
CGSPluginInterface:TGSPluginProviderCategory
Protected Attributes
TVwsViewId iPrevViewId
Private Attributes
CAknViewAppUi * iAppUi
CGSParentContainer * iContainer
TBool iIsLandscapeOrientation
TInt iMskCommandId
TBitFlags iOptionFlags
CArrayPtrFlat < CGSPluginInterface > * iPluginArray
CGSPluginLoader * iPluginLoader
TListBoxPosition iPosition
RConeResourceLoader iResourceLoader
TUid iSelectedPluginUid
TInt iTitleRscId
TUid iTopPluginUid
Inherited Attributes
CAknView::iCoeEnv

Constructor & Destructor Documentation

CGSParentPlugin()

IMPORT_C CGSParentPlugin ( ) [protected]

See base class.

~CGSParentPlugin()

IMPORT_C ~CGSParentPlugin ( )

Destructor.

Member Functions Documentation

BaseConstructL(TInt, TInt)

IMPORT_C void BaseConstructL ( TInt aViewRscId,
TInt aTitleRscId
)

Symbian OS default constructor. Call this from sub classes.

Parameters

TInt aViewRscId
TInt aTitleRscId

CheckMiddleSoftkeyLabelL()

void CheckMiddleSoftkeyLabelL ( )

Checks if the MSK label needs to be adjusted.

ConstructContainerL()

void ConstructContainerL ( ) [private]

Constructs container for this view.

DoActivateL(const TVwsViewId &, TUid, const TDesC8 &)

IMPORT_C void DoActivateL ( const TVwsViewId & aPrevViewId,
TUid aCustomMessageId,
const TDesC8 & aCustomMessage
) [protected, virtual]

See base class.

Parameters

const TVwsViewId & aPrevViewId
TUid aCustomMessageId
const TDesC8 & aCustomMessage

DoDeactivate()

IMPORT_C void DoDeactivate ( ) [protected, virtual]

See base class.

DynInitMenuPaneL(TInt, CEikMenuPane *)

IMPORT_C void DynInitMenuPaneL ( TInt aResourceId,
CEikMenuPane * aMenuPane
) [protected]

See base class.

Parameters

TInt aResourceId
CEikMenuPane * aMenuPane

GetHelpContext(TCoeHelpContext &)

IMPORT_C void GetHelpContext ( TCoeHelpContext & aContext ) [virtual]

Provides help context. This should be implemented by CGSParentPlugin sub class in case help is needed. Normally this is defined in CCoeControl derived class but since all parent plugin implementations have only CGSParentContainer class as the only CCoeControl derived class, and need still their own unique help contexts, this function is needed in view level class.

Parameters

TCoeHelpContext & aContext

HandleCommandL(TInt)

IMPORT_C void HandleCommandL ( TInt aCommand ) [protected, virtual]

See base class.

Parameters

TInt aCommand

HandlePluginLoaded(KGSPluginLoaderStatus)

IMPORT_C void HandlePluginLoaded ( KGSPluginLoaderStatus aStatus )

See base class.

Parameters

KGSPluginLoaderStatus aStatus

ListBoxType()

IMPORT_C TGSListboxTypes ListBoxType ( ) [virtual]

Defines the type of the used listbox visualising the child plugins. Classes deriving from CGSParentContainer can override this function to define the used type of the listbox. Otherwise default value EGSListBoxTypeSingleLarge is used.

OpenLocalizedResourceFileL(const TDesC &, RConeResourceLoader &)

IMPORT_C void OpenLocalizedResourceFileL ( const TDesC & aResourceFileName,
RConeResourceLoader & aResourceLoader
)

Opens the nearest localized resourcefile using aResourceLoader. aResourceLoader should be opened only once before closing it. Otherwise it will raise a panic. Therefore it is better to have multiple resource loaders. Uses KDC_RESOURCE_FILES_DIR.

Parameters

const TDesC & aResourceFileName Drive and name of resource file in format <path>:<rsc_file_name>
RConeResourceLoader & aResourceLoader Resource loader for the resource. The loader must not be opened allready or it will raise a panic. It is caller's responsibility to close the resource loader after using the resource.

OptionFlags()

IMPORT_C const TBitFlags & OptionFlags ( ) const [virtual]

Gets currently used option flags.

RemoveCommandFromMSK(TInt)

void RemoveCommandFromMSK ( TInt aMskCommandId ) [private]

Remove command from MSK.

Parameters

TInt aMskCommandId ID of the command to be removed.

RequestPriority(CActive::TPriority)

void RequestPriority ( CActive::TPriority aPriority )

Attempts to change child plugin load priority on next RunL cycle. Use this if parent needs to change plugin loader priority. Normally when parent plugin view is opened, it is advisable to increase loader priority to get child plugins loaded faster.

Parameters

CActive::TPriority aPriority Desired priority.

ResetSelectedItemIndex()

IMPORT_C void ResetSelectedItemIndex ( ) [virtual]

See base class.

SelectedPlugin()

IMPORT_C CGSPluginInterface * SelectedPlugin ( )

SetMiddleSoftKeyLabelL(const TInt, const TInt)

void SetMiddleSoftKeyLabelL ( const TInt aResourceId,
const TInt aCommandId
)

Adds given resource text as MSK to CBA. Use either this or SetMiddleSoftKeyLabelTextL in in case text is used deirectly instead of resource.

Since
S60 v3.1

Parameters

const TInt aResourceId middle softkey label.
const TInt aCommandId command that should be performed when MSK is pressed.

SetMiddleSoftKeyLabelTextL(const TPtr, const TInt)

void SetMiddleSoftKeyLabelTextL ( const TPtr aMskLabel,
const TInt aCommandId
)

Adds given text as MSK to CBA.

Since
S60 v3.1

Parameters

const TPtr aMskLabel middle softkey label.
const TInt aCommandId command that should be performed when MSK is pressed.

SetOptionFlags(TBitFlags &)

IMPORT_C void SetOptionFlags ( TBitFlags & aOptionFlags ) [virtual]

Defines custom options for parent plugin. Use TGSOptionFlagIndexes to enable a combination of bit flags.

Parameters

TBitFlags & aOptionFlags Option combination created by combining binary option flags.

StartAsyncPluginLoadL()

void StartAsyncPluginLoadL ( ) [private]

Used in lazy loading. Starts loading the plugins.

TransferDynamicPluginL(CGSPluginInterface *)

IMPORT_C void TransferDynamicPluginL ( CGSPluginInterface * aPlugin )

Parameters

CGSPluginInterface * aPlugin

UpdateView()

IMPORT_C void UpdateView ( ) [virtual]

Updates plugin's view. This can be used when child plugin's values are changed.

UpperLevelViewUid()

IMPORT_C TUid UpperLevelViewUid ( ) [virtual]

Member Data Documentation

CAknViewAppUi * iAppUi

CAknViewAppUi * iAppUi [private]

CGSParentContainer * iContainer

CGSParentContainer * iContainer [private]

TBool iIsLandscapeOrientation

TBool iIsLandscapeOrientation [private]

TInt iMskCommandId

TInt iMskCommandId [private]

TBitFlags iOptionFlags

TBitFlags iOptionFlags [private]

CArrayPtrFlat< CGSPluginInterface > * iPluginArray

CArrayPtrFlat < CGSPluginInterface > * iPluginArray [private]

CGSPluginLoader * iPluginLoader

CGSPluginLoader * iPluginLoader [private]

TListBoxPosition iPosition

TListBoxPosition iPosition [private]

TVwsViewId iPrevViewId

TVwsViewId iPrevViewId [protected]

RConeResourceLoader iResourceLoader

RConeResourceLoader iResourceLoader [private]

TUid iSelectedPluginUid

TUid iSelectedPluginUid [private]

TInt iTitleRscId

TInt iTitleRscId [private]

TUid iTopPluginUid

TUid iTopPluginUid [private]