Class CApaProcess

class CApaProcess : public CBase;

Description

Maintains a list of documents and all of the potentially shared resources used by documents.

This includes the application DLLs. The class also supplies utility functions that provide the basic structure for persisted document files.

The class deals with the loading of application DLLs and manages the creation and destruction of application (CApaApplication) objects and document (CApaDocument) objects.

The class is derived from by the UI framework and further derivation by the UI application is not necessary unless it needs to add extra utility functions for the use of applications.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CApaProcess - Maintains a list of documents and all of the potentially shared resources used by documents

Members

Defined in CApaProcess:
AddNewDocumentL(), CApaProcess(), CApaProcess(), CApaProcess_Reserved1(), CApaProcess_Reserved2(), ConstructL(), ConstructL(), DestroyDocument(), FsSession(), MainDocFileName(), MainDocument(), NewL(), OpenNewDocumentL(), ReadAppIdentifierL(), ReadRootStreamLC(), ResetL(), SetMainDocFileName(), SetMainDocFileNameL(), SetMainDocument(), WriteAppIdentifierL(), WriteRootStreamL(), WriteRootStreamL(), ~CApaProcess()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• CApaApplication
• CApaDocument

static IMPORT_C CApaProcess *NewL(const RFs &aFs);

Description

Creates and returns a pointer to a new application process.

This function is not used by UI applications.

Parameters

const RFs &aFs Handle to a file server session.

Return value

CApaProcess * Pointer to the new application process.

IMPORT_C ~CApaProcess();

Description

Frees resources prior to destruction.

Documents must be saved before the application process is deleted, otherwise data may be lost.

In debug mode, the destructor raises an APPARC 6 panic if documents still exist, and an APPARC 5 panic if applications still exist.

protected: IMPORT_C CApaProcess();

Description

Constructor for CApaProcess

protected: IMPORT_C CApaProcess(const RFs &aFs);

Description

Constructs the application process object with the specified file session handle.

Derived classes must define and implement a constructor through which the file session handle can be specified. A typical implementation calls this constructor through a constructor initialization list.

This constructor is used by the UI framework.

Parameters

const RFs &aFs Handle to a file server session

protected: IMPORT_C void ConstructL();

Description

Completes construction of the application process object.

Implementers of derived classes must call this function as part of the second stage construction of an object. Typically, derived classes implement their own NewL() function and call ConstructL() as part of that implementation.

protected: IMPORT_C void ConstructL(TProcessId aParentProcessId);

Description

Completes construction of the application process object, passing in a Parent Process Identifier.

Implementers of derived classes must call this function as part of the second stage construction of an object. Typically, derived classes implement their own NewL() function and call ConstructL() as part of that implementation.

Parameters

TProcessId aParentProcessId Id of the parent process. This process will terminate when the parent does.

IMPORT_C void ResetL();

Description

Resets the the application process to its initial state.

Specifically, it saves the main document, deletes the main and all embedded documents from memory, resets the main document filename and deletes all applications except the main application.

The function can leave if saving the main document fails.

static IMPORT_C CStreamDictionary *ReadRootStreamLC(RFs &aFs, CFileStore *&aStore, const TDesC &aDocFullFileName, TUint aFileMode);

Description

Reads the stream dictionary contained as the root stream in the specified document file.

The function constructs, and returns a pointer to the stream dictionary object and puts the pointer to the stream dictionary object onto the cleanup stack. It also returns a pointer to the created file store object through an argument reference.

The file must be a valid document file; otherwise the function leaves with one of the system-wide error codes.

Parameters

RFs &aFs Handle to a file server session. CFileStore *&aStore On return, a pointer to the newly created file store object. const TDesC &aDocFullFileName The full path name of the document file. TUint aFileMode The mode in which to open the file.

Return value

CStreamDictionary * A pointer to the stream dictionary object read from the root stream of the store.

See also:

• TFileMode

static IMPORT_C void WriteRootStreamL(CPersistentStore &aStore, CStreamDictionary &aStreamDic, const CApaApplication &aApp);

Description

Writes the application identifier (derived from the application object CApaApplication) followed by the stream dictionary to the store and makes the stream dictionary the root stream of the store.

Typically, the function is called by the application when it implements a file create or file save type operation. It is called after all model and UI data has been persisted. The IDs of the streams containing the model and UI data should have been lodged in the stream dictionary.

In effect, the function finishes off the file save or file create type operation, leaving the file containing the store in a valid state with the standard interface.

Parameters

CPersistentStore &aStore The store to which the root stream is to be written. Before calling this function, a reference to the store must be saved by putting a pointer onto the cleanup stack or by making it member data of a class. This ensures that it is not orphaned in the event of this function leaving. CStreamDictionary &aStreamDic The stream dictionary containing the locations and associated UIDs of other streams in the store. const CApaApplication &aApp The application used to create the main document in the file being written. The application identifier to be written is constructed from this application object.

static IMPORT_C void WriteRootStreamL(CPersistentStore &aStore, CStreamDictionary &aStreamDic, const TApaAppIdentifier &aAppId);

Description

Writes the application identifier followed by the stream dictionary to the store and makes the stream dictionary the root stream of the store.

Typically, the function is called by the application when it implements a file create or file save type operation. It is called after all model and UI data has been persisted. The IDs of the streams containing the model and UI data should have been lodged in the stream dictionary.

In effect, the function finishes off the file save or file create type operation, leaving the file containing the store in a valid state with the standard interface.

Parameters

CPersistentStore &aStore The store to which the root stream is to be written. Before calling this function, a reference to the store must be saved by putting a pointer onto the cleanup stack or by making it member data of a class. This ensures that it is not orphaned in the event of this function leaving. CStreamDictionary &aStreamDic The stream dictionary containing the locations and associated UIDs of other streams in the store. const TApaAppIdentifier &aAppId The application identifier to be written into the application identifier stream.

static IMPORT_C TApaAppIdentifier ReadAppIdentifierL(const CStreamStore &aStore, const CStreamDictionary &aStreamDic);

Description

Reads the application identifier from its stream in the specified store and returns it.

The location of the stream is found in the specified stream dictionary.

Parameters

const CStreamStore &aStore The store from which the application identifier should be read. const CStreamDictionary &aStreamDic The stream dictionary containing the stream ID of the application identifier stream. The stream dictionary can be found in the root stream of the store.

Return value

TApaAppIdentifier The application identifier.

static IMPORT_C void WriteAppIdentifierL(CStreamStore &aStore, CStreamDictionary &aStreamDic, const TApaAppIdentifier &aAppId);

Description

Writes the application identifier to a new stream in the specified store and records the location of this stream in the specified stream dictionary.

Parameters

CStreamStore &aStore The store to which the application identifier should be written. CStreamDictionary &aStreamDic The stream dictionary. const TApaAppIdentifier &aAppId The application identifier to be externalised to a stream.

IMPORT_C CApaDocument *AddNewDocumentL(TApaApplicationFactory aApplicationFactory);

Description

Creates and adds a new document using the specified application factory.

The document may be a main document or an embedded document.

Any document created with this function must be destroyed using DestroyDocument().

Parameters

TApaApplicationFactory aApplicationFactory Should be created implicitly by passing a pointer to a factory function, an ECOM plugin UID, or a CImplementationInformation reference.

Return value

CApaDocument * A pointer to the new document.

See also:

• CApaProcess::DestroyDocument()
• CApaApplication

IMPORT_C CApaDocument *OpenNewDocumentL(CFileStore *&aStore, CStreamDictionary *&aStreamDic, const TDesC &aDocFullFileName, TUint aFileMode);

Description

Opens the specified file and restores the content as a document.

The created document can be merged into or embedded in another document.

Any document created with this function must be destroyed using DestroyDocument().

Parameters

CFileStore *&aStore On return, this contains a pointer to the store object created during the restore. CStreamDictionary *&aStreamDic On return, this contains a pointer to the stream dictionary object created during the restore. const TDesC &aDocFullFileName The name of the file containing the document. TUint aFileMode The mode in which to open the file.

Return value

CApaDocument * A pointer to the restored document.

See also:

• TFileMode
• CApaProcess::DestroyDocument()

IMPORT_C void DestroyDocument(CApaDocument *aDoc);

Description

Destroys the specified document.

All references to the document are removed, and associated resources are freed. Specifically, the function deletes any associated application and unloads the application DLL, provided that no other documents of that application type are still open.

All document objects created through CApaProcess must be deleted using this function.

Parameters

CApaDocument *aDoc A pointer to the document to be destroyed.

See also:

• CApaApplication

IMPORT_C void SetMainDocument(CApaDocument *aDocument);

Description

Sets the main document.

Parameters

CApaDocument *aDocument A pointer to the document to be set as the main document of the application process. This must be a an object created by the AddNewDocumentL() or OpenNewDocumentL() functions

See also:

• CApaProcess::AddNewDocumentL()
• CApaProcess::OpenNewDocumentL()

IMPORT_C void SetMainDocFileName(const TDesC &aMainDocFileName);

Description

Sets the filename of the main document.

Parameters

const TDesC &aMainDocFileName The filename to be set.

Panic codes

APPARC 7 If the length of aMainDocFileName is greater than KMaxFileName or the length of the last filename set by SetMainDocFileNameL if greater

See also:

• KMaxFileName

IMPORT_C void SetMainDocFileNameL(const TDesC &aMainDocFileName);

Description

Sets the filename of the main document.

Parameters

const TDesC &aMainDocFileName The filename to be set. There is no restriction on the length of this descriptor.

IMPORT_C TPtrC MainDocFileName() const;

Description

Returns the filename of the main document.

Return value

TPtrC A non-modifiable pointer descriptor to the main document filename. For non file-based applications, the length of this descriptor is zero.

inline RFs &FsSession() const;

Description

Returns a handle to the file server session used by this application process.

Return value

RFs & The file server session.

inline CApaDocument *MainDocument() const;

Description

Returns a pointer to the main document.

Return value

CApaDocument * A pointer to the main document.

protected: virtual IMPORT_C void CApaProcess_Reserved1();

Description

Reserved for future use

protected: virtual IMPORT_C void CApaProcess_Reserved2();

Description

Reserved for future use