Collapse all Symbian^3 Application Developer Library

CEikEmbeddableAppList Class Reference

class CEikEmbeddableAppList : public CArrayFixFlat< TApaAppInfo >

Provides a list of all embeddable applications on the device.

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

TApaAppCapability::iAppIsHidden

Inherits from

CEikEmbeddableAppList
- CArrayFixFlat< TApaAppInfo >
  - CArrayFix
    - CArrayFixBase
      - CBase

Public Member Functions
	CEikEmbeddableAppList ()
	~CEikEmbeddableAppList ()
IMPORT_C void	ConstructL ()
IMPORT_C void	ConstructL (const TApaEmbeddabilityFilter &)
IMPORT_C CEikDocument *	CreateEmbeddedDocumentL ( TInt , CApaProcess *)

Private Member Functions
IMPORT_C void	CEikEmbeddableAppList_Reserved1 ()
IMPORT_C void	CEikEmbeddableAppList_Reserved2 ()
TInt	DoGetAppListL ( RApaLsSession &, const TApaEmbeddabilityFilter &)
TInt	GetAppListL (const TApaEmbeddabilityFilter &)
IMPORT_C TInt	MdcaCount ()
IMPORT_C TPtrC	MdcaPoint ( TInt )
void	SortAppListL ()

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()

Private Attributes
TInt	iCEikEmbeddableAppList_Reserved1

Constructor & Destructor Documentation

CEikEmbeddableAppList()

IMPORT_C

CEikEmbeddableAppList

(

)

Default constructor.

~CEikEmbeddableAppList()

IMPORT_C

~CEikEmbeddableAppList

(

)

Destructor.

Member Functions Documentation

CEikEmbeddableAppList_Reserved1()

IMPORT_C void

CEikEmbeddableAppList_Reserved1

(

)

[private, virtual]

CEikEmbeddableAppList_Reserved2()

IMPORT_C void

CEikEmbeddableAppList_Reserved2

(

)

[private, virtual]

ConstructL()

IMPORT_C void

ConstructL

(

)

Completes construction; populates and sorts the list.

leave: KErrGeneral The apparc server's initial population of the list has not completed.

ConstructL(const TApaEmbeddabilityFilter &)

IMPORT_C void

ConstructL

(

const TApaEmbeddabilityFilter &

aFilter

)

Completes construction; populates and sorts the list.

leave: KErrGeneral The apparc server's initial population of the list has not completed.

Parameters

const TApaEmbeddabilityFilter & aFilter

Defines the filter to be applied to the list.

CreateEmbeddedDocumentL(TInt, CApaProcess *)

IMPORT_C CEikDocument *	CreateEmbeddedDocumentL	(	TInt	aIndex,
			CApaProcess *	aProcess
		)

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

CApaProcess::AddNewDocumentL()

Parameters

TInt aIndex	Index of the application in the list of embeddable applications, for which a document should be created.
CApaProcess * aProcess	A pointer to the process object that manages the list of documents. An application can use iEikonEnv->Process() to provide this.

DoGetAppListL(RApaLsSession &, const TApaEmbeddabilityFilter &)

TInt	DoGetAppListL	(	RApaLsSession &	aLs,
			const TApaEmbeddabilityFilter &	aFilter
		)	[private]

Parameters

RApaLsSession & aLs
const TApaEmbeddabilityFilter & aFilter

GetAppListL(const TApaEmbeddabilityFilter &)

TInt

GetAppListL

(

const TApaEmbeddabilityFilter &

aFilter

)

[private]

Parameters

const TApaEmbeddabilityFilter & aFilter

MdcaCount()

IMPORT_C TInt

MdcaCount

(

)

const [private]

MDesCArray::MdcaCount()

MdcaPoint(TInt)

IMPORT_C TPtrC

MdcaPoint

(

TInt

aIndex

)

const [private]

MDesCArray::MdcaPoint(TInt aIndex)

Parameters

TInt aIndex

SortAppListL()

void

SortAppListL

(

)

[private]

Member Data Documentation

TInt iCEikEmbeddableAppList_Reserved1

TInt

iCEikEmbeddableAppList_Reserved1

[private]