sl@0: /* sl@0: * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). sl@0: * All rights reserved. sl@0: * This component and the accompanying materials are made available sl@0: * under the terms of "Eclipse Public License v1.0" sl@0: * which accompanies this distribution, and is available sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: * sl@0: * Initial Contributors: sl@0: * Nokia Corporation - initial contribution. sl@0: * sl@0: * Contributors: sl@0: * sl@0: * Description: sl@0: * sl@0: */ sl@0: sl@0: sl@0: #ifndef __TXTGLOBL_H__ sl@0: #define __TXTGLOBL_H__ sl@0: sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: sl@0: sl@0: // forward declarations sl@0: class CParaFormatLayer; sl@0: class CCharFormatLayer; sl@0: class TCharFormatX; sl@0: class TCharFormatXMask; sl@0: sl@0: sl@0: // Globally formatted text. sl@0: // Uses one instance of each a paragraph format and character format class; Each presents sl@0: // the formatting applied to the total document contents. Both of the format classes used sl@0: // may utilise layering of formats through 'based on' links to achieve full format specification. sl@0: // These global layers are *never* owned by global text, merely referenced. sl@0: sl@0: /** sl@0: Text with globally applied formatting. sl@0: sl@0: Global text uses a single set of paragraph format attributes to describe the sl@0: appearance of every paragraph and a single set of character format attributes sl@0: to describe the appearance of every character. sl@0: sl@0: The paragraph formatting is stored in a CParaFormatLayer and the character sl@0: formatting is stored in a CCharFormatLayer. A format layer is a set of character sl@0: or paragraph format attributes, which may own a pointer to another format sl@0: layer. This pointer is called a based-on link. The effective formatting of sl@0: a global text object is the set of attributes specified in its two format sl@0: layers, as well as any attributes inherited from the layers' chain of based-on sl@0: links. To get the effective formatting, the links are read in turn, so that sl@0: each attribute's value is taken from the first layer in the chain in which sl@0: it has been set. Use GetCharFormat() and GetParaFormatL() to get the text sl@0: object's effective formatting. sl@0: sl@0: A global text object references the two format layers; it does not own them. sl@0: This allows more than one global text object to use the same formatting. The sl@0: format layers may be modified (see ApplyParaFormatL() and ApplyCharFormatL()) sl@0: or replaced (see SetGlobalParaFormat() and SetGlobalCharFormat()) during the sl@0: text object's lifetime. sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class CGlobalText : public CPlainText,public MLayDoc,public MFormatText sl@0: { sl@0: public: sl@0: // Special member functions sl@0: // Create new global text component whose sole content is an end-of-document character. sl@0: IMPORT_C static CGlobalText* NewL(const CParaFormatLayer* aGlobalParaLayer,const CCharFormatLayer* aGlobalCharLayer, sl@0: TDocumentStorage aStorage=ESegmentedStorage,TInt aDefaultTextGranularity=EDefaultTextGranularity); sl@0: // Restore a new global text, that uses the specified global layers. sl@0: IMPORT_C static CGlobalText* NewL(const CStreamStore& aStore,TStreamId aStreamId, sl@0: const CParaFormatLayer* aGlobalParaLayer,const CCharFormatLayer* aGlobalCharLayer, sl@0: MTextFieldFactory* aFieldFactory=NULL, sl@0: TDocumentStorage=ESegmentedStorage); sl@0: IMPORT_C ~CGlobalText(); sl@0: // Global Format Layers sl@0: IMPORT_C void SetGlobalParaFormat(const CParaFormatLayer* aParaFormatLayer); sl@0: IMPORT_C void SetGlobalCharFormat(const CCharFormatLayer* aCharFormatLayer); sl@0: inline const CParaFormatLayer* GlobalParaFormatLayer()const; sl@0: inline const CCharFormatLayer* GlobalCharFormatLayer()const; sl@0: // MLayDoc implementation sl@0: IMPORT_C virtual TInt LdDocumentLength()const; sl@0: IMPORT_C virtual TInt LdToParagraphStart(TInt& aCurrentPos)const; sl@0: IMPORT_C virtual void GetParagraphFormatL(CParaFormat* aFormat,TInt aPos)const; sl@0: IMPORT_C virtual void GetChars(TPtrC& aView,TCharFormat& aFormat,TInt aStartPos)const; sl@0: IMPORT_C virtual TInt GetPictureSizeInTwips(TSize& aSize, TInt aPos)const; sl@0: IMPORT_C virtual CPicture* PictureHandleL(TInt aPos,MLayDoc::TForcePictureLoad aForceLoad)const; sl@0: IMPORT_C virtual TBool EnquirePageBreak(TInt aPos,TInt aLength=0)const; sl@0: IMPORT_C virtual TBool SelectParagraphLabel(TInt aPos); sl@0: IMPORT_C virtual void CancelSelectLabel(); sl@0: // MFormatText implementation sl@0: IMPORT_C virtual void GetParaFormatL(CParaFormat* aFormat,TParaFormatMask& aVaries,TInt aPos,TInt aLength, sl@0: CParaFormat::TParaFormatGetMode aMode=CParaFormat::EAllAttributes)const; sl@0: IMPORT_C virtual void ApplyParaFormatL(const CParaFormat* aFormat,const TParaFormatMask& aMask,TInt aPos,TInt aLength); sl@0: IMPORT_C virtual void GetCharFormat(TCharFormat& aFormat,TCharFormatMask& aVaries,TInt aPos,TInt aLength)const; sl@0: IMPORT_C virtual void ApplyCharFormatL(const TCharFormat& aFormat,const TCharFormatMask& aMask,TInt aPos,TInt aLength); sl@0: protected: sl@0: IMPORT_C CGlobalText(); sl@0: IMPORT_C CGlobalText(const CParaFormatLayer* aGlobalParaLayer, sl@0: const CCharFormatLayer* aGlobalCharLayer); sl@0: private: sl@0: CGlobalText(const CGlobalText& aGlobalText); sl@0: CGlobalText& operator=(const CGlobalText& aGlobalText); sl@0: protected: sl@0: const CParaFormatLayer* iGlobalParaFormatLayer; // the global paragraph format layer; not owned sl@0: const CCharFormatLayer* iGlobalCharFormatLayer; // the global character format layer; not owned sl@0: __DECLARE_TEST; sl@0: private: sl@0: void* iReserved_2; sl@0: }; sl@0: sl@0: sl@0: #include sl@0: sl@0: sl@0: #endif