1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/textformatting/inc/FRMTVIEW.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,681 @@
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 __FRMTVIEW_H__
1.23 +#define __FRMTVIEW_H__
1.24 +
1.25 +#include <e32std.h>
1.26 +#include <e32base.h>
1.27 +#include <w32std.h>
1.28 +#include <frmtlay.h>
1.29 +#include <frmframe.h>
1.30 +
1.31 +/**
1.32 +Internal class - not part of interface
1.33 +@internalComponent
1.34 +*/
1.35 +class RScreenDisplay
1.36 +
1.37 + {
1.38 +public:
1.39 + enum TClippingRects
1.40 + {
1.41 + EFClipTextArea = 0x0001,
1.42 + EFClipLineCursor = 0x0002,
1.43 + EFClipExtendedTextArea = 0x0004,
1.44 + EFClipViewRect = 0x0008,
1.45 + EFClipExtendedViewRect = 0x0010,
1.46 + EFClipInvalid = 0x0200,
1.47 + EFClipAllFlags = 0xFFFF
1.48 + };
1.49 +public:
1.50 + RScreenDisplay(TDrawTextLayoutContext* const aDrawTextLayoutContext);
1.51 + void Close();
1.52 + void Destroy();
1.53 + void SetWindowsServer(RWsSession *aSession) { iSession = aSession; }
1.54 + void SetWindowGroup(RWindowGroup *aWin) { iGroupWin = aWin; }
1.55 +
1.56 + void SetWindow(RWindow *aWin);
1.57 + RWindow* Window() const { return iWin; }
1.58 + void SetBitmapContext(CBitmapContext* aGc) { iGc = aGc; }
1.59 + CBitmapContext* BitmapContext() const { return iGc; }
1.60 + RWsSession* WindowServerSession() { return iSession; }
1.61 + void SetGraphicsDeviceL(CBitmapDevice *aGd);
1.62 + CBitmapDevice* BitmapDevice() const {return iGd; }
1.63 + void CreateContextL(CBitmapDevice *aGd);
1.64 + void CreateContextL();
1.65 + void SetInvalidRect(const TRect& aRect);
1.66 + void SetInvalidRect(TInt aHeight);
1.67 + void SetInvalidRectHorizontal(TInt aWidth);
1.68 + void SetRects(TUint aRects);
1.69 + TRect LineCursorMargin() const;
1.70 + TPoint TopLeftTextArea() const;
1.71 + TBool IsLineCursor() const;
1.72 +
1.73 + void AddRects(TUint aRects);
1.74 + void SubRects(TUint aRects);
1.75 + TRect ClippingRect();
1.76 + void ResetClippingRect();
1.77 + void Scroll(TRect aRect,const TPoint& aBy,TBool aScrollBackground);
1.78 + void Flush();
1.79 + void ClearRect(const TRect& aRect);
1.80 + void InvertRect(TRect aRect,const TRgb aInvertColor);
1.81 + void SetTextCursor(TPoint aPos, const TTextCursor &aCursor);
1.82 + void RemoveTextCursor();
1.83 + void BlastBitmap(const TPoint& aPoint,const CFbsBitmap* aBitmap,const TRect& aRect);
1.84 + void DrawPictureFrame(TFrameOverlay* aPictureFrame,const TRect& aLineRect);
1.85 + void Invalidate(TRect aRect);
1.86 + void ActivateContext();
1.87 + void ActivateContext(CGraphicsContext *aGc);
1.88 + void DeactivateContext();
1.89 + void DeactivateContext(CGraphicsContext *aGc);
1.90 + void SetLayout(CTextLayout* aLayout);
1.91 + CTextLayout* Layout();
1.92 + TBool UseWindowGc() const;
1.93 +
1.94 +private:
1.95 + void DestroyContexts();
1.96 +private:
1.97 + RWsSession *iSession;
1.98 + RWindowGroup *iGroupWin;
1.99 + RWindow *iWin;
1.100 + CBitmapContext *iGc;
1.101 + CBitmapDevice *iGd;
1.102 + TDrawTextLayoutContext* const iDrawTextLayoutContext;
1.103 + TUint iRects;
1.104 + TRect iInvalidRect;
1.105 + TLogicalRgb iBackground;
1.106 + CTextLayout* iTextLayout;
1.107 + };
1.108 +
1.109 +/** Visibility of line and text cursor.
1.110 +
1.111 +The TVisibility enumeration defined in this class is used in calls to CTextView::SetCursorVisibilityL().
1.112 +The remainder of this class does not form part of the API.
1.113 +@internalComponent
1.114 +*/
1.115 +class TCursor
1.116 + {
1.117 + public:
1.118 + enum TCursors
1.119 + {
1.120 + EFNeitherCursor = 0,
1.121 + EFTextCursor = 1,
1.122 + EFLineCursor = 2,
1.123 + EFBothCursors = EFTextCursor | EFLineCursor
1.124 + };
1.125 +
1.126 + /** Cursor visibility */
1.127 + enum TVisibility
1.128 + {
1.129 + /** Indicates that the cursor should be invisible. */
1.130 + EFCursorInvisible = 0,
1.131 + /** Indicates that the cursor should be visible. */
1.132 + EFCursorVisible,
1.133 + /** Indicates a flashing text cursor. When specified for the line
1.134 + cursor, is equivalent to EFCursorVisible, as the line cursor cannot
1.135 + flash. Note that a non-flashing text cursor should only be used when
1.136 + there is to be no editing, reformatting, scrolling or cursor movement.
1.137 + */
1.138 + EFCursorFlashing
1.139 + };
1.140 +
1.141 + TCursor(TCursorPosition& aCursorPos,RScreenDisplay& aDisplay);
1.142 + void SetLineCursorBitmap(const CFbsBitmap* aLineCursorBitmap);
1.143 + inline TUint LineCursorVisibility();
1.144 + inline TUint TextCursorVisibility();
1.145 + void Draw(TUint aCursors);
1.146 +
1.147 + void SetVisibility(TVisibility aLineCursor,TVisibility aTextCursor);
1.148 + void SetType(TTextCursor::EType aType);
1.149 + void SetPlacement(TTmCursorPlacement aPlacement);
1.150 + void SetAscentAndDescent(TInt aAscent,TInt aDescent);
1.151 + void SetWeight(TInt aWeight);
1.152 + void SetFlash(TBool aEnabled);
1.153 + void SetXorColor(TRgb aColor);
1.154 + void MatchCursorHeightToAdjacentChar();
1.155 + void SetExtensions(TInt aFirstExtension, TInt aSecondExtension);
1.156 + private:
1.157 + enum
1.158 + {
1.159 + ELineCursorToLabelGap = 2,
1.160 + ETextCursorWeight = 3,
1.161 + ETextCursorInvertColor = 0xFFFFFF
1.162 + };
1.163 +
1.164 + void DrawLineCursor(TInt aHeight);
1.165 + void RemoveLineCursor();
1.166 + void DrawTextCursor(TPoint aOrigin,TInt aWidth,TInt aAscent,TInt aDescent);
1.167 + void RemoveTextCursor();
1.168 +
1.169 + RScreenDisplay& iDisplay; // a reference to the object controlling drawing
1.170 + TCursorPosition& iCursorPos; // a reference to the object holding the cursor's document position
1.171 + TBool iVisible; // TRUE if the text cursor is currently visible in the displayed text
1.172 + TBool iFlash; // TRUE if the text cursor should flash
1.173 + TVisibility iLineCursor; // line cursor state
1.174 + TVisibility iTextCursor; // text cursor state
1.175 + const CFbsBitmap* iLineCursorBitmap; // if non-null, points to a non-owned bitmap representing the line cursor
1.176 + TInt iAscent; // if non-negative, ascent used for vertical cursors
1.177 + TInt iDescent; // if non-negative, descent used for vertical cursors
1.178 + TInt iWeight; // width of vertical cursors, height of horizontal ones
1.179 + TTextCursor::EType iType; // filled or hollow rectangle, etc.
1.180 + TRgb iXorColor; // colour XORed with the background when the cursor is drawn
1.181 + TTmCursorPlacement iPlacement; // vertical, underline, etc.
1.182 + TInt iFirstExtension; // customise the cursor, extends vertical cursors upwards, horizontal cursors leftwards
1.183 + TInt iSecondExtension; // customise the cursor, extends vertical cursors downwards, horizontal cursors rightwards
1.184 + TInt iReserved[2];
1.185 + };
1.186 +
1.187 +/**
1.188 +Lays out formatted text for display.
1.189 +
1.190 +The class provides functions to:
1.191 +
1.192 +convert between document positions and x,y coordinates
1.193 +
1.194 +set the dimensions of the rectangle in which text can be viewed (the view
1.195 +rectangle)
1.196 +
1.197 +set margin widths
1.198 +
1.199 +do horizontal and vertical scrolling
1.200 +
1.201 +do text selection
1.202 +
1.203 +set the cursor position and appearance
1.204 +
1.205 +After a change has been made to the text layout, a reformat and redraw should
1.206 +normally take place. CTextView provides functions which are optimised to reformat
1.207 +the minimum amount necessary. For example, when a global formatting parameter
1.208 +is changed (e.g. the wrap width), the whole document's layout needs to be
1.209 +recalculated, so HandleGlobalChangeL() should be called. If the change involves
1.210 +the insertion or deletion of a single character, only a single line may be
1.211 +affected; for this, HandleCharEditL() is appropriate. Most CTextView reformatting
1.212 +functions do scrolling (using block transfer), if necessary, and a redraw.
1.213 +
1.214 +For maximum responsiveness, CTextView uses an active object to carry out
1.215 +reformatting as a background task, so that the application can continue to
1.216 +receive user input. Many CTextView functions force background formatting to
1.217 +complete before they take effect.
1.218 +
1.219 +When scrolling vertically, positive numbers of pixels, lines, paragraphs,
1.220 +pages, etc., mean that the text moves down, and vice versa. When scrolling
1.221 +horizontally, positive numbers of pixels mean that the text moves left and
1.222 +vice versa.
1.223 +
1.224 +A text view can display up to two cursors and up to three margins. The cursors
1.225 +are the text cursor and the line cursor. The purpose of the line cursor is
1.226 +to make it easier to see which line the text cursor (or the selection extension
1.227 +point) is on. The three margins are the label margin (for paragraph labels),
1.228 +the line cursor margin (for the line cursor) and the left text margin (the
1.229 +gap between the edge of the page and the text). All are optional, but if present,
1.230 +they appear in that order, starting at the left edge of the view rectangle.
1.231 +
1.232 +An object of class CTextLayout is used by the text view to calculate changes
1.233 +to the layout. This object must be specified when constructing the text view.
1.234 +It is also used to set layout attributes, including the wrap width, the height
1.235 +of the visible portion of the document (the "band"), whether formatting is
1.236 +set to the band or to the whole document and the text object which is the
1.237 +source of the text and formatting information.
1.238 +
1.239 +The x-y pixel coordinates used by CTextView are called window coordinates.
1.240 +Window coordinates have their origin at the top left corner of the view window
1.241 +(unlike class CTextLayout whose coordinates have their origin at the top left
1.242 +corner of the area within the view rectangle in which text can appear). As
1.243 +in most bitmap graphics systems, x coordinates increase rightwards and y coordinates
1.244 +increase downwards.
1.245 +@publishedAll
1.246 +@released
1.247 +*/
1.248 +class CTextView : public CBase
1.249 +
1.250 + {
1.251 +friend class CTestTextView;
1.252 +public:
1.253 + enum TPriorities
1.254 + {
1.255 + EFBackgroundFormattingPriority = (CActive::EPriorityIdle + CActive::EPriorityLow) / 2
1.256 + };
1.257 +
1.258 + /** deprecated 8.0 */
1.259 + enum
1.260 + {
1.261 + EFFirstCharOnLine = -1000000,
1.262 + EFLastCharOnLine = 1000000
1.263 + };
1.264 +
1.265 + /** Cursor height matching.
1.266 +
1.267 + Passed as an argument to MatchCursorHeightToAdjacentChar(). */
1.268 + enum TBeforeAfter
1.269 + {
1.270 + /** Text cursor height is matched to preceding character. */
1.271 + EFCharacterBefore = ETrue,
1.272 + /** Text cursor height is matched to following character. */
1.273 + EFCharacterAfter = EFalse
1.274 + };
1.275 +
1.276 +
1.277 +
1.278 + /** Whether to reformat and redraw. Argument to SetViewL(). */
1.279 + enum TDiscard
1.280 + {
1.281 + /** Discard all formatting; redraw. */
1.282 + EFViewDiscardAllFormat,
1.283 + /** Do not discard all formatting; redraw. */
1.284 + EFViewDontDiscardFormat,
1.285 + /** Discard all formatting; no redraw. */
1.286 + EFViewDiscardAllNoRedraw,
1.287 + /** Do not discard all formatting; redraw. */
1.288 + EFViewDontDiscardFullRedraw
1.289 + };
1.290 +
1.291 + /**
1.292 + Provides notification to the owner of the text view object of changes to the
1.293 + formatting.
1.294 +
1.295 + Its OnReformatL() function is called after reformatting but before redisplay,
1.296 + so that edit windows etc. can be resized.
1.297 + @publishedAll
1.298 + @released
1.299 + */
1.300 + class MObserver
1.301 +
1.302 + {
1.303 + public:
1.304 +
1.305 + /** Called after reformatting but before redisplay, so that the height of edit windows, etc.,
1.306 + can be adjusted. There is no need to adjust the width of displaying components as formatting
1.307 + is always done to fit the specified width.
1.308 + Implementers are not allowed to call any formatting functions while handling reformatting
1.309 + notifications as it may cause recursive loops leading to unexpected consequences.
1.310 + @param aTextView A pointer to the current text view object. */
1.311 + virtual void OnReformatL(const CTextView* aTextView) = 0;
1.312 + };
1.313 +
1.314 + // argument to SetViewL
1.315 + enum TDoHorizontalScroll
1.316 + {
1.317 + EFNoHorizontalScroll = EFalse,
1.318 + EFCheckForHorizontalScroll = ETrue
1.319 + };
1.320 +
1.321 +
1.322 + /**
1.323 + A standard inquiry interface for the text formatting engine, built on
1.324 + top of a CTextView object.
1.325 +
1.326 + To use it, construct a TTagmaForwarder object, then call InitL(), which
1.327 + finishes background formatting, then call the MTmTextLayoutForwarder
1.328 + functions.
1.329 +
1.330 + The class should only be used internally by FORM component.
1.331 + @publishedAll
1.332 + @released
1.333 + */
1.334 + class TTagmaForwarder: public MTmTextLayoutForwarder
1.335 +
1.336 + {
1.337 + public:
1.338 + inline TTagmaForwarder();
1.339 + inline void InitL(CTextView* aView);
1.340 +
1.341 + private:
1.342 + // from MTmTextLayoutForwarder
1.343 + inline const CTmTextLayout& TextLayout() const;
1.344 + inline void GetOrigin(TPoint& aPoint) const;
1.345 +
1.346 + CTextView* iView;
1.347 + };
1.348 +
1.349 +private:
1.350 + enum TDrawParameters
1.351 + {
1.352 + EFDrawAllWindow = CLayoutData::EFLargeNumber // must be larger than the pixel height of any window.
1.353 + };
1.354 +
1.355 + // bit values used in iFlags
1.356 + enum
1.357 + {
1.358 + EFSelectionVisible = 1,
1.359 + EFPictureFrameEnabled = 2,
1.360 + EFEverythingVisible = 3,
1.361 + EFFlickerFreeRedraw = 4,
1.362 + EFTextVisible = 8
1.363 + };
1.364 +
1.365 + // horizontal scroll jump in pixels
1.366 + enum THorizontalScrollJump
1.367 + {
1.368 + EFDefaultHorizontalScrollJump = 20
1.369 +#ifdef _DEBUG
1.370 + ,EFUnreasonablyLargeHorizontalScrollJump = 10000
1.371 +#endif
1.372 + };
1.373 +
1.374 + // picture frame blob widths in pixels
1.375 + enum TPictureFrameBlobWidths
1.376 + {
1.377 + EFFrameVisibleBlobWidth = 10,
1.378 + EFFrameActiveBlobWidth = 20
1.379 + };
1.380 +
1.381 + enum THorizontalScroll
1.382 + {
1.383 + EFNoPreviousHorizontalScroll = 0,
1.384 + EFPreviousHorizontalScroll
1.385 + };
1.386 +
1.387 + enum TMemoryStatus
1.388 + {
1.389 + EFMemoryOK,
1.390 + EFOutOfMemory,
1.391 + EFRecovering
1.392 + };
1.393 +
1.394 + enum TExtendedHighlightRedraw
1.395 + {
1.396 + EFTopEdge = 0x0001,
1.397 + EFBottomEdge = 0x0002
1.398 + };
1.399 +
1.400 +
1.401 +public:
1.402 + IMPORT_C static CTextView *NewL(CTextLayout* aLayout,const TRect &aDisplay,CBitmapDevice* aGd,
1.403 + MGraphicsDeviceMap* aDeviceMap,RWindow* aWin,RWindowGroup* aGroupWin,
1.404 + RWsSession* aSession);
1.405 + IMPORT_C ~CTextView();
1.406 + IMPORT_C void SetDisplayContextL(CBitmapDevice* aGd,RWindow* aWin,RWindowGroup* aGroupWin,RWsSession* aSession);
1.407 + IMPORT_C void SetLayout(CTextLayout* aLayout);
1.408 + inline const CTextLayout* Layout() const;
1.409 + IMPORT_C void SetViewRect(const TRect& aDisplay);
1.410 + IMPORT_C void AlterViewRect(const TRect &aViewRect);
1.411 + IMPORT_C void SetMarginWidths(TInt aLabels,TInt aLineCursor);
1.412 + IMPORT_C void SetHorizontalScrollJump(TInt aScrollJump);
1.413 + IMPORT_C void SetLineCursorBitmap(const CFbsBitmap* aLineCursorBitmap);
1.414 + IMPORT_C void SetHighlightExtensions(TInt aLeftExtension, TInt aRightExtension, TInt aTopExtension, TInt aBottomExtension);
1.415 + IMPORT_C void SetExcessHeightRequired(TInt aExcessHeightRequired);
1.416 + IMPORT_C void SetBackgroundColor(TRgb aColor);
1.417 + IMPORT_C void SetTextColorOverride(const TRgb* aOverrideColor = NULL);
1.418 + IMPORT_C void SetCursorVisibilityL(TUint aLineCursor,TUint aTextCursor);
1.419 + IMPORT_C void SetSelectionVisibilityL(TBool aSelectionVisible);
1.420 + IMPORT_C TBool SelectionVisible() const;
1.421 + IMPORT_C void EnablePictureFrameL(TBool aEnabled);
1.422 + IMPORT_C const TRect& ViewRect() const;
1.423 + IMPORT_C const TRect& AlteredViewRect() const;
1.424 + IMPORT_C void MarginWidths(TInt& aLabels,TInt& aLineCursor) const;
1.425 + IMPORT_C TInt HorizontalScrollJump() const;
1.426 + IMPORT_C TInt LeftTextMargin() const;
1.427 + IMPORT_C void SetLatentXPosition(TInt aLatentX);
1.428 + // deprecated 7.0
1.429 + IMPORT_C void SetParagraphFillTextOnly(TBool aFillTextOnly);
1.430 + IMPORT_C void SetCursorWidthTypeL(TTextCursor::EType aType,TInt aWidth = 0);
1.431 + IMPORT_C void SetCursorPlacement(TTmCursorPlacement aPlacement);
1.432 + IMPORT_C void SetCursorWeight(TInt aWeight);
1.433 + IMPORT_C void SetCursorFlash(TBool aEnabled);
1.434 + IMPORT_C void SetCursorXorColor(TRgb aColor);
1.435 + IMPORT_C void SetCursorExtensions(TInt aFirstExtension, TInt aSecondExtension);
1.436 + IMPORT_C TCursorSelection Selection() const;
1.437 + IMPORT_C TBool IsPictureFrameSelected(TRect& aPictureFrameRect,TInt& aDocPos) const;
1.438 + IMPORT_C TBool GetPictureRectangleL(TInt aDocPos,TRect& aPictureRect,TBool* aCanScaleOrCrop = NULL) const;
1.439 + IMPORT_C TBool GetPictureRectangleL(TPoint aXyPos,TRect& aPictureRect,TBool* aCanScaleOrCrop = NULL);
1.440 + IMPORT_C TBool FindXyPosL(const TPoint& aXyPos,TTmPosInfo2& aPosInfo,TTmLineInfo* aLineInfo = NULL);
1.441 + IMPORT_C TInt XyPosToDocPosL(TPoint& aPoint);
1.442 + IMPORT_C TBool FindDocPosL(const TTmDocPosSpec& aDocPos,TTmPosInfo2& aPosInfo,TTmLineInfo* aLineInfo = NULL);
1.443 + IMPORT_C TBool DocPosToXyPosL(TInt aDocPos,TPoint& aPoint);
1.444 + IMPORT_C TRect ParagraphRectL(TInt aDocPos) const;
1.445 + IMPORT_C void CalculateHorizontalExtremesL(TInt& aLeftX,TInt& aRightX,TBool aOnlyVisibleLines);
1.446 + IMPORT_C void MatchCursorHeightL(const TFontSpec& aFontSpec);
1.447 + IMPORT_C void MatchCursorHeightToAdjacentChar(TBeforeAfter aBasedOn = EFCharacterBefore);
1.448 + IMPORT_C TPoint SetSelectionL(const TCursorSelection& aSelection);
1.449 + IMPORT_C void CancelSelectionL();
1.450 + IMPORT_C void ClearSelectionL();
1.451 + IMPORT_C TPoint SetDocPosL(const TTmDocPosSpec& aDocPos,TBool aDragSelectOn = EFalse);
1.452 + IMPORT_C TPoint SetDocPosL(TInt aDocPos,TBool aDragSelectOn = EFalse);
1.453 + IMPORT_C TPoint SetXyPosL(TPoint aPos,TBool aDragSelectOn,TRect*& aPictureRect,TInt& aPictureFrameEdges);
1.454 + IMPORT_C TPoint MoveCursorL(TCursorPosition::TMovementType& aMovement,TBool aDragSelectOn);
1.455 + IMPORT_C TInt ScrollDisplayL(TCursorPosition::TMovementType aMovement,
1.456 + CTextLayout::TAllowDisallow aScrollBlankSpace=CTextLayout::EFDisallowScrollingBlankSpace);
1.457 + IMPORT_C TPoint SetViewLineAtTopL(TInt aLineNo);
1.458 + IMPORT_C void ScrollDisplayPixelsL(TInt& aDeltaY);
1.459 + IMPORT_C void ScrollDisplayPixelsNoLimitBorderL(TInt aDeltaY);
1.460 + IMPORT_C TInt ScrollDisplayLinesL(TInt& aDeltaLines,
1.461 + CTextLayout::TAllowDisallow aScrollBlankSpace = CTextLayout::EFDisallowScrollingBlankSpace);
1.462 + IMPORT_C TInt ScrollDisplayParagraphsL(TInt& aDeltaParas,
1.463 + CTextLayout::TAllowDisallow aScrollBlankSpace = CTextLayout::EFDisallowScrollingBlankSpace);
1.464 + IMPORT_C TPoint SetViewL(TInt aDocPos,TInt& aYPos,TViewYPosQualifier aYPosQualifier = TViewYPosQualifier(),
1.465 + TDiscard aDiscardFormat = EFViewDontDiscardFormat,
1.466 + TDoHorizontalScroll aDoHorizontalScroll = EFCheckForHorizontalScroll);
1.467 + IMPORT_C void SetLeftTextMargin(TInt aLeftMargin);
1.468 + IMPORT_C void DrawL(TRect aRect);
1.469 + IMPORT_C void DrawL(TRect aRect,CBitmapContext& aGc);
1.470 + inline void SetObserver(MObserver* aObserver);
1.471 + IMPORT_C void SetPendingSelection(const TCursorSelection& aSelection);
1.472 + inline void EnableFlickerFreeRedraw();
1.473 + inline void DisableFlickerFreeRedraw();
1.474 + inline TBool FlickerFreeRedraw() const;
1.475 + inline void GetOrigin(TPoint& aPoint) const;
1.476 + IMPORT_C TCursorSelection GetForwardDeletePositionL();
1.477 + IMPORT_C TCursorSelection GetBackwardDeletePositionL();
1.478 +
1.479 + // reformatting after changes to the content
1.480 + IMPORT_C void FormatTextL();
1.481 + IMPORT_C TInt HandleCharEditL(TUint aType = CTextLayout::EFCharacterInsert,TBool aFormatChanged = EFalse);
1.482 + IMPORT_C TPoint HandleRangeFormatChangeL(TCursorSelection aSelection,TBool aFormatChanged = EFalse);
1.483 + IMPORT_C TPoint HandleInsertDeleteL(TCursorSelection aSelection,TInt aDeletedChars,TBool aFormatChanged = EFalse);
1.484 + IMPORT_C void HandleGlobalChangeL(TViewYPosQualifier aYPosQualifier = TViewYPosQualifier());
1.485 + IMPORT_C void HandleGlobalChangeNoRedrawL(TViewYPosQualifier aYPosQualifier = TViewYPosQualifier());
1.486 + IMPORT_C void HandleAdditionalCharactersAtEndL();
1.487 + IMPORT_C void FinishBackgroundFormattingL();
1.488 +
1.489 + IMPORT_C CBitmapContext* BitmapContext();
1.490 + IMPORT_C const TTmDocPos& VisualEndOfRunL(
1.491 + const TTmDocPos& aStart, const TTmDocPos& aEnd,
1.492 + TCursorPosition::TVisualEnd aDirection);
1.493 + IMPORT_C void GetCursorPos(TTmDocPos& aPos) const;
1.494 +
1.495 + IMPORT_C TPoint SetDocPosL(const TTmDocPos& aDocPos,TBool aDragSelectOn = EFalse);
1.496 +
1.497 + IMPORT_C void SetCursorPositioningHintL(TCursorPosition::TPosHint aHint);
1.498 +
1.499 + IMPORT_C void SetOpaque(TBool aDrawOpaque);
1.500 + IMPORT_C void MakeVisible(TBool aVisible);
1.501 +
1.502 +private:
1.503 + IMPORT_C static TInt IdleL(TAny *aSelf);
1.504 + IMPORT_C CTextView();
1.505 + IMPORT_C void ConstructL(CTextLayout* aLayout,const TRect &aDisplay,CBitmapDevice* aGd,MGraphicsDeviceMap* aDeviceMap,
1.506 + RWindow* aWin,RWindowGroup* aGroupWin,RWsSession* aSession);
1.507 + inline TInt TopViewRect() const;
1.508 + inline TBool IsFormatting() const;
1.509 + TBool NoMemoryCheckL();
1.510 + void StartIdleObject();
1.511 + inline void DrawWithPreviousHighlight();
1.512 + inline void DrawWithCurrentHighlight();
1.513 + TInt CalculateBaseLinePos(TTmDocPos& aDocPos);
1.514 + TInt DrawAfterCursorMoveL(TInt aVerticalScrollBy);
1.515 + TBool NextLineL();
1.516 + void ClearRectAtBottom(TInt aHeight);
1.517 + void DrawTextL(TInt aFromHeight = 0,TInt aToHeight = EFDrawAllWindow);
1.518 + void DisplayNewLinesL(TInt aFrom,TInt aTo);
1.519 + void DrawCursor(TUint aCursors = TCursor::EFBothCursors);
1.520 + TPoint DoMoveCursorL(TBool aDragSelectOn,TCursorPosition::TMovementType& aMovement,TBool aAllowPictureFrame);
1.521 + void ScrollTextL(TInt aScrollY,TInt aFrom,TInt aScrollX,TBool aScrollBackground);
1.522 + void ScrollRect(TRect& aRect,TInt aScrollY,TInt aFrom,TInt aScrollX,TBool aScrollBackground);
1.523 + void ScrollRect(TInt aScrollY,TInt& aFrom,TInt& aTo);
1.524 + TPoint HandleBlockChangeL(TCursorSelection aSelection,TInt aOldCharsChanged,TBool aFormatChanged);
1.525 + void CheckScrollUpL();
1.526 + TInt CheckHorizontalScroll(const TTmDocPos& aDocPos);
1.527 + TInt DoHorizontalScrollDisplayL(TCursorPosition::TMovementType aMovement,
1.528 + CTextLayout::TAllowDisallow aScrollBlankSpace);
1.529 + TInt DoScrollDisplayL(TCursorPosition::TMovementType aMovement,CTextLayout::TAllowDisallow aScrollBlankSpace);
1.530 + void ScrollDisplayL();
1.531 + TPoint ViewTopOfLineL(const TTmDocPos& aDocPos,TInt& aYPos,
1.532 + CTextView::TDiscard aDiscardFormat = EFViewDontDiscardFormat,
1.533 + TDoHorizontalScroll aHorizontalScroll = EFCheckForHorizontalScroll);
1.534 + TPoint ViewL(const TTmDocPos& aDocPos,TInt& aYPos,TViewYPosQualifier aYPosQualifier = TViewYPosQualifier(),
1.535 + CTextView::TDiscard aDiscardFormat = EFViewDontDiscardFormat,
1.536 + TDoHorizontalScroll aHorizontalScroll = EFCheckForHorizontalScroll);
1.537 + TPoint DoHandleGlobalChangeL(TViewYPosQualifier aYPosQualifier,CTextView::TDiscard aDiscard);
1.538 + void UpdateHighlightL();
1.539 + void HighlightUsingExtensions(CTextLayout::TRangeChange aOptimizedRange, CTextLayout::TRangeChange aOriginalRange);
1.540 + void UpdatePictureFrameL();
1.541 + void RedrawPictureFrameRectL(TInt aPos);
1.542 + void DrawPictureFrameL(TRect& aClipRect);
1.543 + void DestroyWindowServerObjects();
1.544 + void NoMemoryL(TInt aErr);
1.545 + void RecoverNoMemoryL();
1.546 + void RecreateWindowServerObjectsL();
1.547 + void DrawTextSupportL(const TRect& aRect,const TCursorSelection* aHighlight);
1.548 + void DoDrawTextSupportL(const TRect& aRect,const TCursorSelection* aHighlight);
1.549 + void DoDrawTextSupportOpaqueL(const TRect& aRect,const TCursorSelection* aHighlight);
1.550 + void DisplayLineRangeL(TInt aFrom,TInt aTo);
1.551 + inline void NotifyReformatL();
1.552 + void CalculateHorizontalExtremes(TInt& aLeftX,TInt& aRightX,TBool aOnlyVisibleLines);
1.553 + TBool ExtendedHighlightExists() const;
1.554 + void DoClearSelectionL(const TCursorSelection& aSelection, TBool aIsPictureFrame);
1.555 + void AdjustRectForScrolling(TRect &aRect, TInt aScrollY, TInt aScrollX) const;
1.556 + static void ResetOffScreenBitmapContext(TAny* aTextView);
1.557 + static void ResetExternalDraw(TAny* aTextView);
1.558 +
1.559 +private:
1.560 + CIdle* iWrap;
1.561 + RScreenDisplay iDisplay;
1.562 + CTextLayout* iLayout; // must not be moved
1.563 + TDrawTextLayoutContext iDrawTextLayoutContext; // must not be moved
1.564 + TCursor iCursor;
1.565 + TCursorPosition iCursorPos; // must not be moved
1.566 + TFrameOverlay* iPictureFrame;
1.567 + TMemoryStatus iNoMemory;
1.568 + TUint iFlags; // must not be moved
1.569 + TUint iHorizontalScroll;
1.570 + TInt iGood;
1.571 + TInt iFormattedUpTo;
1.572 + TInt iHorizontalScrollJump;
1.573 + TInt iHeightNotDrawn;
1.574 + MObserver* iObserver; // must not be moved
1.575 + CBitmapContext* iOffScreenContext; //Explicit off-screen bitmap to draw to.
1.576 + TRect iReducedDrawingAreaRect;
1.577 + TUint iDummy;// was iRedrawExtendedHighlight;
1.578 + TBool iContextIsNavigation;
1.579 + TBool iDrawOpaque;
1.580 + };
1.581 +
1.582 +inline TUint TCursor::LineCursorVisibility()
1.583 + {
1.584 + return iLineCursor;
1.585 + }
1.586 +
1.587 +inline TUint TCursor::TextCursorVisibility()
1.588 + {
1.589 + return iTextCursor;
1.590 + }
1.591 +
1.592 +/** Returns a pointer to the text layout object used by the text view.
1.593 +@return A pointer to the text layout object used by the text view. */
1.594 +inline const CTextLayout* CTextView::Layout() const
1.595 + {
1.596 + return iLayout;
1.597 + }
1.598 +
1.599 +/** Sets a text view observer. This provides notification to the owner of the
1.600 +text view object of changes to the formatting. Its OnReformatL() function is
1.601 +called after reformatting but before redisplay, so that edit windows etc. can
1.602 +be resized.
1.603 +
1.604 +@param aObserver Pointer to text view observer object. */
1.605 +inline void CTextView::SetObserver(MObserver* aObserver)
1.606 + {
1.607 + iObserver = aObserver;
1.608 + }
1.609 +
1.610 +inline void CTextView::EnableFlickerFreeRedraw()
1.611 + {
1.612 + iFlags |= EFFlickerFreeRedraw;
1.613 + }
1.614 +
1.615 +inline void CTextView::DisableFlickerFreeRedraw()
1.616 + {
1.617 + iFlags &= ~EFFlickerFreeRedraw;
1.618 + }
1.619 +
1.620 +inline TBool CTextView::FlickerFreeRedraw() const
1.621 + {
1.622 + return iFlags & EFFlickerFreeRedraw;
1.623 + }
1.624 +
1.625 +inline void CTextView::NotifyReformatL()
1.626 + {
1.627 + if (iObserver)
1.628 + iObserver->OnReformatL(this);
1.629 + }
1.630 +
1.631 +inline TBool CTextView::IsFormatting() const
1.632 + {
1.633 + return iLayout->IsBackgroundFormatting();
1.634 + }
1.635 +
1.636 +inline TInt CTextView::TopViewRect() const
1.637 + {
1.638 + return iDrawTextLayoutContext.iViewRect.iTl.iY;
1.639 + }
1.640 +
1.641 +inline void CTextView::DrawWithPreviousHighlight()
1.642 + {
1.643 + iCursorPos.SetToPreviousHighlight();
1.644 + }
1.645 +
1.646 +inline void CTextView::DrawWithCurrentHighlight()
1.647 + {
1.648 + iCursorPos.SetToCurrentHighlight();
1.649 + }
1.650 +
1.651 +/** Gets the origin of the cursor.
1.652 +@param aPoint On return, the cursor origin. */
1.653 +inline void CTextView::GetOrigin(TPoint& aPoint) const
1.654 + {
1.655 + iLayout->GetOrigin(aPoint);
1.656 + aPoint += iDrawTextLayoutContext.TopLeftText();
1.657 + }
1.658 +
1.659 +/** This constructor deliberately does not take a pointer or reference to
1.660 +CTextView, to prevent the class from being used unless InitL() is called. */
1.661 +inline CTextView::TTagmaForwarder::TTagmaForwarder():
1.662 + iView(NULL)
1.663 + {
1.664 + }
1.665 +
1.666 +/** Called after construction, to complete background reformatting.
1.667 +@param aView A pointer to the text view object. */
1.668 +inline void CTextView::TTagmaForwarder::InitL(CTextView* aView)
1.669 + {
1.670 + iView = aView;
1.671 + iView->FinishBackgroundFormattingL();
1.672 + }
1.673 +
1.674 +inline const CTmTextLayout& CTextView::TTagmaForwarder::TextLayout() const
1.675 + {
1.676 + return iView->Layout()->TagmaTextLayout();
1.677 + }
1.678 +
1.679 +inline void CTextView::TTagmaForwarder::GetOrigin(TPoint& aPoint) const
1.680 + {
1.681 + iView->GetOrigin(aPoint);
1.682 + }
1.683 +
1.684 +#endif