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 __TXTSTD_H__ sl@0: #define __TXTSTD_H__ sl@0: sl@0: #include sl@0: #include sl@0: sl@0: class TCharFormatX sl@0: /** sl@0: The extended character format used internally. sl@0: As well as the public TCharFormat attributes it stores sl@0: any attributes that are useful only inside ETEXT. sl@0: @internalComponent sl@0: */ sl@0: { sl@0: public: sl@0: TCharFormatX(): iParserTag(0) { } sl@0: TCharFormatX(const TCharFormat& aCharFormat): iCharFormat(aCharFormat), iParserTag(0) { } sl@0: sl@0: TCharFormat iCharFormat; sl@0: TUint iParserTag; sl@0: }; sl@0: sl@0: /** sl@0: Attributes not used in the format masks, but used to store system colour indices, etc. sl@0: This method maintains data compatibility. For example, a paragraph fill colour, including its sl@0: fourth byte that is used as the system colour index, is selected by a single mask but corresponding sl@0: to EAttFillColor, but is stored using two attribute flags: one for the three bytes of the RGB colour, sl@0: and one extra optional one for the system colour index. sl@0: @internalComponent sl@0: */ sl@0: enum TTextFormatNonMaskableAttribute sl@0: { sl@0: EAttFillSystemColor = ETextFormatAttributeCount, sl@0: EAttBulletSystemColor, sl@0: EAttTopBorderSystemColor, sl@0: EAttBottomBorderSystemColor, sl@0: EAttLeftBorderSystemColor, sl@0: EAttRightBorderSystemColor, sl@0: EAttTextSystemColor, sl@0: EAttFontHighlightSystemColor, sl@0: EAttParaLanguageX, sl@0: EAttCharLanguageX, sl@0: EAttBulletX, sl@0: EAttBitmapType, sl@0: sl@0: EExternalizedAttributeCount sl@0: }; sl@0: sl@0: sl@0: /** sl@0: Attributes used to mask internal character attributes. sl@0: @internalComponent sl@0: */ sl@0: enum TCharFormatXAttribute sl@0: { sl@0: EAttParserTag = EExternalizedAttributeCount, sl@0: sl@0: EAttributeCount sl@0: }; sl@0: sl@0: class TCharFormatXMask: public TCharFormatMask sl@0: /** sl@0: A mask that can deal with TCharFormatXAttributes as well as TTextFormatAttributes sl@0: @internalComponent sl@0: */ sl@0: { sl@0: public: sl@0: TCharFormatXMask(): TCharFormatMask() { } sl@0: TCharFormatXMask(TCharFormatMask aMask): TCharFormatMask(aMask) { } sl@0: sl@0: /* sl@0: An offset to make extended attribute flags contiguous with ordinary character attributes sl@0: so that we don't run out of bits if more non-maskable attributes are invented. sl@0: */ sl@0: enum sl@0: { sl@0: EAttribOffset = EExternalizedAttributeCount - ETextFormatAttributeCount sl@0: }; sl@0: sl@0: void SetAttrib(TTextFormatAttribute aAttribute) sl@0: { TCharFormatMask::SetAttrib(aAttribute); } sl@0: void ClearAttrib(TTextFormatAttribute aAttribute) sl@0: { TCharFormatMask::ClearAttrib(aAttribute); } sl@0: TBool AttribIsSet(TTextFormatAttribute aAttribute) const sl@0: { return TCharFormatMask::AttribIsSet(aAttribute); } sl@0: sl@0: void SetAttrib(TCharFormatXAttribute aAttribute) sl@0: { TCharFormatMask::SetAttrib((TTextFormatAttribute)(aAttribute - EAttribOffset)); } sl@0: void ClearAttrib(TCharFormatXAttribute aAttribute) sl@0: { TCharFormatMask::ClearAttrib((TTextFormatAttribute)(aAttribute - EAttribOffset)); } sl@0: TBool AttribIsSet(TCharFormatXAttribute aAttribute) const sl@0: { return TCharFormatMask::AttribIsSet((TTextFormatAttribute)(aAttribute - EAttribOffset)); } sl@0: void ClearExtendedAttribs() { ClearAttrib(EAttParserTag); } sl@0: }; sl@0: sl@0: sl@0: /** sl@0: @internalComponent sl@0: */ sl@0: enum TETextPanic sl@0: { sl@0: // General sl@0: EDebug, sl@0: EDebugDeleteZeroLength, sl@0: sl@0: // Format attributes sl@0: ETabNotFound, sl@0: sl@0: // Format layer storage sl@0: EAttributeLengthLookupNegative, sl@0: EStoreTabError, sl@0: ECannotStoreFormatLayerChain, sl@0: ECorruptFormatLayerChain, sl@0: ECorruptFormatLayer, sl@0: ENullFormatPointer, sl@0: sl@0: // Picture Restoration sl@0: ENullStore, sl@0: EInvalidPictureFactorySettings, sl@0: ENullStoreResolver, sl@0: sl@0: // Plain text sl@0: ECharPosBeyondDocument, sl@0: EConstructCalledTwice, sl@0: ECopyToStreamNegativeLength, sl@0: EPasteNegativeLength, sl@0: EDeleteNegativeLength, sl@0: ECorruptTextStore, sl@0: EExtractBufferTooSmall, sl@0: ENoTextField, sl@0: EExportLineWrapInvalid, sl@0: sl@0: // Global text sl@0: ENullFormatLayerHandle, sl@0: EApplyParaFormatNegativeLength, sl@0: EApplyCharFormatNegativeLength, sl@0: EGetParaFormatNegativeLength, sl@0: EGetCharFormatNegativeLength, sl@0: sl@0: // Rich text sl@0: ENullRichTextInsert, sl@0: EMarkupAlreadyPresent, sl@0: sl@0: // Rich text index sl@0: ERichTextIndexIntegrityErr, sl@0: EPhraseIxPresentWithNoParaIx, sl@0: ERichTextIndexReset, sl@0: ESetInsertCharFormatIntegrityErr, sl@0: EInsertEmbeddedParaErr, sl@0: EInsertNullPicHdrData, sl@0: EDeleteFromParagraphInvalidRange, sl@0: EDeleteParagraphInvalidStartValue, sl@0: EDeleteParagraphInvalidEndValue, sl@0: EReclaimShareError, sl@0: EParaAttribsNotInSharedList, sl@0: ERichTextNotSetForUsingStyles, sl@0: EPictureHeaderIndexOutOfRange, sl@0: ELostPictureHeader, sl@0: ESplitPhraseCalledOnSharedPara, sl@0: ESplitPhraseCalledOnPicturePhrase, sl@0: EGetPictureSizeCalledOnNonPicturePhrase, sl@0: EModifiedPicturePhraseLength, sl@0: EReleasCharFormatLayerOwnershipCalledOnPicturePhrase, sl@0: ERichTextStorePictureIntegrityError, sl@0: ERtIndexInternalizeCalledOnNonEmptySource, sl@0: ERtExternalizeParaIx, sl@0: ESharedParaCountStreamOverflow, sl@0: EEndOfSharedParaListEncountered, sl@0: EPasteParaIxError, sl@0: EPastePhraseIxErr, sl@0: ESharedFormatsMapIntegrityError, sl@0: ESharedFormatsMapOverFlow, sl@0: EParagraphStyleNegativeLength, sl@0: EApplyParaStyleNegativeLength, sl@0: ERemoveSpecificParaFormatNegativeLength, sl@0: ECopyToClipboardNegativeLength, sl@0: EClipboardIntegrity, sl@0: ENonOverloadedInsertCalledWithPictureCharacter, sl@0: EAppendLFoundInMemoryPicture, sl@0: sl@0: // style clipboarding sl@0: EStyleClipboardIntegrityError, sl@0: sl@0: // Paragraph styles sl@0: EStyleIntegrityError, sl@0: EStyleIndexOutOfRange, sl@0: sl@0: // Front end processor inline editing sl@0: ENotCurrentlyFepInlineEditing, sl@0: EAlreadyFepInlineEditing, sl@0: sl@0: // Parser system sl@0: EParserListNotInitialized, sl@0: EParserListAlreadyExists, sl@0: EParserListNotActive, sl@0: EParserCallbackAlreadySet, sl@0: EParserTagNotFound, sl@0: EParserListTextIndexNotInitialized, sl@0: }; sl@0: sl@0: /** sl@0: @internalComponent sl@0: */ sl@0: GLREF_C void Panic(TETextPanic aPanic); sl@0: GLREF_C void ReleaseOnCleanup(TAny* aParaAttribs); sl@0: GLREF_C void ResetOnCleanup(TAny* aParaFormat); sl@0: sl@0: inline void ResetOnCleanupL( CParaFormat* aParaFormat) sl@0: { sl@0: CleanupStack::PushL(TCleanupItem(ResetOnCleanup,aParaFormat)); sl@0: } sl@0: sl@0: #if defined(__DLL__) sl@0: #define DLLEXPORT_C EXPORT_C sl@0: #else sl@0: #define DLLEXPORT_C sl@0: #endif sl@0: sl@0: #endif