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 __FRMTLAY_H__ sl@0: #define __FRMTLAY_H__ sl@0: sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: sl@0: class CWindowGc; sl@0: class MLayDoc; sl@0: class TLayDocTextSource; sl@0: class TCursorPosition; sl@0: sl@0: class TLayDocTextSource; sl@0: class CTmTextLayout; sl@0: class TTmHighlightExtensions; sl@0: class MTmSource; sl@0: class TTmFormatParamBase; sl@0: sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS sl@0: #include sl@0: #endif sl@0: sl@0: /** sl@0: This interface class defines an interface for clients of Form to provided sl@0: implementations of customisation interfaces relating to the source text sl@0: document as requried by the internals of Form and Tagma. Its use by sl@0: Form clients is optional. sl@0: Derived objects of this interface are registered with the CTextLayout sl@0: API and are called from the TLayDocTextSource class at present. sl@0: @publishedAll sl@0: @released sl@0: @see MTmInlineTextSource sl@0: */ sl@0: class MFormCustomInterfaceProvider sl@0: { sl@0: public: sl@0: /** sl@0: Form uses this method to request an interface implmentation for the sl@0: specified interface Uid. See class description for interfaces covered sl@0: by this API. sl@0: @param aInterfaceId sl@0: The unique identifier for the interface wanted by Form. sl@0: @return sl@0: Ptr to interface instance or 0 if not supported by client sl@0: */ sl@0: virtual TAny* GetExtendedInterface(const TUid& aInterfaceId) = 0; sl@0: }; sl@0: sl@0: sl@0: /** Parameter used to control which part of a line (top, baseline or bottom) sl@0: should be scrolled to a certain vertical position in a view rectangle. Used sl@0: as a parameter in functions like CTextView::HandleGlobalChangeL() and sl@0: CTextLayout::SetViewL(). The selected part of the line is called the hotspot. sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class TViewYPosQualifier sl@0: { sl@0: friend class CTextLayout; sl@0: friend class CTextView; sl@0: public: sl@0: /** Which part of a line (top, baseline or bottom) should appear at a sl@0: vertical pixel position. */ sl@0: enum TPartOfLine sl@0: { sl@0: /** The top pixel is placed at the specified vertical point. */ sl@0: EFViewTopOfLine = 1, sl@0: /** The baseline is placed at the specified vertical point. */ sl@0: EFViewBaseLine = 0, sl@0: /** The bottom pixel is placed at the specified vertical point. */ sl@0: EFViewBottomOfLine = 2 sl@0: }; sl@0: sl@0: /** Whether the top line in the view should be fully visible. */ sl@0: enum TFullyVisible sl@0: { sl@0: /** Force a partially visible top line to be fully visible. */ sl@0: EFViewForceLineFullyVisible = ETrue, sl@0: /** Do not force a partially visible top line to be fully visible. */ sl@0: EFViewDontForceLineFullyVisible = EFalse sl@0: }; sl@0: public: sl@0: inline TViewYPosQualifier(); sl@0: IMPORT_C void SetHotSpot(TPartOfLine aHotSpot); sl@0: IMPORT_C void SetFillScreen(TBool aFillScreen = ETrue); sl@0: IMPORT_C void SetMakeLineFullyVisible(TFullyVisible aMakeLineFullyVisible = EFViewForceLineFullyVisible); sl@0: private: sl@0: TPartOfLine iHotSpot; sl@0: TBool iFillScreen; sl@0: TFullyVisible iFullyVisible; sl@0: }; sl@0: sl@0: /** sl@0: A structure used to return the results of a reformatting operation. sl@0: @see CTextLayout::HandleBlockChangeL() sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class TViewRectChanges sl@0: sl@0: { sl@0: public: sl@0: inline TViewRectChanges(); sl@0: sl@0: public: sl@0: /** The vertical coordinate of the top of the first line of reformatted sl@0: text. */ sl@0: TInt iFormattedFrom; sl@0: /** The vertical coordinate of the bottom of the last line of reformatted sl@0: text. */ sl@0: TInt iFormattedTo; sl@0: /** The number of pixels by which text above the reformatted or edited sl@0: block has scrolled (positive values mean the text moved down). */ sl@0: TInt iScrollAtTop; sl@0: /** The number of pixels by which text below the reformatted or edited sl@0: block has scrolled (positive values mean the text moved down). */ sl@0: TInt iScrollAtBottom; sl@0: }; sl@0: sl@0: /** sl@0: The cursor or cursor selection within a document. sl@0: sl@0: If the cursor and anchor position differ, the selection covers the text from sl@0: the lower to the higher position, not including the character after the higher sl@0: position. If the selection is changed (by shift plus arrow keys in many UIs) sl@0: the cursor position changes and the anchor remains the same. sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class TCursorSelection sl@0: sl@0: { sl@0: public: sl@0: inline TCursorSelection(); sl@0: inline TCursorSelection(TInt aCursorPos,TInt aAnchorPos); sl@0: inline void SetSelection(TInt aCursorPos,TInt aAnchorPos); sl@0: inline TInt LowerPos() const; sl@0: inline TInt HigherPos() const; sl@0: inline TInt Length() const; sl@0: public: sl@0: /** The cursor position. */ sl@0: TInt iCursorPos; sl@0: /** The anchor position. */ sl@0: TInt iAnchorPos; sl@0: }; sl@0: sl@0: /** sl@0: Parameters used by functions that draw text. sl@0: sl@0: An object of this class is passed to CTextLayout::DrawL() and to sl@0: InvertRangeL(). The draw context includes the view rectangle, the graphics sl@0: context, the background colour and the margin widths. sl@0: sl@0: You only need to use this class directly when you are using a CTextLayout sl@0: object which is not owned by a CTextView object. sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class TDrawTextLayoutContext sl@0: sl@0: { sl@0: private: sl@0: enum TDrawMode sl@0: { sl@0: EFDrawText=0x001, sl@0: EFDrawGraphics=0x002, sl@0: EFUseClippingRect=0x004, sl@0: EFUseWindowGc=0x008, sl@0: EFUseGcClear=0x020, sl@0: EFUseBackgroundColor=0x040, sl@0: EFUseOverrideTextColor=0x080, sl@0: EFParagraphFillTextOnly=0x100, sl@0: EFAllFlags=0xfff sl@0: }; sl@0: public: sl@0: IMPORT_C TDrawTextLayoutContext(); sl@0: sl@0: IMPORT_C void SetGc(CGraphicsContext* aGc,CGraphicsContext* aPictureGc=NULL); sl@0: IMPORT_C void SetBitmapGc(CBitmapContext* aGc,CBitmapContext* aPictureGc=NULL); sl@0: IMPORT_C void SetWindowGc(CWindowGc* aGc,CWindowGc* aPictureGc=NULL); sl@0: IMPORT_C void SetDrawToEveryPixel(TBool aDrawToEveryPixel); sl@0: IMPORT_C void SetTextColorOverride(const TRgb *aOverrideColor); sl@0: IMPORT_C void SetDrawTextOnly(); sl@0: IMPORT_C void SetDrawGraphicsOnly(); sl@0: IMPORT_C void SetDrawTextAndGraphics(); sl@0: IMPORT_C void SetClipping(TBool aClipping); sl@0: // deprecated 7.0 sl@0: IMPORT_C void SetParagraphFillTextOnly(TBool aFillTextOnly); sl@0: sl@0: //Enquiry functions sl@0: IMPORT_C const TRgb* TextOverrideColor() const; sl@0: IMPORT_C CGraphicsContext* PrimaryGc() const; sl@0: IMPORT_C CGraphicsContext* PictureGc() const; sl@0: IMPORT_C TBool UseClippingRect() const; sl@0: IMPORT_C TBool UseGcClear() const; sl@0: IMPORT_C TBool DrawText() const; sl@0: IMPORT_C TBool DrawGraphics() const; sl@0: IMPORT_C TBool UseBackgroundColor() const; sl@0: // deprecated 7.0 sl@0: IMPORT_C TBool ParagraphFillTextOnly() const; sl@0: sl@0: //Physical dimensions sl@0: IMPORT_C TRect TextArea() const; sl@0: IMPORT_C TInt DisplayHeight() const; sl@0: IMPORT_C TPoint TopLeftTextArea() const; sl@0: IMPORT_C TRect TotalMargin() const; sl@0: IMPORT_C TRect LabelMargin() const; sl@0: IMPORT_C TBool IsLabelMargin() const; sl@0: IMPORT_C TRect GutterMargin() const; sl@0: IMPORT_C TBool IsGutterMargin() const; sl@0: IMPORT_C TPoint TopLeftText() const; sl@0: IMPORT_C void WindowToText(TPoint& aWinPos) const; sl@0: IMPORT_C void WindowToText(TRect& aRect) const; sl@0: IMPORT_C void TextToWindow(TPoint& aTextAreaPos) const; sl@0: IMPORT_C void TextToWindow(TRect& aRect) const; sl@0: sl@0: TBool UseWindowGc() const; sl@0: void SetDrawMode(TUint aDrawMode); sl@0: TUint DrawMode() const; sl@0: sl@0: public: sl@0: /** The view rectangle (specified in window coordinates). This is used to sl@0: set the area in which text can be drawn. Text can only be drawn within the sl@0: intersection between the text area and the aDrawRect parameter passed to sl@0: CTextLayout::DrawL() or InvertRangeL(). */ sl@0: TRect iViewRect; sl@0: /** The label margin width. By default zero. Must have the same value as sl@0: the label margin width as set in the text layout object. */ sl@0: TInt iLabelMarginWidth; sl@0: /** The gutter margin width (also known as the line cursor margin width). sl@0: By default zero. */ sl@0: TInt iGutterMarginWidth; sl@0: /** The horizontal offset between window coordinates and text layout sl@0: coordinates. */ sl@0: TInt iTextStartX; sl@0: /** The background colour for the view rectangle. The background colour is sl@0: used to fill the parts of the view rectangle in which text cannot appear, sl@0: for example, below the last line of the document and in the label, line sl@0: cursor and left text margins. */ sl@0: TLogicalRgb iBackgroundColor; sl@0: private: sl@0: CGraphicsContext* iGc; sl@0: CGraphicsContext* iPictureGc; sl@0: TLogicalRgb iOverrideTextColor; sl@0: TUint iDrawMode; sl@0: }; sl@0: sl@0: /** sl@0: An abstract class which specifies the protocol for customising the way text sl@0: and its background are drawn. sl@0: sl@0: Common uses for this are to implement custom highlighting or to draw a sl@0: background bitmap. You must create an object of a class derived from this class sl@0: and call CTextLayout::SetCustomDraw(), passing a pointer to the object. All of sl@0: these functions have default implementations. Your class can override any of the sl@0: virtual functions listed below. sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class MFormCustomDraw sl@0: sl@0: { sl@0: public: sl@0: sl@0: class TParam sl@0: /** sl@0: Parameters used by several custom draw functions sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: { sl@0: public: sl@0: TParam(CGraphicsContext& aGc,MGraphicsDeviceMap& aMap,const TPoint& aTextLayoutTopLeft,const TRect& aDrawRect): sl@0: iGc(aGc), iMap(aMap), iTextLayoutTopLeft(aTextLayoutTopLeft), iDrawRect(aDrawRect) { } sl@0: sl@0: CGraphicsContext& iGc; sl@0: MGraphicsDeviceMap& iMap; sl@0: const TPoint& iTextLayoutTopLeft; sl@0: const TRect& iDrawRect; sl@0: }; sl@0: sl@0: class TLineInfo sl@0: /** sl@0: Contains the line metrics. sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: { sl@0: public: sl@0: TLineInfo(const TRect& aOuterRect,const TRect& aInnerRect,TInt aBaseline): sl@0: iOuterRect(aOuterRect), iInnerRect(aInnerRect), iBaseline(aBaseline) { } sl@0: sl@0: const TRect& iOuterRect; sl@0: const TRect& iInnerRect; sl@0: TInt iBaseline; sl@0: }; sl@0: sl@0: IMPORT_C virtual void DrawBackground(const TParam& aParam,const TRgb& aBackground,TRect& aDrawn) const; sl@0: IMPORT_C virtual void DrawLineGraphics(const TParam& aParam,const TLineInfo& aLineInfo) const; sl@0: IMPORT_C virtual void DrawText(const TParam& aParam,const TLineInfo& aLineInfo,const TCharFormat& aFormat, sl@0: const TDesC& aText,const TPoint& aTextOrigin,TInt aExtraPixels) const; sl@0: IMPORT_C virtual TRgb SystemColor(TUint aColorIndex,TRgb aDefaultColor) const; sl@0: sl@0: IMPORT_C virtual void DrawText(const TParam& aParam,const TLineInfo& aLineInfo,const TCharFormat& aFormat, sl@0: const TDesC& aText,const TInt aStart, const TInt aEnd, const TPoint& aTextOrigin,TInt aExtraPixels) const; sl@0: IMPORT_C virtual void MFormCustomDraw_Reserved_2(); sl@0: }; sl@0: sl@0: sl@0: /** sl@0: An interface class that can be derived from to implement custom line breaking. sl@0: sl@0: Custom line breaking allows the Text Views line wrapping algorithm to break sl@0: lines in any way. For instance, it may be used to avoid the jagged white space sl@0: at the right edge of text windows caused by normal line wrapping on a small sl@0: screen. sl@0: sl@0: All of these functions have a default implementation. To change the default sl@0: behaviour, a pointer to an object that overrides any or all of the functions sl@0: in the interface needs to be passed to the function CTextLayout::SetCustomWrap(). sl@0: @since 6.2 sl@0: sl@0: @see CTextLayout::SetCustomWrap() sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class MFormCustomWrap sl@0: sl@0: { sl@0: public: sl@0: IMPORT_C virtual TUint LineBreakClass(TUint aCode,TUint& aRangeStart,TUint& aRangeEnd) const; sl@0: IMPORT_C virtual TBool LineBreakPossible(TUint aPrevClass,TUint aNextClass,TBool aHaveSpaces) const; sl@0: IMPORT_C virtual TBool GetLineBreakInContext(const TDesC& aText,TInt aMinBreakPos,TInt aMaxBreakPos, sl@0: TBool aForwards,TInt& aBreakPos) const; sl@0: IMPORT_C virtual TBool IsHangingCharacter(TUint aChar) const; sl@0: private: sl@0: IMPORT_C virtual void MFormCustomWrap_Reserved_1(); sl@0: IMPORT_C virtual void MFormCustomWrap_Reserved_2(); sl@0: }; sl@0: sl@0: sl@0: /** sl@0: Mixin class used to customize visible appearance of invisible characters sl@0: such as a paragraph mark or a tab. sl@0: sl@0: @see CTextView::SetCustomInvisibleCharacterRemapper() sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class MFormCustomInvisibleCharacterRemapper sl@0: { sl@0: public: sl@0: IMPORT_C static TUint DefaultMapping(TUint aChar, const TNonPrintingCharVisibility aNonPrintingCharVisibility, const TLayDocTextSource& aLayDoc); sl@0: sl@0: /** sl@0: Allows custom remapping of invisible characters. sl@0: sl@0: Called by TLayDocTextSource::Map() if it has been created and registered sl@0: with TLayDocTextSource using CTextLayout::SetInvisibleCharacterRemapper(). sl@0: sl@0: Unless there is a specific reason for doing otherwise it is recommended sl@0: that where this function has not remapped a given character it should sl@0: pass it to DefaultMapping() to let it try. sl@0: sl@0: @param aChar sl@0: Invisible character to be remapped sl@0: @param aDesiredVisibilities sl@0: Current state of flags showing visibility of invisible characters sl@0: @param aLayDoc sl@0: Const ref to the calling CLayDocTextSource sl@0: @return sl@0: The replacement character if remapping has taken place, else return original character sl@0: */ sl@0: virtual TUint Remap(TUint aChar, const TNonPrintingCharVisibility aNonPrintingCharVisibility, const TLayDocTextSource& aLayDoc) = 0; sl@0: }; sl@0: sl@0: /** sl@0: Text layout. sl@0: sl@0: CTextLayout is the lowest-level text formatting class in the Text Views API. It sl@0: obtains text and formatting attributes via the MLayDoc interface class and sl@0: formats the text to a certain width. sl@0: sl@0: It has functions for drawing the text and performing hit-detection that is, sl@0: converting x-y coordinates to document positions, and vice versa. It defines sl@0: many public functions that are not generally useful, but are called by the sl@0: higher-level CTextView class, or exist only for the convenience of closely sl@0: associated classes like the printing and pagination systems. These are sl@0: identified in the documentation by the text "not generally useful". sl@0: sl@0: When using the CTextLayout class, you must be aware of what functions have sl@0: previously been called. For example: sl@0: sl@0: 1) Formatting and scrolling functions must not be called if a CTextView object sl@0: owns the CTextLayout object, because the CTextView object may be reformatting sl@0: the CTextLayout object asynchronously by means of an active object, or may hold sl@0: some state information about the CTextLayout object that would be invalidated sl@0: by reformatting. These functions are identified in the documentation by the sl@0: text "Do not use if a CTextView object owns this CTextLayout object.". sl@0: sl@0: 2) Functions that raise out of memory exceptions can leave the object in an sl@0: inconsistent state; these functions can be identified as usual by their sl@0: trailing L. When this occurs, it is necessary to discard the formatting sl@0: information by calling DiscardFormat(). sl@0: sl@0: 3) Some functions change formatting parameters like the wrap width or band sl@0: height, but do not reformat to reflect the change. These functions are sl@0: identified in the documentation by the text "Reformat needed". sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class CTextLayout: public CBase sl@0: sl@0: { sl@0: friend class CTestTextLayout; sl@0: public: sl@0: sl@0: /**Flags used by CTextLayout::SetViewL(). Whether to reformat and redraw.*/ sl@0: enum TDiscard sl@0: { sl@0: /** Discard all formatting; redraw. */ sl@0: EFViewDiscardAllFormat = TRUE, sl@0: /** Do not discard all formatting; redraw. */ sl@0: EFViewDontDiscardFormat = FALSE sl@0: }; sl@0: sl@0: /** Indicates whether blank space should scroll. sl@0: Used by several CTextView and CTextLayout scrolling functions. */ sl@0: enum TAllowDisallow sl@0: { sl@0: /** Allow blank space to scroll. */ sl@0: EFAllowScrollingBlankSpace = TRUE, sl@0: /** Disallow blank space from scrolling. */ sl@0: EFDisallowScrollingBlankSpace = FALSE sl@0: }; sl@0: sl@0: enum // flags for HandleCharEditL sl@0: { sl@0: /** Insert a character, (not a paragraph delimiter). */ sl@0: EFCharacterInsert, sl@0: /** Insert a paragraph delimiter. */ sl@0: EFParagraphDelimiter, sl@0: /** Delete single character to the left. */ sl@0: EFLeftDelete, sl@0: /** Delete single character to the right. */ sl@0: EFRightDelete sl@0: }; sl@0: sl@0: enum sl@0: { sl@0: /** A value greater than any possible display height indicates that the sl@0: entire visible area, at least, was scrolled, and so there is no point sl@0: in blitting text; a full redraw is needed. sl@0: */ sl@0: EFScrollRedrawWholeScreen = CLayoutData::EFLargeNumber, sl@0: /** The maximum line width when wrapping is unset. */ sl@0: EFMaximumLineWidth = CLayoutData::EFBodyWidthForNoWrapping, sl@0: }; sl@0: sl@0: enum sl@0: { sl@0: /** Wrapping off; overrides the paragraph format. */ sl@0: EFAllParagraphsNotWrapped = TRUE, sl@0: /** Wrapping on, unless CParaFormat::iWrap is false. */ sl@0: EFParagraphsWrappedByDefault = FALSE sl@0: }; sl@0: sl@0: /** Amount to format. Used by CTextLayout::SetAmountToFormat(). */ sl@0: enum TAmountFormatted sl@0: { sl@0: /** Format the whole document. */ sl@0: EFFormatAllText = FALSE, sl@0: /** Format the visible band only. */ sl@0: EFFormatBand = TRUE, sl@0: }; sl@0: sl@0: enum TScrollFlags sl@0: { sl@0: EFScrollOnlyToTopsOfLines = 1 sl@0: }; sl@0: sl@0: /** Formatting information. */ sl@0: enum TCurrentFormat sl@0: { sl@0: /** Returned by some CTextLayout enquiry functions to indicate that no sl@0: formatting has taken place so that the requested value cannot be sl@0: calculated. */ sl@0: EFNoCurrentFormat = -1, sl@0: /** Returned by CTextLayout::ParagraphHeight() when the paragraph is not formatted. */ sl@0: EFNotInCurrentFormat = 0 sl@0: }; sl@0: public: sl@0: class TRangeChange sl@0: /** sl@0: Specifies the range of characters involved when setting or clearing a sl@0: text selection. sl@0: sl@0: This class is used in the CTextLayout::Highlight() function. The following sl@0: code demonstrates how it should be used to clear an existing highlight and sl@0: set a new one: sl@0: sl@0: @code sl@0: CTextLayout::TRangeChange oldHighlight(anchorPos, old_cursorPos, sl@0: CTextLayout::TRangeChange::EClear); // existing highlight sl@0: CTextLayout::TRangeChange newHighlight(anchorPos, new_cursorPos, sl@0: CTextLayout::TRangeChange::ESet); // new one sl@0: newHighlight.OptimizeWith(oldHighlight); // doesn't matter which range is sl@0: the parameter and which is the calling object sl@0: layout.Highlight(oldHighlight,drawRect,context); // doesn't matter in which sl@0: order this and following line occur sl@0: layout.Highlight(newHighlight,drawRect,context); sl@0: @endcode sl@0: sl@0: @see CTextLayout::Highlight() sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: { sl@0: public: sl@0: /** Enumerates the possible change types. */ sl@0: enum TChangeType sl@0: { sl@0: /** The object is being used to set a range. */ sl@0: ESet, sl@0: /** The object is being used to clear a range. */ sl@0: EClear sl@0: }; sl@0: IMPORT_C TRangeChange(TInt aStart, TInt aEnd, TChangeType aChange); sl@0: IMPORT_C TRangeChange(); sl@0: IMPORT_C void Set(TInt aStart, TInt aEnd, TChangeType aChange); sl@0: IMPORT_C TChangeType Get(TInt& aStart, TInt& aEnd) const; sl@0: IMPORT_C void OptimizeWith(TRangeChange& aBuddy); sl@0: IMPORT_C TBool NonNull() const; sl@0: IMPORT_C TBool Clip(TInt aMin, TInt aMax); sl@0: sl@0: TBool IsJoinedTo(const TRangeChange aRange); sl@0: void Join(const TRangeChange aRange); sl@0: sl@0: private: sl@0: TInt iA; sl@0: TInt iB; sl@0: }; sl@0: sl@0: public: sl@0: sl@0: class TTagmaForwarder: public MTmTextLayoutForwarder sl@0: /** sl@0: A standard inquiry interface for the text formatting engine, built on sl@0: top of a CTextView object. sl@0: sl@0: To use it, construct a TTagmaForwarder object, then call InitL(), which sl@0: finishes background formatting, then call the MTmTextLayoutForwarder sl@0: functions. sl@0: sl@0: The class should only be used internally by FORM component. sl@0: @internalComponent sl@0: */ sl@0: { sl@0: public: sl@0: inline TTagmaForwarder(const CTextLayout& aLayout); sl@0: sl@0: private: sl@0: // from MTmTextLayoutForwarder sl@0: inline const CTmTextLayout& TextLayout() const; sl@0: inline void GetOrigin(TPoint& aPoint) const; sl@0: sl@0: const CTextLayout& iLayout; sl@0: }; sl@0: sl@0: /** sl@0: Accesses text supplied by MTmSource. sl@0: @internalComponent sl@0: */ sl@0: class TUtf32SourceCache sl@0: { sl@0: public: sl@0: TUtf32SourceCache(const MTmSource& aSource); sl@0: TUtf32SourceCache(const CTextLayout& aLayout); sl@0: TText GetUtf16(TInt aIndex); sl@0: TChar GetUtf32(TInt aIndex); sl@0: private: sl@0: const MTmSource* iSource; sl@0: TPtrC16 iCurrentView; sl@0: TInt iCurrentViewIndex; sl@0: }; sl@0: friend class TUtf32SourceCache; sl@0: sl@0: IMPORT_C static CTextLayout *NewL(MLayDoc *aDoc,TInt aWrapWidth); sl@0: IMPORT_C ~CTextLayout(); sl@0: IMPORT_C void DiscardFormat(); sl@0: IMPORT_C void SetLayDoc(MLayDoc *aDoc); sl@0: IMPORT_C void SetWrapWidth(TInt aWrapWidth); sl@0: IMPORT_C void SetBandHeight(TInt aHeight); sl@0: IMPORT_C TInt BandHeight() const; sl@0: IMPORT_C void SetImageDeviceMap(MGraphicsDeviceMap *aGd); sl@0: IMPORT_C void SetLabelsDeviceMap(MGraphicsDeviceMap *aDeviceMap); sl@0: IMPORT_C void SetAmountToFormat(TAmountFormatted aAmountOfFormat = EFFormatBand); sl@0: IMPORT_C TBool IsFormattingBand() const; sl@0: IMPORT_C void SetFormatMode(CLayoutData::TFormatMode aFormatMode,TInt aWrapWidth,MGraphicsDeviceMap* aFormatDevice); sl@0: IMPORT_C void ForceNoWrapping(TBool aNoWrapping = EFAllParagraphsNotWrapped); sl@0: IMPORT_C TBool IsWrapping() const; sl@0: IMPORT_C void SetTruncating(TBool aOn); sl@0: IMPORT_C TBool Truncating() const; sl@0: IMPORT_C void SetTruncatingEllipsis(TChar aEllipsis); sl@0: IMPORT_C TChar TruncatingEllipsis() const; sl@0: IMPORT_C void SetLabelsMarginWidth(TInt aWidth); sl@0: IMPORT_C void SetNonPrintingCharsVisibility(TNonPrintingCharVisibility aVisibility); sl@0: IMPORT_C TNonPrintingCharVisibility NonPrintingCharsVisibility() const; sl@0: IMPORT_C TBool IsBackgroundFormatting() const; sl@0: IMPORT_C void NotifyTerminateBackgroundFormatting(); sl@0: // deprecated 7.0 sl@0: IMPORT_C void SetExcludePartialLines(TBool aExcludePartialLines = TRUE); sl@0: // deprecated 7.0 sl@0: IMPORT_C TBool ExcludingPartialLines() const; sl@0: IMPORT_C void SetFontHeightIncreaseFactor(TInt aPercentage); sl@0: IMPORT_C TInt FontHeightIncreaseFactor() const; sl@0: IMPORT_C void SetMinimumLineDescent(TInt aPixels); sl@0: IMPORT_C TInt MinimumLineDescent() const; sl@0: IMPORT_C TInt DocumentLength() const; sl@0: IMPORT_C TInt ToParagraphStart(TInt& aDocPos) const; sl@0: IMPORT_C TInt PixelsAboveBand() const; sl@0: IMPORT_C TInt YBottomLastFormattedLine() const; sl@0: IMPORT_C TInt FormattedHeightInPixels() const; sl@0: IMPORT_C TInt PosRangeInBand(TInt& aDocPos) const; sl@0: IMPORT_C TBool PosInBand(const TTmDocPos& aDocPos,TTmLineInfo* aLineInfo = NULL) const; sl@0: IMPORT_C TBool PosInBand(TTmDocPos aDocPos,TPoint& aXyPos) const; sl@0: IMPORT_C TBool PosInBand(TInt aDocPos,TPoint& aXyPos) const; sl@0: IMPORT_C TBool PosIsFormatted(TInt aDocPos) const; sl@0: IMPORT_C TInt FirstCharOnLine(TInt aLineNo) const; sl@0: IMPORT_C TInt FormattedLength() const; sl@0: IMPORT_C TInt FirstFormattedPos() const; sl@0: IMPORT_C TInt NumFormattedLines() const; sl@0: IMPORT_C TInt FirstLineInBand() const; sl@0: IMPORT_C TInt GetLineRect(TInt aYPos,TRect& aLine) const; sl@0: IMPORT_C TInt ParagraphHeight(TInt aDocPos) const; sl@0: IMPORT_C TRect ParagraphRectL(TInt aDocPos) const; sl@0: IMPORT_C TBool CalculateHorizontalExtremesL(TInt& aLeftX,TInt& aRightX,TBool aOnlyVisibleLines, sl@0: TBool aIgnoreWrapCharacters = FALSE) const; sl@0: IMPORT_C void GetCharacterHeightAndAscentL(TInt aDocPos,TInt& aHeight,TInt& aAscent) const; sl@0: IMPORT_C void GetFontHeightAndAscentL(const TFontSpec& aFontSpec,TInt& aHeight,TInt& aAscent) const; sl@0: IMPORT_C TInt XyPosToDocPosL(TPoint &aPos, TUint aFlags = 0) const; sl@0: IMPORT_C TBool DocPosToXyPosL(TInt aDocPos, TPoint& aPos, TUint aFlags = 0) const; sl@0: IMPORT_C TBool FindXyPos(const TPoint& aXyPos,TTmPosInfo2& aPosInfo,TTmLineInfo* aLineInfo = NULL) const; sl@0: IMPORT_C TBool FindDocPos(const TTmDocPosSpec& aDocPos,TTmPosInfo2& aPosInfo,TTmLineInfo* aLineInfo = NULL) const; sl@0: IMPORT_C TRect GetLineRectL(TInt aDocPos1,TInt aDocPos2) const; sl@0: IMPORT_C TBool PictureRectangleL(TInt aDocPos,TRect& aPictureRect,TBool* aCanScaleOrCrop = NULL) const; sl@0: IMPORT_C TBool PictureRectangleL(const TPoint& aXyPos,TRect& aPictureRect,TBool* aCanScaleOrCrop = NULL) const; sl@0: IMPORT_C TInt FirstDocPosFullyInBand() const; sl@0: IMPORT_C void GetMinimumSizeL(TInt aWrapWidth,TSize& aSize); sl@0: IMPORT_C void GetMinimumSizeL(TInt aWrapWidth,TBool aAllowLegalLineBreaksOnly,TSize& aSize); sl@0: IMPORT_C TInt MajorVersion() const; sl@0: IMPORT_C TInt SetViewL(const TTmDocPos& aDocPos,TInt& aYPos,TViewYPosQualifier aYPosQualifier, sl@0: TDiscard aDiscardFormat = EFViewDontDiscardFormat); sl@0: IMPORT_C TInt SetViewL(TInt aDocPos,TInt& aYPos,TViewYPosQualifier aYPosQualifier, sl@0: TDiscard aDiscardFormat = EFViewDontDiscardFormat); sl@0: IMPORT_C void FormatBandL(); sl@0: IMPORT_C void FormatCharRangeL(TInt aStartDocPos,TInt aEndDocPos); sl@0: void FormatCharRangeL(TInt aStartDocPos,TInt aEndDocPos,TInt aPixelOffset); sl@0: IMPORT_C TBool FormatNextLineL(TInt& aBotPixel); sl@0: IMPORT_C TBool FormatLineL(CParaFormat* aParaFormat,TInt& aDocPos,TInt& aHeight,TBool& aPageBreak); sl@0: IMPORT_C TInt ScrollParagraphsL(TInt& aNumParas,TAllowDisallow aScrollBlankSpace); sl@0: IMPORT_C TInt ScrollLinesL(TInt& aNumLines,TAllowDisallow aScrollBlankSpace = EFDisallowScrollingBlankSpace); sl@0: IMPORT_C TInt ChangeBandTopL(TInt& aPixels,TAllowDisallow aScrollBlankSpace = EFDisallowScrollingBlankSpace); sl@0: IMPORT_C void ChangeBandTopNoLimitBorderL(TInt aPixels); sl@0: IMPORT_C void PageUpL(TInt& aYCursorPos,TInt& aPixelsScrolled); sl@0: IMPORT_C void PageDownL(TInt& aYCursorPos,TInt& aPixelsScrolled); sl@0: IMPORT_C TBool HandleCharEditL(TUint aType,TInt& aCursorPos,TInt& aGood,TInt& aFormattedUpTo, sl@0: TInt& aFormattedFrom,TInt& aScroll,TBool aFormatChanged); sl@0: IMPORT_C void HandleBlockChangeL(TCursorSelection aSelection,TInt aOldCharsChanged,TViewRectChanges& aViewChanges, sl@0: TBool aFormatChanged); sl@0: IMPORT_C void HandleAdditionalCharactersAtEndL(TInt& aFirstPixel,TInt& aLastPixel); sl@0: // deprecated 6.1 sl@0: IMPORT_C void ReformatVerticalSpaceL(); sl@0: IMPORT_C void AdjustVerticalAlignment(CParaFormat::TAlignment aVerticalAlignment); sl@0: IMPORT_C static void DrawBorders(const MGraphicsDeviceMap* aGd,CGraphicsContext& aGc,const TRect& aRect, sl@0: const TParaBorderArray& aBorder,const TRgb* aBackground = NULL, sl@0: TRegion* aClipRegion = NULL,const TRect* aDrawRect = NULL); sl@0: IMPORT_C void DrawL(const TRect& aDrawRect,const TDrawTextLayoutContext* aDrawTextLayoutContext, sl@0: const TCursorSelection* aHighlight = NULL); sl@0: IMPORT_C TBool GetNextVisualCursorPos(const TTmDocPosSpec& aDocPos, sl@0: TTmPosInfo2& aPosInfo, TBool aToLeft) const; sl@0: // deprecated 7.0 sl@0: IMPORT_C void InvertRangeL(const TCursorSelection& aHighlight,const TRect& aDrawRect, sl@0: const TDrawTextLayoutContext* aDrawTextLayoutContext); sl@0: IMPORT_C void Highlight(const TRangeChange& aHighlight,const TRect& aDrawRect, sl@0: const TDrawTextLayoutContext* aDrawTextLayoutContext); sl@0: IMPORT_C void SetCustomDraw(const MFormCustomDraw* aCustomDraw); sl@0: IMPORT_C const MFormCustomDraw* CustomDraw() const; sl@0: IMPORT_C void SetCustomWrap(const MFormCustomWrap* aCustomWrap); sl@0: IMPORT_C const MFormCustomWrap* CustomWrap() const; sl@0: /* this function should only used by Symbian internally */ sl@0: IMPORT_C void ExtendFormattingToCoverYL(TInt aYPos); sl@0: IMPORT_C void ExtendFormattingToCoverPosL(TInt aDocPos); sl@0: sl@0: IMPORT_C TInt GetLineNumber(TInt aDocPos); sl@0: IMPORT_C void SetHighlightExtensions(TInt aLeftExtension, TInt aRightExtension, TInt aTopExtension, TInt aBottomExtension); sl@0: void SetExcessHeightRequired(TInt aExcessHeightRequired); sl@0: IMPORT_C void SetInterfaceProvider( MFormCustomInterfaceProvider* aProvider ); sl@0: inline const CTmTextLayout& TagmaTextLayout() const; sl@0: inline void GetOrigin(TPoint& aPoint) const; sl@0: sl@0: sl@0: inline void RestrictScrollToTopsOfLines(TBool aRestrict); sl@0: sl@0: sl@0: // Non-exported public functions sl@0: void DrawBackground(CGraphicsContext& aGc,const TPoint& aTopLeft,const TRect& aClipRect, sl@0: const TLogicalRgb& aBackground) const; sl@0: TBool CalculateHorizontalExtremes(TInt& aLeftX,TInt& aRightX,TBool aOnlyVisibleLines) const; sl@0: TBool GetCursor(const TTmDocPos& aDocPos,TTmCursorPlacement aPlacement, sl@0: TRect& aLineRect,TPoint& aOrigin,TInt& aWidth,TInt& aAscent,TInt& aDescent) const; sl@0: void GetParagraphRect(const TTmDocPos& aDocPos,TRect& aRect) const; sl@0: TInt ScrollDocPosIntoViewL(const TTmDocPos& aDocPos); sl@0: TInt PictureRectangleAndPosL(const TPoint& aXyPos, TRect& aPictureRect, sl@0: TBool* aCanScaleOrCrop = 0) const; sl@0: void HighlightUsingExtensions(const CTextLayout::TRangeChange& aChangeHighlight,const TRangeChange& aFullHighlight, sl@0: const TRect& aDrawRect, const TDrawTextLayoutContext* aDrawTextLayoutContext); sl@0: inline const TTmHighlightExtensions& HighlightExtensions() const; sl@0: void GetHighlightRemnants(const TRect& aRect, const TDrawTextLayoutContext& aDrawTextLayoutContext, TRect* aRemainderRects) const; sl@0: TInt WrapWidth() const; sl@0: sl@0: void SetOpaqueLC(); sl@0: sl@0: IMPORT_C void SetCustomInvisibleCharacterRemapper(MFormCustomInvisibleCharacterRemapper* aInvisibleCharacterRemapper); sl@0: IMPORT_C MFormCustomInvisibleCharacterRemapper* GetCustomInvisibleCharacterRemapper(); sl@0: void SetTextViewCursorPos(TCursorPosition* aPos); // Put in for INC092568 sl@0: sl@0: void SetWindow(RWindow* aWnd); sl@0: void SetReadyToRedraw(); sl@0: void BeginRedraw(const TRect& aRect); sl@0: void EndRedraw(); sl@0: void SetExternalDraw(const TRect& aRect); sl@0: void ResetExternalDraw(); sl@0: TBool BeginRedrawCalled() const; sl@0: IMPORT_C void MakeVisible(TBool aVisible); sl@0: sl@0: #ifdef _DEBUG sl@0: TBool __DbgIsFormattingUpToDate() const; sl@0: #endif sl@0: sl@0: enum TPanicNumber sl@0: { sl@0: EUnimplemented, sl@0: ENoMemory, sl@0: EDrawingBorderError, sl@0: EFormatDeviceNotSet, sl@0: EImageDeviceNotSet, sl@0: EPixelNotInFormattedLine, sl@0: EInvalidDocPos, sl@0: ENoCharRangeToFormat, sl@0: ECharacterNotFormatted, sl@0: EPrintPreviewModeError, sl@0: EBadCharacterEditType, sl@0: EInvalidLineNumber, sl@0: EPosNotFormatted, sl@0: EMustFormatAllText, sl@0: EPageScrollError, sl@0: EInvalidRedraw sl@0: }; sl@0: static void Panic(TPanicNumber aNumber); sl@0: sl@0: private: sl@0: IMPORT_C CTextLayout(); sl@0: IMPORT_C void ConstructL(MLayDoc *aDoc,TInt aWrapWidth); sl@0: void InitFormatParam(TTmFormatParamBase& aParam); sl@0: TInt ScrollL(TInt aDy,TAllowDisallow aScrollBlankSpace,TBool aTopNoLimitBorder=EFalse,TBool aBottomNoLimitBorder=EFalse); sl@0: void FormatBandL(TInt aStartDocPos,TInt aEndDocPos); sl@0: void PruneFormatL(TBool aFromStart); sl@0: TInt VisibleHeightInPixels() const; sl@0: TInt BandHeightInPixels() const; sl@0: TInt SuggestCursorPos(TInt aCurrentCursorPos) const; sl@0: TInt SetBandTop(); sl@0: TBool AddFormattingAtEndL(TTmFormatParamBase& aFormatParam, TInt& aHeightIncrease, TInt& aParagraphsIncrease); sl@0: sl@0: static void ResetOpaque(void* aThis); sl@0: sl@0: sl@0: CTmTextLayout *iText; // the TAGMA object that contains the text layout sl@0: TInt iDummyForIText[10]; // It is only here to add padding for maintain compatibility sl@0: TInt iExcessHeightRequired; // The delta required to position the baseline so there is enough sl@0: // space for the highset glyph in pixels sl@0: RWindow *iWnd; // the window to be used to draw sl@0: TBool iBeginRedrawCount; sl@0: TRect iRedrawRect; sl@0: TCursorPosition* iTextViewCursorPos; // From and owned by owning CTextView if it exists, sl@0: // Null otherwise. Put in for INC092568 sl@0: TBool iIsWndInExternalRedraw; // If ETrue, then iWnd->EndRedraw() will not be called sl@0: // from within CTextLayout::EndRedraw() as the window redraw sl@0: // has been initiated externally and will be ended externally as well sl@0: TBool iReadyToRedraw; // If EFalse, disables CTextLayout::BeginRedraw() and sl@0: // CTextLayout::EndRedraw() sl@0: TInt iDummy[4]; // This dummy variable has been inserted to replace the original size of sl@0: // a variable that had to be moved to avaid a BC break because it had sl@0: // increased in size. Feel free to reuse this space - just reduce the size sl@0: // of this variable by the size of any variable you insert in front of it. sl@0: // Currently it occupies 5 words. sl@0: TInt iBandTop; // effectively, scroll position: subtract this from CTmTextLayout y position sl@0: // to give CTextLayout y position sl@0: TInt iVisibleHeight;// in pixels if iFormatMode is EFScreenMode or EFWysiwygMode, otherwise twips sl@0: TInt iBandHeight; // in pixels if iFormatMode is EFScreenMode or EFWysiwygMode, otherwise twips sl@0: sl@0: TInt iScrollFlags; // from CTextLayout::TScrollFlags sl@0: TInt iUnformattedStart; // document position of the start of any unformatted text; sl@0: // if < KMaxTInt, background formatting can be used sl@0: // (by calling FormatNextLine) to format the remainder sl@0: TBool iParInvalid; // if true and background formatting is happening, the remainder of the paragraph sl@0: // containing iUnformattedStart is invalid and must be reformatted; sl@0: // otherwise, formatting stops when line ends match sl@0: TTmHighlightExtensions *iHighlightExtensions; sl@0: TInt iDmmyForIHighlightExtensions[3]; // It is only here to add padding for maintain compatibility sl@0: TLayDocTextSource* iSource; // the source of the text sl@0: // before adding any new member variables to the end of this class, please sl@0: // consider whether you can insert them before the iDummy member variable sl@0: // further up, which currently represents wasted space. sl@0: TInt iDmmyForISource[23]; // It is only here to add padding for maintain compatibility sl@0: }; sl@0: sl@0: /** sl@0: Cursor position. sl@0: sl@0: The TMovementType enum defined in this class is used to indicate the direction sl@0: of a scroll or cursor movement. The remainder of this class does not form part sl@0: of the API. sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: class TCursorPosition sl@0: sl@0: { sl@0: public: sl@0: sl@0: sl@0: /** Direction of cursor movement. */ sl@0: enum TMovementType sl@0: { sl@0: /** No cursor movement */ sl@0: EFNoMovement, sl@0: /** Single character cursor movement to the left */ sl@0: EFLeft, sl@0: /** Single character cursor movement to the right */ sl@0: EFRight, sl@0: /** Line up cursor movement */ sl@0: EFLineUp, sl@0: /** Line down cursor movement */ sl@0: EFLineDown, sl@0: /** Page up cursor movement */ sl@0: EFPageUp, sl@0: /** Page down cursor movement */ sl@0: EFPageDown, sl@0: /** Cursor movement to line start */ sl@0: EFLineBeg, sl@0: /** Cursor movement to line end */ sl@0: EFLineEnd sl@0: }; sl@0: sl@0: /** Selection of the left end or right end of a run of text. */ sl@0: enum TVisualEnd sl@0: { sl@0: /** Leftmost end. */ sl@0: EVisualLeft, sl@0: /** Rightmost end. */ sl@0: EVisualRight sl@0: }; sl@0: sl@0: enum TPosHint sl@0: { sl@0: EPosHintUndefined = 0, sl@0: /** Left to right typing expected. */ sl@0: EInsertStrongL2R = 1, sl@0: /** Right to left typing expected. */ sl@0: EInsertStrongR2L = 2, sl@0: sl@0: // Maybe several more. sl@0: //... sl@0: EPosHintLast sl@0: }; sl@0: sl@0: inline TCursorPosition(); sl@0: inline void SetLayout(CTextLayout *aLayout); sl@0: inline void UpdateLatentX(TInt aX); sl@0: inline void SetToPreviousHighlight(); sl@0: inline void SetToCurrentHighlight(); sl@0: inline void CancelHighlight(); sl@0: inline void SetDocPos(const TTmDocPos& aDocPos); sl@0: void UpdateLatentPosition(); sl@0: TInt SetSelectionL(const TCursorSelection& aSelection); sl@0: void SetPendingSelection(const TCursorSelection& aSelection); sl@0: void GetOldSelection(TCursorSelection& aSelection) const; sl@0: void GetSelection(TCursorSelection& aSelection) const; sl@0: TInt SetDocPosL(TBool aDragSelectOn,const TTmDocPos& aDocPos); sl@0: TInt SetXyPosL(TBool aDragSelectOn,TPoint aPos,TBool aAllowPictureFrame); sl@0: TInt MoveL(TBool aDragSelectOn,TMovementType& aMovement,TBool aAllowPictureFrame); sl@0: const TTmDocPos& VisualEndOfRunL( sl@0: const TTmDocPos& aStart, const TTmDocPos& aEnd, sl@0: TVisualEnd aDirection); sl@0: void TextMoveVertically(); sl@0: inline void DontDrawOldPictureFrame(); sl@0: sl@0: // inquiry functions sl@0: inline TBool IsSelection() const; sl@0: inline TBool IsSelectionToDraw() const; sl@0: TBool IsPictureFrame() const; sl@0: TBool IsNewPictureFrame() const; sl@0: inline const TTmDocPos& TmDocPos() const; sl@0: inline TInt DocPos() const; sl@0: inline TBool DrawHighlight() const; sl@0: inline TBool DrawOldPictureFrame() const; sl@0: inline TBool DrawNewPictureFrame() const; sl@0: TBool GetCursor(TTmCursorPlacement aPlacement,TPoint& aOrigin,TInt& aWidth,TInt& aAscent,TInt& aDescent) const; sl@0: TPosHint PositioningHint() const { return iPositioningHint; } sl@0: void SetPositioningHint (TPosHint aHint) sl@0: {iPositioningHint = aHint;} sl@0: sl@0: TTmPosInfo2& ChoosePosition(TTmPosInfo2& aPreferred, sl@0: TTmPosInfo2& aBackup); sl@0: sl@0: private: sl@0: enum sl@0: { sl@0: EFAbove = -1, sl@0: EFInside = 0, sl@0: EFBelow = 1 sl@0: }; sl@0: sl@0: // bit values for iFlags sl@0: enum sl@0: { sl@0: EDrawHighlight = 1, sl@0: EDrawOldPictureFrame = 2, sl@0: EDrawNewPictureFrame = 4, sl@0: EReturnPreviousHighlight = 8, sl@0: ESelected = 16 sl@0: }; sl@0: sl@0: TInt ViewTopOfLineL(const TTmDocPos& aDocPos,TInt& aYPos); sl@0: void CheckSelection(TBool aSelect); sl@0: void CheckNullSelection(); sl@0: inline void UpdateLatentY(TInt aY); sl@0: TInt CheckCursorOnScreenL(TInt& aY); sl@0: TBool LeftRightL(TTmPosInfo2& aPos, TTmLineInfo& aLine, TMovementType& aMove); sl@0: void StartEnd(TTmPosInfo2& aPos, TTmLineInfo& aLine, TMovementType& aMove); sl@0: void UpDownL(TTmPosInfo2& aPos, TTmLineInfo& aLine, TMovementType& aMove); sl@0: TInt PageScrollL(TMovementType& aMove); sl@0: TInt DoSetDocPosL(const TTmDocPos& aDocPos); sl@0: TInt DoSetVisibleDocPosL(const TTmDocPos& aDocPos); sl@0: void DoSetXyPos(TPoint& aXy); sl@0: void SetPictureFrame(const TTmDocPos& aDocPos,TInt aAnchor,const TRect& aPictureRect); sl@0: inline TBool CalculateCursorPos(TPoint& aCurPos); sl@0: sl@0: TTmDocPos iDocPos; sl@0: TInt iAnchor; sl@0: TInt iOldDocPos; sl@0: TInt iOldAnchor; sl@0: TUint iFlags; sl@0: TInt iLatentX; sl@0: TInt iLatentY; sl@0: CTextLayout* iLayout; sl@0: TPosHint iPositioningHint; sl@0: }; sl@0: sl@0: // inline functions sl@0: inline const CTmTextLayout& CTextLayout::TagmaTextLayout() const sl@0: { sl@0: return *iText; sl@0: } sl@0: sl@0: inline void CTextLayout::GetOrigin(TPoint& aPoint) const sl@0: { sl@0: aPoint.iX = 0; sl@0: aPoint.iY = -iBandTop; sl@0: } sl@0: sl@0: inline CTextLayout::TTagmaForwarder::TTagmaForwarder(const CTextLayout& aLayout): sl@0: iLayout(aLayout) sl@0: { sl@0: } sl@0: sl@0: inline const CTmTextLayout& CTextLayout::TTagmaForwarder::TextLayout() const sl@0: { sl@0: return iLayout.TagmaTextLayout(); sl@0: } sl@0: sl@0: inline void CTextLayout::TTagmaForwarder::GetOrigin(TPoint& aPoint) const sl@0: { sl@0: iLayout.GetOrigin(aPoint); sl@0: } sl@0: sl@0: inline const TTmHighlightExtensions& CTextLayout::HighlightExtensions() const sl@0: { sl@0: return *iHighlightExtensions; sl@0: } sl@0: sl@0: /** sl@0: Dangerous function. Makes scroll operations set the top of the screen flush to sl@0: the top of a line. In general this might scroll the cursor off the screen. sl@0: */ sl@0: void CTextLayout::RestrictScrollToTopsOfLines(TBool a) sl@0: { sl@0: if (a) sl@0: iScrollFlags |= EFScrollOnlyToTopsOfLines; sl@0: else sl@0: iScrollFlags &= ~EFScrollOnlyToTopsOfLines; sl@0: } sl@0: sl@0: /**Constructs a fully initialized TViewYPosQualifier object. The hotspot is sl@0: initialized to be the baseline of the line, the screen is not filled, and the sl@0: top line is not forced to be fully visible. */ sl@0: inline TViewYPosQualifier::TViewYPosQualifier(): sl@0: iHotSpot(EFViewBaseLine), sl@0: iFillScreen(EFalse), sl@0: iFullyVisible(EFViewDontForceLineFullyVisible) sl@0: { sl@0: } sl@0: sl@0: sl@0: /**Constructs a TViewRectChanges object, initializing its iScrollAtTop and sl@0: iScrollAtBottom members to zero. */ sl@0: inline TViewRectChanges::TViewRectChanges(): sl@0: iScrollAtTop(0), sl@0: iScrollAtBottom(0) sl@0: { sl@0: } sl@0: sl@0: /**Constructs the TCursorSelection object initialising the cursor and anchor sl@0: positions to zero. */ sl@0: inline TCursorSelection::TCursorSelection(): sl@0: iCursorPos(0), sl@0: iAnchorPos(0) sl@0: { sl@0: } sl@0: sl@0: /** Constructs the TCursorSelection object with a cursor and anchor position. sl@0: @param aCursorPos The cursor position. sl@0: @param aAnchorPos The anchor position. */ sl@0: inline TCursorSelection::TCursorSelection(TInt aCursorPos,TInt aAnchorPos): sl@0: iCursorPos(aCursorPos), sl@0: iAnchorPos(aAnchorPos) sl@0: { sl@0: } sl@0: sl@0: /** Sets the cursor and anchor positions for the selection. sl@0: @param aCursorPos The new cursor position. sl@0: @param aAnchorPos The new anchor position. */ sl@0: inline void TCursorSelection::SetSelection(TInt aCursorPos,TInt aAnchorPos) sl@0: { sl@0: iCursorPos = aCursorPos; sl@0: iAnchorPos = aAnchorPos; sl@0: } sl@0: sl@0: /** Gets the lesser of the cursor and anchor positions. sl@0: @return The lesser of the cursor and anchor positions. */ sl@0: inline TInt TCursorSelection::LowerPos() const sl@0: { sl@0: return Min(iCursorPos,iAnchorPos); sl@0: } sl@0: sl@0: /** Gets the greater of the cursor and anchor positions. sl@0: @return The greater of the cursor and anchor positions. */ sl@0: inline TInt TCursorSelection::HigherPos() const sl@0: { sl@0: return Max(iCursorPos,iAnchorPos); sl@0: } sl@0: sl@0: /** Returns the number of characters in the selected range. sl@0: @return The length of the selection. */ sl@0: inline TInt TCursorSelection::Length() const sl@0: { sl@0: return Abs(iCursorPos - iAnchorPos); sl@0: } sl@0: sl@0: /** Constructs the TCursorPosition object, initializing its members sl@0: iAnchor, iOldDocPos, iOldAnchor, iFlags, iLatentX, iLatentY to sl@0: zero, iLayout to NULL, and iPositioningHint to undefined. sl@0: */ sl@0: inline TCursorPosition::TCursorPosition(): sl@0: iAnchor(0), sl@0: iOldDocPos(0), sl@0: iOldAnchor(0), sl@0: iFlags(0), sl@0: iLatentX(0), sl@0: iLatentY(0), sl@0: iLayout(NULL), sl@0: iPositioningHint(EPosHintUndefined) sl@0: { sl@0: } sl@0: sl@0: /** Sets the text layout which TCursorPosition is related. sl@0: @param aLayout The text layout. sl@0: */ sl@0: inline void TCursorPosition::SetLayout(CTextLayout *aLayout) sl@0: { sl@0: iLayout = aLayout; sl@0: } sl@0: sl@0: /** Tests whether there is currently a selected region. sl@0: @return True if there is a selected region. False if not. */ sl@0: inline TBool TCursorPosition::IsSelection() const sl@0: { sl@0: return iFlags & ESelected; sl@0: } sl@0: sl@0: /** Tests whether there is currently a highlighted region being drawn. sl@0: @return True if there is a selected region. False if not. */ sl@0: inline TBool TCursorPosition::IsSelectionToDraw() const sl@0: { sl@0: return iFlags & (EDrawHighlight | EDrawOldPictureFrame | EDrawNewPictureFrame); sl@0: } sl@0: sl@0: /** Sets the flag which directs GetSelection() and sl@0: IsPictureFrame() to operate on the previous highlight sl@0: instead of the current highlight. sl@0: */ sl@0: inline void TCursorPosition::SetToPreviousHighlight() sl@0: { sl@0: iFlags |= EReturnPreviousHighlight; sl@0: } sl@0: sl@0: /** Clears the special flag set in SetToPreviousHighlight() sl@0: so that GetSelection() and IsPictureFrame() sl@0: will operate on the current highlight. sl@0: */ sl@0: inline void TCursorPosition::SetToCurrentHighlight() sl@0: { sl@0: iFlags &= ~EReturnPreviousHighlight; sl@0: } sl@0: sl@0: /** Removes the selection, and redraws the affected part of the screen. sl@0: */ sl@0: inline void TCursorPosition::CancelHighlight() sl@0: { sl@0: iFlags &= ~(ESelected | EDrawHighlight | EDrawOldPictureFrame | EDrawNewPictureFrame); sl@0: } sl@0: sl@0: /** Sets the latent horizontal text cursor position. This is the horizontal sl@0: coordinate to which the text cursor will be moved. sl@0: @param aX The horizontal coordinate to which the text cursor should be moved sl@0: */ sl@0: inline void TCursorPosition::UpdateLatentX(TInt aX) sl@0: { sl@0: iLatentX = aX; sl@0: } sl@0: sl@0: /** Sets the latent vertical text cursor position. This is the vertical sl@0: coordinate to which the text cursor will be moved. sl@0: @param aY The vertical coordinate to which the text cursor should be moved sl@0: */ sl@0: inline void TCursorPosition::UpdateLatentY(TInt aY) sl@0: { sl@0: iLatentY = aY; sl@0: } sl@0: sl@0: /** Caculate x-y position of the cursor sl@0: If ETrue is returned, places the position of the intersection of sl@0: the character edge with the baseline in aPos sl@0: @param aPos On return, stores the position of the intersection of sl@0: the character edge with the baseline sl@0: @return ETrue if the document is in the formatted text, otherwise EFalse. sl@0: */ sl@0: inline TBool TCursorPosition::CalculateCursorPos(TPoint& aPos) sl@0: { sl@0: TTmPosInfo2 pos_info; sl@0: TBool result = iLayout->FindDocPos(iDocPos,pos_info); sl@0: aPos = pos_info.iEdge; sl@0: return result; sl@0: } sl@0: sl@0: /** Gets the document position, the structure for holding a raw document sl@0: position that can be converted to or from an x-y position and compared sl@0: ordinally, which cannot be done with the more abstract TTmDocPosSpec class. sl@0: @return the document position sl@0: */ sl@0: inline const TTmDocPos& TCursorPosition::TmDocPos() const sl@0: { sl@0: return iDocPos; sl@0: } sl@0: /** Gets the edge position in the document. sl@0: @return the edge position in the document. sl@0: */ sl@0: inline TInt TCursorPosition::DocPos() const sl@0: { sl@0: return iDocPos.iPos; sl@0: } sl@0: sl@0: /** Sets the document position, the structure for holding a raw document sl@0: position that can be converted to or from an x-y position and compared sl@0: ordinally, which cannot be done with the more abstract TTmDocPosSpec class. sl@0: @param aDocPos the document position sl@0: */ sl@0: inline void TCursorPosition::SetDocPos(const TTmDocPos& aDocPos) sl@0: { sl@0: iDocPos = aDocPos; sl@0: } sl@0: sl@0: /** Tests whether the highlighted region needs to be drawn. sl@0: The function will be called by CTextView::UpdateHighlightL() sl@0: to correct the highlight after a cursor movement sl@0: @return True if the highlighted region needs to be drawn. False if not. */ sl@0: inline TBool TCursorPosition::DrawHighlight() const sl@0: { sl@0: return iFlags & EDrawHighlight; sl@0: } sl@0: sl@0: /** Tests whether there is a previous picture frame that needs to be drawn. sl@0: The function will be called by CTextView::UpdateHighlightL() sl@0: to correct the highlight after a cursor movement sl@0: @return True if there is a previous picture frame that needs to be drawn. False if not. */ sl@0: inline TBool TCursorPosition::DrawOldPictureFrame() const sl@0: { sl@0: return iFlags & EDrawOldPictureFrame; sl@0: } sl@0: sl@0: /** Tests whether there is a new picture frame that needs to be drawn. sl@0: The function will be called by CTextView::UpdateHighlightL() sl@0: to correct the highlight after a cursor movement sl@0: @return True if there is a new picture frame that needs to be drawn. False if not. */ sl@0: inline TBool TCursorPosition::DrawNewPictureFrame() const sl@0: { sl@0: return iFlags & EDrawNewPictureFrame; sl@0: } sl@0: sl@0: /** Sets to not draw the previous picture frame sl@0: */ sl@0: inline void TCursorPosition::DontDrawOldPictureFrame() sl@0: { sl@0: iFlags &= ~EDrawOldPictureFrame; sl@0: } sl@0: sl@0: #endif