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 __TXTSTYLE_H__
sl@0: #define __TXTSTYLE_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32base.h>
sl@0: #include <txtfmlyr.h>
sl@0: 
sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: #include <txtstyle_internal.h>
sl@0: #endif
sl@0: 
sl@0: // Classes declared in this file:
sl@0: class CParagraphStyle;
sl@0: class CStyleTable;
sl@0: //
sl@0: // Classes referenced in this file:
sl@0: class RReadStream;
sl@0: class RWriteStream;
sl@0: 
sl@0: /** 
sl@0: The maximum number of characters in a paragraph style name.
sl@0: It should not be used by external developers.
sl@0: */
sl@0: const TInt KMaxParagraphStyleName=0x20;
sl@0: 
sl@0: 
sl@0: /** 
sl@0: The name of a paragraph style, with a maximum of 32 characters, to uniquely 
sl@0: identify the style.
sl@0: It should not be used by external developers.
sl@0: */
sl@0: typedef TBuf<KMaxParagraphStyleName> TParagraphStyleName;
sl@0: 
sl@0: //
sl@0: // Defines a paragraph style, and the paragraph style to use next.
sl@0: 
sl@0: 
sl@0: class RParagraphStyleInfo
sl@0: /** 
sl@0: A paragraph style.
sl@0: 
sl@0: This is a named set of paragraph and character format attributes, which can 
sl@0: only be applied to whole paragraphs. Paragraph styles may be used in rich 
sl@0: text. Global text does not support styles.
sl@0: 
sl@0: This class owns a pointer to an object of class CParagraphStyle, which stores 
sl@0: the style information for the current paragraph; it also references another 
sl@0: pointer which is optional, and stores the style information for the next paragraph. 
sl@0: After construction, the RParagraphStyleInfo object should be appended to a 
sl@0: style list (class CStyleList) which takes ownership of it. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	inline RParagraphStyleInfo();
sl@0: 	inline RParagraphStyleInfo(CParagraphStyle* aStyle,CParagraphStyle* aStyleForNextPara=NULL);
sl@0: 	inline void Discard();
sl@0: public:
sl@0: 	/** Pointer to the paragraph style information. Owned by the RParagraphStyleInfo 
sl@0: 	object. */
sl@0: 	CParagraphStyle* iStyle;  // owned
sl@0: 	/** Pointer to the paragraph style information for the next paragraph. May be NULL. */
sl@0: 	CParagraphStyle* iStyleForNextPara;  // referenced, may be NULL
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: class CParagraphStyle : public CParaFormatLayer
sl@0: // Defines a paragraph style as a named para format with richer attributes.
sl@0: /** 
sl@0: Defines a paragraph style. 
sl@0: 
sl@0: A paragraph style is a named paragraph format layer which owns a set of character 
sl@0: format attributes, has an outline level and a type UID. The outline level 
sl@0: controls which headings should be shown when in document outline view. The 
sl@0: type UID is used to differentiate between a word processor's built-in styles, 
sl@0: which cannot be deleted, and user-defined styles, which can be deleted.
sl@0: 
sl@0: The style's paragraph format attributes can be set using the functions derived 
sl@0: from the base class CParaFormatLayer. Its character format attributes can 
sl@0: be set through the owned CCharFormatLayer*. The style's character and paragraph 
sl@0: format attributes are based on the global format layers specified on construction. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	friend class CStyleList;
sl@0: 	friend class CRichTextIndex;
sl@0: 	
sl@0: 
sl@0: 
sl@0: /** Controls what happens to the styles when styled rich text is pasted into another 
sl@0: rich text object. */
sl@0: 	enum TStylePasteMode
sl@0: 		{
sl@0: 	/** The pasted rich text retains all formatting and any new style definitions are 
sl@0: 	added to the style list of the rich text object into which it is pasted. */
sl@0: 		EAddNewStyles,
sl@0: 	/** The pasted rich text retains all formatting, including that specified in the 
sl@0: 	styles, but the new style definitions are not added to the style list of the 
sl@0: 	rich text object into which it is pasted. The formatting specified in the 
sl@0: 	styles becomes specific formatting. */
sl@0: 		EConvertNewStyles,
sl@0: 	/** The pasted rich text loses all formatting specified in the styles. */
sl@0: 		EIgnoreNewStyles
sl@0: 		};
sl@0: 	
sl@0: 
sl@0: 
sl@0: /** Retention of specific formatting */
sl@0: 	enum TApplyParaStyleMode
sl@0: 		{
sl@0: 	/** Specific character and paragraph formatting which has been applied to the paragraph 
sl@0: 	is retained when a style is applied. If the style's formatting conflicts 
sl@0: 	with the specific formatting, the specific formatting overrides the style. */
sl@0: 		ERetainAllSpecificFormats,
sl@0: 	/** Specific character and paragraph formatting which has been applied to the paragraph 
sl@0: 	is removed when a style is applied, regardless of whether or not it conflicts 
sl@0: 	with the style. */
sl@0: 		ERetainNoSpecificFormats,
sl@0: 	/** Specific paragraph formatting which has been applied to the paragraph is retained 
sl@0: 	when a style is applied. If the style's formatting conflicts with the specific 
sl@0: 	paragraph formatting, the specific formatting overrides the style.
sl@0: 	
sl@0: 	Specific character formatting which has been applied to the paragraph is removed, 
sl@0: 	regardless of whether or not it conflicts with the style. */
sl@0: 		ERetainSpecificParaFormat,
sl@0: 	/** Specific character formatting which has been applied to the paragraph is retained 
sl@0: 	when a style is applied. If the style's formatting conflicts with the specific 
sl@0: 	character formatting, the specific formatting overrides the style.
sl@0: 	
sl@0: 	Specific paragraph formatting which has been applied to the paragraph is removed, 
sl@0: 	regardless of whether or not it conflicts with the style. */
sl@0: 		ERetainSpecificCharFormat
sl@0: 		};
sl@0: public:
sl@0: 	// Creates style & bases it on the speicfied global layers - the 'Normal' style.
sl@0: 	IMPORT_C static CParagraphStyle* NewL(const CParaFormatLayer& aGlobalParaFormatLayer,const CCharFormatLayer& aGlobalCharFormatLayer);
sl@0: 	IMPORT_C ~CParagraphStyle();
sl@0: 	//
sl@0: 	// Getters/Setters
sl@0: 	inline CCharFormatLayer* CharFormatLayer()const;
sl@0: 	inline TInt OutlineLevel()const;
sl@0: 	inline void SetOutlineLevel(TInt aOutlineLevel);
sl@0: 	//
sl@0: 	// Utilities
sl@0: 	IMPORT_C virtual TUid Type()const;
sl@0: 	inline void SetType(TUid aType);
sl@0: 	inline CParagraphStyle* CloneL()const;
sl@0: private:
sl@0: 	CParagraphStyle();	
sl@0: 	void ConstructL(const CParaFormatLayer& aGlobalParaFormatLayer,
sl@0: 							 const CCharFormatLayer& aGlobalCharFormatLayer);
sl@0: 	IMPORT_C virtual CFormatLayer* DoCloneL()const;
sl@0: 	//
sl@0: 	// Save/Load
sl@0: 	static CParagraphStyle* NewL(RReadStream& aStream,const CParaFormatLayer& aGlobalParaFormatLayer,const CCharFormatLayer& aGlobalCharFormatLayer);
sl@0: 	virtual void InternalizeL(RReadStream& aStream,const CFormatLayer* aParaLayerBase,const CFormatLayer* aCharLayerBase);
sl@0: 	virtual void ExternalizeL(RWriteStream& aStream)const;
sl@0: private:
sl@0: 	TUid iType;
sl@0: 	TInt iOutlineLevel;
sl@0: 	CCharFormatLayer* iCharFormatLayer;  // should never be NULL
sl@0: public:
sl@0: 	/** Unique style name, with a maximum of 32 characters. */
sl@0: 	TParagraphStyleName iName;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /** 
sl@0: The number of entries by which a style list expands when its buffer is reallocated. 
sl@0: It should not be used by external developers.
sl@0: */
sl@0: const TInt KMaxStyleListGranularity=0x04;
sl@0: 
sl@0: 
sl@0: 
sl@0: class CStyleList : public CBase
sl@0: /** 
sl@0: A container of paragraph styles. 
sl@0: 
sl@0: It is implemented as a fixed length array of pointers to RParagraphStyleInfos. 
sl@0: The array's granularity is specified on construction. The list takes ownership 
sl@0: of all paragraph styles appended to it. When the list is deleted, all styles 
sl@0: it owns are also deleted.
sl@0: 
sl@0: After the style list has been set up, it should normally be passed to a CRichText 
sl@0: object, either in the rich text object's constructor, or by calling CRichText::SetStyleListExternallyOwned(). 
sl@0: The rich text object takes ownership of the style list (unless SetStyleListExternallyOwned() 
sl@0: is used). Styles can be modified, added to and removed from the style list 
sl@0: after ownership of the list has been passed to the rich text object.
sl@0: 
sl@0: If CRichText::SetStyleListExternallyOwned() is used, the style list is not 
sl@0: owned by the rich text object, and it must be stored and restored separately 
sl@0: from the rich text object. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static CStyleList* NewL(TInt aCapacity=KMaxStyleListGranularity);
sl@0: 	IMPORT_C static CStyleList* NewL(RReadStream& aStream,
sl@0: 									const CParaFormatLayer* aGlobalParaFormatLayer,
sl@0: 									const CCharFormatLayer* aGlobalCharFormatLayer);
sl@0: 	IMPORT_C ~CStyleList();
sl@0: 	//
sl@0: 	inline const RParagraphStyleInfo& operator[](TInt aIndex)const;
sl@0: 	inline RParagraphStyleInfo& operator[](TInt aIndex);
sl@0: 	IMPORT_C const RParagraphStyleInfo& At(TInt aIndex)const;
sl@0: 	IMPORT_C RParagraphStyleInfo& At(TInt aIndex);
sl@0: 	//
sl@0: 	// Persistence
sl@0: 	IMPORT_C TStreamId StoreL(CStreamStore& aStore)const;
sl@0: 	IMPORT_C void ExternalizeL(RWriteStream& aStream)const;
sl@0: 	IMPORT_C void InternalizeL(RReadStream& aStream,
sl@0: 								const CParaFormatLayer* aGlobalParaFormatLayer,
sl@0: 								const CCharFormatLayer* aGlobalCharFormatLayer);
sl@0: 	//
sl@0: 	// Table maintenance
sl@0: 	IMPORT_C void Reset();  // Delete all styles from the style list.
sl@0: 	IMPORT_C TInt AppendL(RParagraphStyleInfo* aStyleSet);
sl@0: 	IMPORT_C void Remove(CParagraphStyle* aStyle);
sl@0: 	IMPORT_C TInt SetStyleToFollow(const RParagraphStyleInfo& aStyleSet);  // returns KErrNone or KErrNotFound
sl@0: 	IMPORT_C CStyleList* DeepCloneL()const;
sl@0: 	//
sl@0: 	// Getters
sl@0: 	IMPORT_C RParagraphStyleInfo* PtrByName(const TParagraphStyleName& aName)const;
sl@0: 	IMPORT_C RParagraphStyleInfo* PtrByType(const TUid aType)const;
sl@0: 	IMPORT_C TInt IndexByPtr(const CParaFormatLayer* aPtr)const;
sl@0: 	// Returns KErrNotFound if the specified style is not located in the style list.
sl@0: 	//
sl@0: 	IMPORT_C TInt IndexByName(const TDesC& aName)const;
sl@0: 	// Returns KErrNotFound if the specified style name is not located in the style list.
sl@0: 	//
sl@0: 	// General
sl@0: 	inline TInt Count()const;
sl@0: protected:
sl@0: 	IMPORT_C CStyleList();
sl@0: 	IMPORT_C void ConstructL(TInt aGranularity);
sl@0: private:
sl@0: 	void KillStyleList();
sl@0: private:
sl@0: 	CArrayFixFlat<RParagraphStyleInfo>* iList;
sl@0: 	__DECLARE_TEST;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: #include <txtstyle.inl>
sl@0: 
sl@0: #endif