1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/texthandling/inc/TXTFMLYR.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,232 @@
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 __TXTFMLYR_H__
1.23 +#define __TXTFMLYR_H__
1.24 +
1.25 +#include <e32std.h>
1.26 +#include <e32base.h>
1.27 +#include <txtfmstm.h>
1.28 +#include <txtfrmat.h>
1.29 +
1.30 +// forward declarations
1.31 +class CFormatStream;
1.32 +class RReadStream;
1.33 +class RWriteStream;
1.34 +class TCharFormatX;
1.35 +
1.36 +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
1.37 +#include <txtfmlyr_internal.h>
1.38 +#endif
1.39 +
1.40 +/**
1.41 +Abstract base class for the paragraph and character format layers.
1.42 +
1.43 +A format layer is a set of character or paragraph format attributes which
1.44 +may own a pointer to another format layer. This pointer is called a based-on
1.45 +link. The effective formatting of a text object may be built up from a chain
1.46 +of format layers - the final layer in the chain has a NULL based-on link.
1.47 +In case of conflict, attribute values set in upper layers (layers furthest
1.48 +from the layer with the NULL based-on link) override those set in lower layers.
1.49 +In rich text, additional formatting may be applied on top of these format
1.50 +layers.
1.51 +
1.52 +The system of based-on links is implemented by the CFormatLayer class. It
1.53 +also implements persistence for chains of format layers.
1.54 +
1.55 +When setting or sensing the attributes of a CParaFormatLayer or CCharFormatLayer,
1.56 +a format mask and container are specified as parameters. The container has
1.57 +data members for every format attribute, which may be set independently. When
1.58 +setting the layer, the mask indicates the attributes which will be taken from
1.59 +the container. Any attributes not specified in the mask will be taken from
1.60 +the system-provided default values.
1.61 +
1.62 +When sensing a layer, on return, the mask indicates which attributes have
1.63 +been explicitly set in the layer, (i.e. not taken from the default values).
1.64 +In addition, a layer's effective format may be sensed. In this case, no
1.65 +mask is used because the format container will, on return, contain a value
1.66 +for every attribute.
1.67 +@publishedAll
1.68 +@released
1.69 +*/
1.70 +class CFormatLayer : public CBase
1.71 + {
1.72 +public:
1.73 + //
1.74 + // Based-on link utilities
1.75 + IMPORT_C void Reset(); // Remove all contents of this layer in a leave safe manner.
1.76 + IMPORT_C void SetBase(const CFormatLayer* aBaseFormatLayer); // Set this layer to be based on the specified layer.
1.77 + IMPORT_C const CFormatLayer* SenseBase()const;
1.78 + IMPORT_C TInt ChainCount()const; // Returns the number of format layers in the chain, inclusive of itself.
1.79 + //
1.80 + // Persistence
1.81 +
1.82 +
1.83 + /** Implementations of this function internalise the format layer but not its based-on
1.84 + link from a read stream. The presence of this function means that the standard
1.85 + templated operator>>() (defined in s32strm.h) is available to internalise
1.86 + objects of the derived class. The internalised layer is set to be based on
1.87 + the layer specified.
1.88 +
1.89 + @param aStream Stream from which the format layer should be internalised.
1.90 + @param aBase The based-on link to assign to the layer. By default, NULL. */
1.91 + virtual void InternalizeL(RReadStream& aStream,const CFormatLayer* aBase=NULL)=0;
1.92 +
1.93 +
1.94 + /** Implementations of this function externalise the format layer but not its based-on
1.95 + link to a write stream. The presence of this function means that the standard
1.96 + templatedoperator<<() (defined in s32strm.h) is available to externalise objects
1.97 + of the derived class.
1.98 +
1.99 + @param aStream Stream to which the format layer should be externalised. */
1.100 + virtual void ExternalizeL(RWriteStream& aStream)const=0;
1.101 + //
1.102 + // Restore a format chain where the end of the chain is based on aBase (where aBase may be null).
1.103 + IMPORT_C void InternalizeChainL(RReadStream& aStream,const CFormatLayer* aBase=NULL);
1.104 + // Stores a format layer chain of length length-aExcludeCount (or by default the whole chain).
1.105 + IMPORT_C void ExternalizeChainL(RWriteStream& aStream,TInt aExcludeCount=0)const;
1.106 + /** Implementations of this function compare another format layer with the current
1.107 + object. For the two layers to be equal, they must have the same contents and
1.108 + (if the second parameter is ETrue), their based-on links must point to the
1.109 + same format layer.
1.110 +
1.111 + @param aLayer The layer to compare to this format layer.
1.112 + @param aCheckBasedOnLink If ETrue, both layers' based-on links must point to
1.113 + the same format layer. If EFalse, the based-on links are not used in the comparison.
1.114 + By default, ETrue.
1.115 + @return ETrue if the two layers are identical, otherwise EFalse. */
1.116 + virtual TBool IsIdentical(CFormatLayer* aLayer,TBool aCheckBasedOnLink=ETrue)const=0;
1.117 + IMPORT_C TBool IsEmpty()const;
1.118 + void Swap(CFormatLayer& aLayer);
1.119 +private:
1.120 + CFormatLayer(const CFormatLayer& aFormatLayer);
1.121 + CFormatLayer& operator=(const CFormatLayer& aFormatLayer);
1.122 + virtual CFormatLayer* DoCloneL()const=0;
1.123 +protected:
1.124 + CFormatLayer();
1.125 + ~CFormatLayer();
1.126 + virtual CFormatLayer* RestoreNewL(RReadStream& aStream)=0;
1.127 + void ExternalizeLayersRecurseL(RWriteStream& aStream,TInt aDescendantCount)const;
1.128 + TBool IsIdentical(const TUint8* aPtr,TInt aSize)const;
1.129 + const TUint8* Ptr(TInt& aSize)const;
1.130 + void CloneLayerL(CFormatLayer* aClone)const;
1.131 +protected:
1.132 + RFormatStream iStore;
1.133 + const CFormatLayer* iBasedOn; // If non-null used to inherit format attributes from the lower layer.
1.134 + __DECLARE_TEST;
1.135 + };
1.136 +
1.137 +
1.138 +/**
1.139 +A paragraph format layer.
1.140 +
1.141 +Has a pointer (stored in its base class CFormatLayer) to another paragraph
1.142 +format layer which may be NULL. This pointer is referred to as the based-on
1.143 +link. A paragraph format layer is owned by an instance of the CGlobalText
1.144 +class and stores the object's global paragraph formatting. Implements persistence
1.145 +and allows attributes to be set and sensed.
1.146 +@publishedAll
1.147 +@released
1.148 +*/
1.149 +class CParaFormatLayer : public CFormatLayer
1.150 + {
1.151 +public:
1.152 + IMPORT_C static CParaFormatLayer* NewL();
1.153 + IMPORT_C static CParaFormatLayer* NewL(const CParaFormat* aParaFormat,const TParaFormatMask& aMask);
1.154 + IMPORT_C static CParaFormatLayer* NewL(RReadStream& aStream);
1.155 + static CParaFormatLayer* NewL(const CParaFormatLayer* aLayer);
1.156 + static CParaFormatLayer* NewCopyBaseL(const CParaFormatLayer* aLayer);
1.157 + // Create a new instance, restoring it from the specified stream.
1.158 + // The based on link is NULL. Restores only one layer.
1.159 + //
1.160 + // Persistence
1.161 + IMPORT_C virtual void InternalizeL(RReadStream& aStream,const CFormatLayer* aBase=NULL);
1.162 + IMPORT_C virtual void ExternalizeL(RWriteStream& aStream)const;
1.163 + //
1.164 + // Core methods
1.165 + IMPORT_C void SetL(const CParaFormat* aDesiredEffectiveFormat,const TParaFormatMask& aMask);
1.166 + IMPORT_C void SenseEffectiveL(CParaFormat* aParaFormat,CParaFormat::TParaFormatGetMode aMode=CParaFormat::EAllAttributes)const;
1.167 + IMPORT_C void SenseL(CParaFormat* aParaFormat,TParaFormatMask& aMask,CParaFormat::TParaFormatGetMode aMode=CParaFormat::EAllAttributes)const;
1.168 + //
1.169 + // Utilities
1.170 + inline CParaFormatLayer* CloneL()const;
1.171 + IMPORT_C TBool IsIdenticalL(const CParaFormat* aParaFormat,const TParaFormatMask& aMask)const;
1.172 + IMPORT_C virtual TBool IsIdentical(CFormatLayer* aLayer,TBool aCheckBasedOnLink=ETrue)const;
1.173 + IMPORT_C virtual TUid Type()const;
1.174 + IMPORT_C const TUint8* Ptr(TInt& aSize)const;
1.175 +private:
1.176 + //
1.177 + // No implementation provided
1.178 + CParaFormatLayer(const CParaFormatLayer& aParaFormatLayer);
1.179 + CParaFormatLayer& operator=(const CParaFormatLayer& aParaFormatLayer);
1.180 + IMPORT_C virtual CFormatLayer* DoCloneL()const;
1.181 + void FillParaFormatL(CParaFormat* aParaFormat,TParaFormatMask& aMask,CParaFormat::TParaFormatGetMode aMode)const;
1.182 + void CleanupEffectiveFormat(CParaFormat* aParaFormat,TParaFormatMask aMask)const;
1.183 + void CleanupBorders(CParaFormat* aParaFormat)const;
1.184 +protected:
1.185 + CParaFormatLayer();
1.186 + virtual CFormatLayer* RestoreNewL(RReadStream& aStream);
1.187 + };
1.188 +
1.189 +/**
1.190 +Character format layer.
1.191 +
1.192 +Uses a pointer (stored in its base class CFormatLayer) to another character
1.193 +format layer which may be NULL. This pointer is referred to as the based-on
1.194 +link. A character format layer is owned by an instance of the CGlobalText
1.195 +class and stores the object's global character formatting. Implements persistence
1.196 +and allows attributes to be set and sensed.
1.197 +@publishedAll
1.198 +@released
1.199 +*/
1.200 +class CCharFormatLayer : public CFormatLayer
1.201 + {
1.202 +public:
1.203 + IMPORT_C static CCharFormatLayer* NewL();
1.204 + IMPORT_C static CCharFormatLayer* NewL(const TCharFormat& aFormat,const TCharFormatMask& aMask);
1.205 + IMPORT_C static CCharFormatLayer* NewL(RReadStream& aStream);
1.206 + IMPORT_C virtual void InternalizeL(RReadStream& aStream,const CFormatLayer* aBase=NULL);
1.207 + IMPORT_C virtual void ExternalizeL(RWriteStream& aStream)const;
1.208 + IMPORT_C void SetL(const TCharFormat& aCharFormat,const TCharFormatMask& aMask);
1.209 + IMPORT_C void SenseEffective(TCharFormat& aCharFormat)const;
1.210 + IMPORT_C void Sense(TCharFormat& aCharFormat,TCharFormatMask& aMask)const;
1.211 + inline CCharFormatLayer* CloneL()const;
1.212 + IMPORT_C virtual TBool IsIdentical(CFormatLayer* aLayer,TBool aCheckBasedOnLink=ETrue)const;
1.213 + IMPORT_C TBool IsIdentical(const TCharFormat& aCharFormat,const TCharFormatMask& aMask)const;
1.214 + IMPORT_C const TUint8* Ptr(TInt& aSize)const;
1.215 +
1.216 + // non-exported public functions
1.217 + static CCharFormatLayer* NewL(const CCharFormatLayer* aLayer);
1.218 + static CCharFormatLayer* NewCopyBaseL(const CCharFormatLayer* aLayer);
1.219 + static CCharFormatLayer* NewL(const TCharFormatX& aFormat,const TCharFormatXMask& aMask);
1.220 + void SetL(const TCharFormatX& aCharFormat,const TCharFormatXMask& aMask);
1.221 + void SenseEffective(TCharFormatX& aCharFormat)const;
1.222 + void Sense(TCharFormatX& aCharFormat,TCharFormatXMask& aMask) const;
1.223 +
1.224 +private:
1.225 + CCharFormatLayer();
1.226 + virtual CFormatLayer* RestoreNewL(RReadStream& aStream);
1.227 + virtual void FillCharFormat(TCharFormatX& aCharFormat,TCharFormatXMask& aMask)const;
1.228 + IMPORT_C virtual CFormatLayer* DoCloneL()const;
1.229 + };
1.230 +
1.231 +
1.232 +#include <txtfmlyr.inl>
1.233 +
1.234 +
1.235 +#endif