CEikEmbeddableAppList Class Reference

#include <mw/eikembal.h>

Link against: eikcore.lib

class CEikEmbeddableAppList : public CArrayFixFlat< TApaAppInfo >
Public Member Functions
CEikEmbeddableAppList()
~CEikEmbeddableAppList()
IMPORT_C voidConstructL()
IMPORT_C voidConstructL(const TApaEmbeddabilityFilter &)
IMPORT_C CEikDocument *CreateEmbeddedDocumentL(TInt, CApaProcess *)
Inherited Functions
CArrayFix< TApaAppInfo >::AppendL(const TApaAppInfo &)
CArrayFix< TApaAppInfo >::AppendL(const TApaAppInfo &,TInt)
CArrayFix< TApaAppInfo >::AppendL(const TApaAppInfo *,TInt)
CArrayFix< TApaAppInfo >::Array()const
CArrayFix< TApaAppInfo >::At(TInt)
CArrayFix< TApaAppInfo >::At(TInt)const
CArrayFix< TApaAppInfo >::Back(TInt)
CArrayFix< TApaAppInfo >::Back(TInt)const
CArrayFix< TApaAppInfo >::CArrayFix(TBufRep,TInt)
CArrayFix< TApaAppInfo >::End(TInt)
CArrayFix< TApaAppInfo >::End(TInt)const
CArrayFix< TApaAppInfo >::ExpandL(TInt)
CArrayFix< TApaAppInfo >::ExtendL()
CArrayFix< TApaAppInfo >::Find(const TApaAppInfo &,TKeyArrayFix &,TInt &)const
CArrayFix< TApaAppInfo >::FindIsq(const TApaAppInfo &,TKeyArrayFix &,TInt &)const
CArrayFix< TApaAppInfo >::InsertIsqAllowDuplicatesL(const TApaAppInfo &,TKeyArrayFix &)
CArrayFix< TApaAppInfo >::InsertIsqL(const TApaAppInfo &,TKeyArrayFix &)
CArrayFix< TApaAppInfo >::InsertL(TInt,const TApaAppInfo &)
CArrayFix< TApaAppInfo >::InsertL(TInt,const TApaAppInfo &,TInt)
CArrayFix< TApaAppInfo >::InsertL(TInt,const TApaAppInfo *,TInt)
CArrayFix< TApaAppInfo >::ResizeL(TInt)
CArrayFix< TApaAppInfo >::ResizeL(TInt,const TApaAppInfo &)
CArrayFix< TApaAppInfo >::operator[](TInt)
CArrayFix< TApaAppInfo >::operator[](TInt)const
CArrayFixBase::AtR(const CBase *,TInt)
CArrayFixBase::CArrayFixBase(TBufRep,TInt,TInt)
CArrayFixBase::Compress()
CArrayFixBase::Count()const
CArrayFixBase::CountR(const CBase *)
CArrayFixBase::Delete(TInt)
CArrayFixBase::Delete(TInt,TInt)
CArrayFixBase::Find(const TAny *,TKeyArrayFix &,TInt &)const
CArrayFixBase::FindIsq(const TAny *,TKeyArrayFix &,TInt &)const
CArrayFixBase::InsertIsqAllowDuplicatesL(const TAny *,TKeyArrayFix &)
CArrayFixBase::InsertIsqL(const TAny *,TKeyArrayFix &)
CArrayFixBase::InsertL(TInt,const TAny *)
CArrayFixBase::InsertL(TInt,const TAny *,TInt)
CArrayFixBase::InsertRepL(TInt,const TAny *,TInt)
CArrayFixBase::Length()const
CArrayFixBase::Reset()
CArrayFixBase::ResizeL(TInt,const TAny *)
CArrayFixBase::SetKey(TKeyArrayFix &)const
CArrayFixBase::SetReserveFlatL(TInt)
CArrayFixBase::Sort(TKeyArrayFix &)
CArrayFixBase::~CArrayFixBase()
CArrayFixFlat< TApaAppInfo >::CArrayFixFlat(TInt)
CArrayFixFlat< TApaAppInfo >::SetReserveL(TInt)
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()

Detailed Description

Provides a list of all embeddable applications on the device.

Hidden applications are omitted from the list. The list is sorted by UID.

See also: TApaAppCapability::iAppIsHidden

Constructor & Destructor Documentation

CEikEmbeddableAppList ( )

IMPORT_CCEikEmbeddableAppList()

Default constructor.

~CEikEmbeddableAppList ( )

IMPORT_C~CEikEmbeddableAppList()

Destructor.

Member Function Documentation

ConstructL ( )

IMPORT_C voidConstructL()

Completes construction; populates and sorts the list.

Leave Codes
KErrGeneralThe apparc server's initial population of the list has not completed.

ConstructL ( const TApaEmbeddabilityFilter & )

IMPORT_C voidConstructL(const TApaEmbeddabilityFilter &aFilter)

Completes construction; populates and sorts the list.

Parameters
aFilterDefines the filter to be applied to the list.
Leave Codes
KErrGeneralThe apparc server's initial population of the list has not completed.

CreateEmbeddedDocumentL ( TInt, CApaProcess * )

IMPORT_C CEikDocument *CreateEmbeddedDocumentL(TIntaIndex,
CApaProcess *aProcess
)

Creates and returns a document of the correct type for the indexed embeddable application. Ultimately calls the application's CreateDocumentL() function.

See also: CApaProcess::AddNewDocumentL()

Parameters
aIndexIndex of the application in the list of embeddable applications, for which a document should be created.
aProcessA pointer to the process object that manages the list of documents. An application can use iEikonEnv->Process() to provide this.
Return Value
The new embeddable document.