1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/texthandling/inc/TXTSTYLE.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,271 @@
1.4 +/*
1.5 +* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +#ifndef __TXTSTYLE_H__
1.23 +#define __TXTSTYLE_H__
1.24 +
1.25 +#include <e32std.h>
1.26 +#include <e32base.h>
1.27 +#include <txtfmlyr.h>
1.28 +
1.29 +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
1.30 +#include <txtstyle_internal.h>
1.31 +#endif
1.32 +
1.33 +// Classes declared in this file:
1.34 +class CParagraphStyle;
1.35 +class CStyleTable;
1.36 +//
1.37 +// Classes referenced in this file:
1.38 +class RReadStream;
1.39 +class RWriteStream;
1.40 +
1.41 +/**
1.42 +The maximum number of characters in a paragraph style name.
1.43 +It should not be used by external developers.
1.44 +*/
1.45 +const TInt KMaxParagraphStyleName=0x20;
1.46 +
1.47 +
1.48 +/**
1.49 +The name of a paragraph style, with a maximum of 32 characters, to uniquely
1.50 +identify the style.
1.51 +It should not be used by external developers.
1.52 +*/
1.53 +typedef TBuf<KMaxParagraphStyleName> TParagraphStyleName;
1.54 +
1.55 +//
1.56 +// Defines a paragraph style, and the paragraph style to use next.
1.57 +
1.58 +
1.59 +class RParagraphStyleInfo
1.60 +/**
1.61 +A paragraph style.
1.62 +
1.63 +This is a named set of paragraph and character format attributes, which can
1.64 +only be applied to whole paragraphs. Paragraph styles may be used in rich
1.65 +text. Global text does not support styles.
1.66 +
1.67 +This class owns a pointer to an object of class CParagraphStyle, which stores
1.68 +the style information for the current paragraph; it also references another
1.69 +pointer which is optional, and stores the style information for the next paragraph.
1.70 +After construction, the RParagraphStyleInfo object should be appended to a
1.71 +style list (class CStyleList) which takes ownership of it.
1.72 +@publishedAll
1.73 +@released
1.74 +*/
1.75 + {
1.76 +public:
1.77 + inline RParagraphStyleInfo();
1.78 + inline RParagraphStyleInfo(CParagraphStyle* aStyle,CParagraphStyle* aStyleForNextPara=NULL);
1.79 + inline void Discard();
1.80 +public:
1.81 + /** Pointer to the paragraph style information. Owned by the RParagraphStyleInfo
1.82 + object. */
1.83 + CParagraphStyle* iStyle; // owned
1.84 + /** Pointer to the paragraph style information for the next paragraph. May be NULL. */
1.85 + CParagraphStyle* iStyleForNextPara; // referenced, may be NULL
1.86 + };
1.87 +
1.88 +
1.89 +
1.90 +
1.91 +class CParagraphStyle : public CParaFormatLayer
1.92 +// Defines a paragraph style as a named para format with richer attributes.
1.93 +/**
1.94 +Defines a paragraph style.
1.95 +
1.96 +A paragraph style is a named paragraph format layer which owns a set of character
1.97 +format attributes, has an outline level and a type UID. The outline level
1.98 +controls which headings should be shown when in document outline view. The
1.99 +type UID is used to differentiate between a word processor's built-in styles,
1.100 +which cannot be deleted, and user-defined styles, which can be deleted.
1.101 +
1.102 +The style's paragraph format attributes can be set using the functions derived
1.103 +from the base class CParaFormatLayer. Its character format attributes can
1.104 +be set through the owned CCharFormatLayer*. The style's character and paragraph
1.105 +format attributes are based on the global format layers specified on construction.
1.106 +@publishedAll
1.107 +@released
1.108 +*/
1.109 + {
1.110 +public:
1.111 + friend class CStyleList;
1.112 + friend class CRichTextIndex;
1.113 +
1.114 +
1.115 +
1.116 +/** Controls what happens to the styles when styled rich text is pasted into another
1.117 +rich text object. */
1.118 + enum TStylePasteMode
1.119 + {
1.120 + /** The pasted rich text retains all formatting and any new style definitions are
1.121 + added to the style list of the rich text object into which it is pasted. */
1.122 + EAddNewStyles,
1.123 + /** The pasted rich text retains all formatting, including that specified in the
1.124 + styles, but the new style definitions are not added to the style list of the
1.125 + rich text object into which it is pasted. The formatting specified in the
1.126 + styles becomes specific formatting. */
1.127 + EConvertNewStyles,
1.128 + /** The pasted rich text loses all formatting specified in the styles. */
1.129 + EIgnoreNewStyles
1.130 + };
1.131 +
1.132 +
1.133 +
1.134 +/** Retention of specific formatting */
1.135 + enum TApplyParaStyleMode
1.136 + {
1.137 + /** Specific character and paragraph formatting which has been applied to the paragraph
1.138 + is retained when a style is applied. If the style's formatting conflicts
1.139 + with the specific formatting, the specific formatting overrides the style. */
1.140 + ERetainAllSpecificFormats,
1.141 + /** Specific character and paragraph formatting which has been applied to the paragraph
1.142 + is removed when a style is applied, regardless of whether or not it conflicts
1.143 + with the style. */
1.144 + ERetainNoSpecificFormats,
1.145 + /** Specific paragraph formatting which has been applied to the paragraph is retained
1.146 + when a style is applied. If the style's formatting conflicts with the specific
1.147 + paragraph formatting, the specific formatting overrides the style.
1.148 +
1.149 + Specific character formatting which has been applied to the paragraph is removed,
1.150 + regardless of whether or not it conflicts with the style. */
1.151 + ERetainSpecificParaFormat,
1.152 + /** Specific character formatting which has been applied to the paragraph is retained
1.153 + when a style is applied. If the style's formatting conflicts with the specific
1.154 + character formatting, the specific formatting overrides the style.
1.155 +
1.156 + Specific paragraph formatting which has been applied to the paragraph is removed,
1.157 + regardless of whether or not it conflicts with the style. */
1.158 + ERetainSpecificCharFormat
1.159 + };
1.160 +public:
1.161 + // Creates style & bases it on the speicfied global layers - the 'Normal' style.
1.162 + IMPORT_C static CParagraphStyle* NewL(const CParaFormatLayer& aGlobalParaFormatLayer,const CCharFormatLayer& aGlobalCharFormatLayer);
1.163 + IMPORT_C ~CParagraphStyle();
1.164 + //
1.165 + // Getters/Setters
1.166 + inline CCharFormatLayer* CharFormatLayer()const;
1.167 + inline TInt OutlineLevel()const;
1.168 + inline void SetOutlineLevel(TInt aOutlineLevel);
1.169 + //
1.170 + // Utilities
1.171 + IMPORT_C virtual TUid Type()const;
1.172 + inline void SetType(TUid aType);
1.173 + inline CParagraphStyle* CloneL()const;
1.174 +private:
1.175 + CParagraphStyle();
1.176 + void ConstructL(const CParaFormatLayer& aGlobalParaFormatLayer,
1.177 + const CCharFormatLayer& aGlobalCharFormatLayer);
1.178 + IMPORT_C virtual CFormatLayer* DoCloneL()const;
1.179 + //
1.180 + // Save/Load
1.181 + static CParagraphStyle* NewL(RReadStream& aStream,const CParaFormatLayer& aGlobalParaFormatLayer,const CCharFormatLayer& aGlobalCharFormatLayer);
1.182 + virtual void InternalizeL(RReadStream& aStream,const CFormatLayer* aParaLayerBase,const CFormatLayer* aCharLayerBase);
1.183 + virtual void ExternalizeL(RWriteStream& aStream)const;
1.184 +private:
1.185 + TUid iType;
1.186 + TInt iOutlineLevel;
1.187 + CCharFormatLayer* iCharFormatLayer; // should never be NULL
1.188 +public:
1.189 + /** Unique style name, with a maximum of 32 characters. */
1.190 + TParagraphStyleName iName;
1.191 + };
1.192 +
1.193 +
1.194 +/**
1.195 +The number of entries by which a style list expands when its buffer is reallocated.
1.196 +It should not be used by external developers.
1.197 +*/
1.198 +const TInt KMaxStyleListGranularity=0x04;
1.199 +
1.200 +
1.201 +
1.202 +class CStyleList : public CBase
1.203 +/**
1.204 +A container of paragraph styles.
1.205 +
1.206 +It is implemented as a fixed length array of pointers to RParagraphStyleInfos.
1.207 +The array's granularity is specified on construction. The list takes ownership
1.208 +of all paragraph styles appended to it. When the list is deleted, all styles
1.209 +it owns are also deleted.
1.210 +
1.211 +After the style list has been set up, it should normally be passed to a CRichText
1.212 +object, either in the rich text object's constructor, or by calling CRichText::SetStyleListExternallyOwned().
1.213 +The rich text object takes ownership of the style list (unless SetStyleListExternallyOwned()
1.214 +is used). Styles can be modified, added to and removed from the style list
1.215 +after ownership of the list has been passed to the rich text object.
1.216 +
1.217 +If CRichText::SetStyleListExternallyOwned() is used, the style list is not
1.218 +owned by the rich text object, and it must be stored and restored separately
1.219 +from the rich text object.
1.220 +@publishedAll
1.221 +@released
1.222 +*/
1.223 + {
1.224 +public:
1.225 + IMPORT_C static CStyleList* NewL(TInt aCapacity=KMaxStyleListGranularity);
1.226 + IMPORT_C static CStyleList* NewL(RReadStream& aStream,
1.227 + const CParaFormatLayer* aGlobalParaFormatLayer,
1.228 + const CCharFormatLayer* aGlobalCharFormatLayer);
1.229 + IMPORT_C ~CStyleList();
1.230 + //
1.231 + inline const RParagraphStyleInfo& operator[](TInt aIndex)const;
1.232 + inline RParagraphStyleInfo& operator[](TInt aIndex);
1.233 + IMPORT_C const RParagraphStyleInfo& At(TInt aIndex)const;
1.234 + IMPORT_C RParagraphStyleInfo& At(TInt aIndex);
1.235 + //
1.236 + // Persistence
1.237 + IMPORT_C TStreamId StoreL(CStreamStore& aStore)const;
1.238 + IMPORT_C void ExternalizeL(RWriteStream& aStream)const;
1.239 + IMPORT_C void InternalizeL(RReadStream& aStream,
1.240 + const CParaFormatLayer* aGlobalParaFormatLayer,
1.241 + const CCharFormatLayer* aGlobalCharFormatLayer);
1.242 + //
1.243 + // Table maintenance
1.244 + IMPORT_C void Reset(); // Delete all styles from the style list.
1.245 + IMPORT_C TInt AppendL(RParagraphStyleInfo* aStyleSet);
1.246 + IMPORT_C void Remove(CParagraphStyle* aStyle);
1.247 + IMPORT_C TInt SetStyleToFollow(const RParagraphStyleInfo& aStyleSet); // returns KErrNone or KErrNotFound
1.248 + IMPORT_C CStyleList* DeepCloneL()const;
1.249 + //
1.250 + // Getters
1.251 + IMPORT_C RParagraphStyleInfo* PtrByName(const TParagraphStyleName& aName)const;
1.252 + IMPORT_C RParagraphStyleInfo* PtrByType(const TUid aType)const;
1.253 + IMPORT_C TInt IndexByPtr(const CParaFormatLayer* aPtr)const;
1.254 + // Returns KErrNotFound if the specified style is not located in the style list.
1.255 + //
1.256 + IMPORT_C TInt IndexByName(const TDesC& aName)const;
1.257 + // Returns KErrNotFound if the specified style name is not located in the style list.
1.258 + //
1.259 + // General
1.260 + inline TInt Count()const;
1.261 +protected:
1.262 + IMPORT_C CStyleList();
1.263 + IMPORT_C void ConstructL(TInt aGranularity);
1.264 +private:
1.265 + void KillStyleList();
1.266 +private:
1.267 + CArrayFixFlat<RParagraphStyleInfo>* iList;
1.268 + __DECLARE_TEST;
1.269 + };
1.270 +
1.271 +
1.272 +#include <txtstyle.inl>
1.273 +
1.274 +#endif