Class CEikEmbeddableAppList

class CEikEmbeddableAppList : public CArrayFixFlat< TApaAppInfo >, public MDesC16Array;

Description

Provides a list of all embeddable applications on the phone.

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

Derivation

• MDesC16Array - Interface class for 16 bit descriptor arrays
• CArrayFixFlat< TApaAppInfo > - No description.

• CEikEmbeddableAppList - Provides a list of all embeddable applications on the phone

Members

Defined in CEikEmbeddableAppList:
CEikEmbeddableAppList(), CEikEmbeddableAppList_Reserved1(), CEikEmbeddableAppList_Reserved2(), ConstructL(), ConstructL(), CreateEmbeddedDocumentL(), MdcaCount(), MdcaPoint(), ~CEikEmbeddableAppList()

See also:

• TApaAppCapability::iAppIsHidden

IMPORT_C CEikEmbeddableAppList();

Description

Default constructor.

IMPORT_C ~CEikEmbeddableAppList();

Description

Destructor.

IMPORT_C void ConstructL();

Description

Completes construction; populates and sorts the list.

Leave codes

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

IMPORT_C void ConstructL(const TApaEmbeddabilityFilter &aFilter);

Description

Completes construction; populates and sorts the list.

Parameters

const TApaEmbeddabilityFilter &aFilter Defines the filter to be applied to the list.

Leave codes

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

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

Description

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

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.

Return value

CEikDocument * The new embeddable document.

See also:

• CApaProcess::AddNewDocumentL()

private: virtual IMPORT_C TInt MdcaCount() const;

Description

Return value

TInt

private: virtual IMPORT_C TPtrC MdcaPoint(TInt aIndex) const;

Description

Parameters

TInt aIndex

Return value

TPtrC The caption for the embeddable application at aIndex

private: virtual IMPORT_C void CEikEmbeddableAppList_Reserved1();

Description

private: virtual IMPORT_C void CEikEmbeddableAppList_Reserved2();

Description