CApaApplication Class Reference

class CApaApplication : public CBase

Defines the basic behaviour for applications.

The class defines the basic twin roles of an application class as a factory that creates concrete document objects, and as a supplier of utility functions not specific to any particular instance of a document. For example, returning an application's caption, or accessing its .ini file.

The class is derived from by the UI framework and is further derived from by the UI application.

CEikApplication

Inherits from

Constructor & Destructor Documentation

CApaApplication()

IMPORT_CCApaApplication()[protected]

~CApaApplication()

IMPORT_C~CApaApplication()

Member Functions Documentation

AppDllUid()

TUid AppDllUid()const [pure virtual]

Gets the application specific UID.

The UID is used to differentiate between UI applications.

An implementation of this function must be supplied by the UI application.

The application specific UID.

AppFullName()

IMPORT_C TFileNameAppFullName()const [virtual]

CApaApplication_Reserved1()

IMPORT_C voidCApaApplication_Reserved1()[private, virtual]

CApaApplication_Reserved2()

IMPORT_C voidCApaApplication_Reserved2()[private, virtual]

Capability(TDes8 &)

voidCapability(TDes8 &aInfo)const [pure virtual]

Returns the capabilities of the application.

Application capability information is represented by an instance of a TApaAppCapability object wrapped in a packaged modifiable buffer descriptor.

The function is called from a number of places within the application framework.

An implementation of this function is supplied by the UI framework.

CEikApplication

TApaAppCapability

TPckgBuf

Parameters

TDes8 & aInfoA packaged modifiable buffer descriptor (a TPckgBuf), encapsulating a TApaAppCapability object.

CreateDocumentL(CApaProcess *)

CApaDocument *CreateDocumentL(CApaProcess *aProcess)[pure virtual]

Creates a document object.

The function is called by the application process when a new document is required. The application process adds the new document to its list of documents.

An implementation of this function is supplied by the UI framework.

A pointer to the newly created document.

CApaProcess::AddNewDocumentL()

Parameters

CApaProcess * aProcessA pointer to the process associated with the application.

DllName()

IMPORT_C TFileNameDllName()const

GenerateFileName(RFs &, TFileName &)

IMPORT_C TIntGenerateFileName(RFs &aFs,
TFileName &aRootName
)[static]

Parameters

RFs & aFs
TFileName & aRootName

NewAppServerL(CApaAppServer *&)

IMPORT_C voidNewAppServerL(CApaAppServer *&aAppServer)[virtual]

Parameters

CApaAppServer *& aAppServer

OpenIniFileL(RFs &)

IMPORT_C CDictionaryStore *OpenIniFileL(RFs &aFs)const

Parameters

RFs & aFs

OpenIniFileLC(RFs &)

CDictionaryStore *OpenIniFileLC(RFs &aFs)const [pure virtual]

Opens the .ini file associated with the application, constructs the dictionary store object, returns a pointer to it and puts the pointer onto the cleanupstack.

The .ini file must be created, if it does not already exist.

An implementation of this function is supplied by the UI framework.

A pointer to the dictionary store object that represents the application's .ini file.

CEikApplication

Parameters

RFs & aFsHandle to a file server session

PreDocConstructL()

voidPreDocConstructL()[pure virtual]

Completes construction of this application object.

The function is called after an instance of a derived class has been successfully created using the ordinal 1 function of the application DLL.

After calling this function, an application can create document objects.

An implementation of this function is supplied by the UI framework.

CEikApplication

SetAppFileNameRef(const RBuf &)

voidSetAppFileNameRef(const RBuf &aFileName)

Parameters

const RBuf & aFileName

Member Data Documentation

const RBuf * iAppFileNameRef

const RBuf *iAppFileNameRef[private]

TInt iCApaApplication_Reserved1

TInt iCApaApplication_Reserved1[private]

TUid iEComDtorKey

TUid iEComDtorKey[private]