Class CWordModel

class CWordModel : public CBase;

Description

Word processor engine interface.

This is essentially a thin layer over the rich text support (CRichText etc.) provided by the Application Framework's ETEXT component.

Derivation

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

• CWordModel - Word processor engine interface.

Members

Defined in CWordModel:

• CWordModel()Default constructor.
• ConstructL(const MFieldFileNameInfo *,const MFieldNumPagesInfo *)Second-phase constructor.
• ConstructMinimalL(const MFieldFileNameInfo *,const MFieldNumPagesInfo *,const TDesC &)Second-phase constructor, with printer initialisation.
• NewL(const MFieldFileNameInfo *,const MFieldNumPagesInfo *)Allocates and creates a new word processor engine.
• NewL(const MFieldFileNameInfo *,const MFieldNumPagesInfo *,const TDesC &)Allocates and creates a new word processor engine, and performs printer initalis...
• NormalStyleShortCut()Gets the keybord short cut for the normal style.
• PageTable()Gets the engine's page table array.
• PrintSetup()Gets the engine's print setup object.
• RestoreL(const CStreamStore &,const CStreamDictionary &,const TAny *,const MFieldFileNameInfo *,const MFieldNumPagesInfo *,MPictureFactory *)Restores the engine.
• RestoreMinimalL(const CStreamStore &,const CStreamDictionary &,const TAny *,const MFieldFileNameInfo *,const MFieldNumPagesInfo *,MPictureFactory *)Restores the engine, without restoring the print setup stream.
• StoreL(CStreamStore &,CStreamDictionary &,const TAny *)constStores the engine.
• StyleList()Gets the engine's style list object.
• StyleShortCutList()Gets the engine's style short cuts array.
• Text()Gets the engine's rich text object.
• ~CWordModel()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CWordModel* NewL(const MFieldFileNameInfo *aFileNameInfo, const MFieldNumPagesInfo *aFieldNumPagesInfo, const TDesC &aDriverPath);

Description

Allocates and creates a new word processor engine, and performs printer initalisation.

Parameters

Return value

IMPORT_C static CWordModel* NewL(const MFieldFileNameInfo *aFileNameInfo, const MFieldNumPagesInfo *aFieldNumPagesInfo);

Description

Allocates and creates a new word processor engine.

Parameters

Return value

IMPORT_C ~CWordModel();

Description

Destructor.

protected: IMPORT_C CWordModel();

Description

Default constructor.

protected: IMPORT_C void ConstructL(const MFieldFileNameInfo *aFileNameInfo, const MFieldNumPagesInfo *aNumPagesInfo);

Description

Second-phase constructor.

Parameters

IMPORT_C void StoreL(CStreamStore &aStore, CStreamDictionary &aStreamDic, const TAny *aSecurity) const;

Description

Stores the engine.

This function writes the engine data to a stream store, and records the streams used in a stream dictionary.

Parameters

IMPORT_C void RestoreL(const CStreamStore &aStore, const CStreamDictionary &aStreamDic, const TAny *aSecurity, const MFieldFileNameInfo *aFileNameInfo=0,const MFieldNumPagesInfo *aNumPagesInfo=0, MPictureFactory *aPictureFactory=0);

Description

Restores the engine.

Parameters

IMPORT_C void RestoreMinimalL(const CStreamStore &aStore, const CStreamDictionary &aStreamDic, const TAny *aSecurity, const MFieldFileNameInfo *aFileNameInfo=0,const MFieldNumPagesInfo *aNumPagesInfo=0, MPictureFactory *aPictureFactory=0);

Description

Restores the engine, without restoring the print setup stream.

This allows restoring without loading a printer driver. Header and footer information will not be available.

Parameters

inline CRichText* Text();

Description

Gets the engine's rich text object.

Return value

inline CStyleList* StyleList();

Description

Gets the engine's style list object.

Return value

inline CPrintSetup* PrintSetup();

Description

Gets the engine's print setup object.

Return value

inline CArrayFix< TInt >* PageTable();

Description

Gets the engine's page table array.

A page table is an array of integers; each integer represents the number of characters on a page. It is required for pagination.

Return value

inline CStyleShortCutList* StyleShortCutList();

Description

Gets the engine's style short cuts array.

This object stores a list of keyboard shortcuts to the styles (as returned by CWordModel::StyleList()). The array is in the same order as the style list array.

Return value

inline TChar& NormalStyleShortCut();

Description

Gets the keybord short cut for the normal style.

Return value

protected: IMPORT_C void ConstructMinimalL(const MFieldFileNameInfo *aFileNameInfo, const MFieldNumPagesInfo *aFieldNumPagesInfo, const TDesC &aDriverPath);

Description

Second-phase constructor, with printer initialisation.

Parameters