Symbian^3 Application Developer Library >

CFsTextViewerVisualizer Class Reference

class CFsTextViewerVisualizer : public CBase

Inherits from

Public Member Functions
~CFsTextViewerVisualizer ()
CAlfLayout * BackgroundLayout ()
TSize CalculateSizeL ( MFsRichTextObject *)
TInt CalculateWidthL (const TDesC &, TInt )
void ClickedL ()
void CollapseL ( CAlfLayout *, TInt )
CAlfControl * Control ()
void EnableMarkL ( TBool )
void EnableSmileys ( TBool )
void ExpandExistingL ( CAlfLayout *, TSize , TInt )
CAlfLayout * ExpandL ( TInt , TInt , CAlfVisual *)
void FocusLineL ( TInt , TBool )
TInt GetCurrentHotspotByOrder ()
HBufC * GetCurrentHotspotTextL ()
void GetHotspotRangeL ( TInt &, TInt &)
void GetMarkedRange ( TInt &, TInt &)
CAknDoubleSpanScrollBar * GetScrollBar ()
CAlfLayout * GetStatusLayout ()
TInt GetTotalHeight ()
TPoint GetViewCenterPosition ()
TInt GetViewTopPosition ()
TBool GetVisibleFocusedHotspotLine ( TInt &)
TBool IsHotspotHighlighted ()
TSize LayoutVisualsL ( CAlfLayout *, TInt , TInt )
TBool MarkEnabled ()
void MoveDownL ()
void MoveLeftL ()
void MoveRightL ()
void MoveUpL ()
CFsTextViewerVisualizerData * Navigator ()
CFsTextViewerVisualizer * NewL ( CFsTextViewerControl &, CFsRichText *, CFsSmileyDictionary *, CFsTextViewerVisualizerSettings *)
TBool NextVisibleHotspotL ( TBool &)
void NotifyControlVisibilityChange ( TBool )
void PageDownL ( TInt )
void PageUpL ( TInt )
CFsTextParser * Parser ()
TBool PrevVisibleHotspotL ( TBool &)
void RedrawPartBgsL ()
void RefreshPartBgsL ()
void ReloadL ()
void ReloadPicturesL ( TInt )
void RemoveEndLinesL ( TInt )
void RemoveStatusLayout ()
void ReplaceTextL ( CFsRichText *, CFsSmileyDictionary *)
void Reset ()
CAlfLayout * RootLayout ()
void ScrollDownL ( TInt , TInt )
void ScrollUpL ( TInt , TInt )
void SetBackgroundColorL (const TRgb &)
void SetBackgroundImageL (CAlfTexture &)
void SetBackgroundOpacity ()
void SetCurrentHotspotByCharL ( TInt )
void SetCurrentHotspotByOrderL ( TInt , TBool )
void SetCursorDelay ( TInt )
void SetScrollDelay ( TInt )
void SetScrollOffsetInLines ( TInt )
void SetScrollOffsetInPx ( TInt )
void SetSmileySize ( TSize )
void SetWatermarkL ( CFsTextViewerWatermark *)
TBool SmileysEnabled ()
CAlfLayout * StackLayout ()
void SwitchMarkL ()
void UpdateDisplaySize ()
void UpdateStatusLayout ()
Private Member Functions
CFsTextViewerVisualizer ( CFsTextViewerVisualizerSettings *)
void ConstructL ( CFsTextViewerControl &, CFsRichText *, CFsSmileyDictionary *)
void ConstructSelfL ( CFsRichText *, CFsSmileyDictionary *, TBool )
void ConstructVisualsL ( TBool )
void DrawCursorL ( TInt )
void DrawMarkL ( TInt )
TInt FindMaxLengthL ( CAlfVisual *)
TInt FindMaxLengthL ( MFsRichTextObject *)
void InitDefaultsL ()
TFsRangedVisual PrepareRangedVisL ( MFsRichTextObject *, CAlfLayout *)
void SetColumnsL ( TBool )
void UpdateScrollbarL ()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enum anonymous { EUseDefaultScrollOffset  = -10000, EUseDefaultScrollTime  = -1 }
Public Attributes
TSize iContentSize
TSize iDisplaySize
TInt iFirstLine
CFsTextViewerVisualizerSettings * iSettings
CFsTextViewerSkinData * iSkinData
CFsTextStyleManager * iTextStyleManager
TInt iTotalLines
Private Attributes
CAlfBrush * iBackgroundBrush
CAlfLayout * iBackgroundLayout
CAlfBorderBrush * iBorder
CFsRichText * iCFsRichText
CAlfGridLayout * iComponentLayout
CAlfAnchorLayout * iContentLayout
CFsTextViewerControl * iControl
CAlfVisual * iCursor
TInt iCursorDelay
TBool iCursorEnabled
CAlfImageVisual * iDummyScrollbar
TAlfTimedValue iEffectiveOffset
CAlfEnv * iEnv
TInt iExpandDelay
TFsTextureObserver iFsTextureObserver
CFsTextViewerCoordinator * iHelper
TBool iIsLayouted
CFsTextViewerLayouter * iLayouter
TInt iLineOffset
TBool iMark
CFsTextViewerMarkFacility * iMarkFacility
CAlfLayout * iMarkingLayout
CFsTextViewerVisualizerData * iNavigator
CFsTextParser * iParser
TInt iRichTextLength
CAlfDeckLayout * iRootLayout
CWsScreenDevice * iScreenDev
TBool iScrollByCursor
CAknDoubleSpanScrollBar * iScrollbar
TAknDoubleSpanScrollBarModel iScrollbarModel
TInt iScrollbarPos
TFsScrollbarVisibility iScrollbarVisibility
TBool iScrollbarVisible
TInt iScrollingDelay
TInt iScrollingOffset
CFsTextViewerSelectsManager * iSelector
CFsSmileyDictionary * iSmileyDict
TBool iSmileyEnabled
CAlfAnchorLayout * iStatusLineLayout
CAlfTextVisual * iText
CFsTextureLoader * iTextureLoader
TInt iTotalHeight
CFsTextViewerWatermark * iWatermark
CAlfImageVisual * iWatermarkVisual

Constructor & Destructor Documentation

CFsTextViewerVisualizer(CFsTextViewerVisualizerSettings *)

CFsTextViewerVisualizer ( CFsTextViewerVisualizerSettings * aSettings ) [private]

Parameters

CFsTextViewerVisualizerSettings * aSettings

~CFsTextViewerVisualizer()

~CFsTextViewerVisualizer ( )

Member Functions Documentation

BackgroundLayout()

CAlfLayout * BackgroundLayout ( )

CalculateSizeL(MFsRichTextObject *)

TSize CalculateSizeL ( MFsRichTextObject * aObject )

Parameters

MFsRichTextObject * aObject

CalculateWidthL(const TDesC &, TInt)

TInt CalculateWidthL ( const TDesC & aText,
TInt aTextStyleId
)

Parameters

const TDesC & aText
TInt aTextStyleId

ClickedL()

void ClickedL ( )

CollapseL(CAlfLayout *, TInt)

void CollapseL ( CAlfLayout * aLayout,
TInt aId
)

Parameters

CAlfLayout * aLayout
TInt aId

ConstructL(CFsTextViewerControl &, CFsRichText *, CFsSmileyDictionary *)

void ConstructL ( CFsTextViewerControl & aControl,
CFsRichText * aRichText,
CFsSmileyDictionary * aSmDict
) [private]

Parameters

CFsTextViewerControl & aControl
CFsRichText * aRichText
CFsSmileyDictionary * aSmDict

ConstructSelfL(CFsRichText *, CFsSmileyDictionary *, TBool)

void ConstructSelfL ( CFsRichText * aRichText,
CFsSmileyDictionary * aSmDict,
TBool aNew = ETrue
) [private]

Parameters

CFsRichText * aRichText
CFsSmileyDictionary * aSmDict
TBool aNew = ETrue

ConstructVisualsL(TBool)

void ConstructVisualsL ( TBool aRefreshBg = ETrue ) [private]

Parameters

TBool aRefreshBg = ETrue

Control()

CAlfControl * Control ( )

DrawCursorL(TInt)

void DrawCursorL ( TInt aTime ) [private]

Parameters

TInt aTime

DrawMarkL(TInt)

void DrawMarkL ( TInt aTime = 0 ) [private]

Parameters

TInt aTime = 0

EnableMarkL(TBool)

void EnableMarkL ( TBool aEnabled = ETrue )

Parameters

TBool aEnabled = ETrue

EnableSmileys(TBool)

void EnableSmileys ( TBool aStatus = ETrue )

Parameters

TBool aStatus = ETrue

ExpandExistingL(CAlfLayout *, TSize, TInt)

void ExpandExistingL ( CAlfLayout * aLayout,
TSize aTargetSize,
TInt aId
)

Parameters

CAlfLayout * aLayout
TSize aTargetSize
TInt aId

ExpandL(TInt, TInt, CAlfVisual *)

CAlfLayout * ExpandL ( TInt aId,
TInt aStart,
CAlfVisual * aVisual
)

Parameters

TInt aId
TInt aStart
CAlfVisual * aVisual

FindMaxLengthL(CAlfVisual *)

TInt FindMaxLengthL ( CAlfVisual * aVisual ) [private]

Parameters

CAlfVisual * aVisual

FindMaxLengthL(MFsRichTextObject *)

TInt FindMaxLengthL ( MFsRichTextObject * aObject ) [private]

Parameters

MFsRichTextObject * aObject

FocusLineL(TInt, TBool)

void FocusLineL ( TInt aLine,
TBool aShowAsFirstLine = EFalse
)

Parameters

TInt aLine
TBool aShowAsFirstLine = EFalse

GetCurrentHotspotByOrder()

TInt GetCurrentHotspotByOrder ( )

GetCurrentHotspotTextL()

HBufC * GetCurrentHotspotTextL ( )

GetHotspotRangeL(TInt &, TInt &)

void GetHotspotRangeL ( TInt & aBegin,
TInt & aEnd
)

Parameters

TInt & aBegin
TInt & aEnd

GetMarkedRange(TInt &, TInt &)

void GetMarkedRange ( TInt & aBegin,
TInt & aEnd
)

Parameters

TInt & aBegin
TInt & aEnd

GetScrollBar()

CAknDoubleSpanScrollBar * GetScrollBar ( )

GetStatusLayout()

CAlfLayout * GetStatusLayout ( )

GetTotalHeight()

TInt GetTotalHeight ( )

GetViewCenterPosition()

TPoint GetViewCenterPosition ( )

GetViewTopPosition()

TInt GetViewTopPosition ( )

GetVisibleFocusedHotspotLine(TInt &)

TBool GetVisibleFocusedHotspotLine ( TInt & aLineNum ) const

Parameters

TInt & aLineNum

InitDefaultsL()

void InitDefaultsL ( ) [private]

IsHotspotHighlighted()

TBool IsHotspotHighlighted ( )

LayoutVisualsL(CAlfLayout *, TInt, TInt)

TSize LayoutVisualsL ( CAlfLayout * aLayout,
TInt aStart,
TInt aEnd
)

Parameters

CAlfLayout * aLayout
TInt aStart
TInt aEnd

MarkEnabled()

TBool MarkEnabled ( )

MoveDownL()

void MoveDownL ( )

MoveLeftL()

void MoveLeftL ( )

MoveRightL()

void MoveRightL ( )

MoveUpL()

void MoveUpL ( )

Navigator()

CFsTextViewerVisualizerData * Navigator ( )

NewL(CFsTextViewerControl &, CFsRichText *, CFsSmileyDictionary *, CFsTextViewerVisualizerSettings *)

CFsTextViewerVisualizer * NewL ( CFsTextViewerControl & aControl,
CFsRichText * aRichText,
CFsSmileyDictionary * aSmDict,
CFsTextViewerVisualizerSettings * aSettings
) [static]

Parameters

CFsTextViewerControl & aControl
CFsRichText * aRichText
CFsSmileyDictionary * aSmDict
CFsTextViewerVisualizerSettings * aSettings

NextVisibleHotspotL(TBool &)

TBool NextVisibleHotspotL ( TBool & aChanged )

Parameters

TBool & aChanged

NotifyControlVisibilityChange(TBool)

void NotifyControlVisibilityChange ( TBool aIsVisible )

Parameters

TBool aIsVisible

PageDownL(TInt)

void PageDownL ( TInt aTime = EUseDefaultScrollTime )

Parameters

TInt aTime = EUseDefaultScrollTime

PageUpL(TInt)

void PageUpL ( TInt aTime = EUseDefaultScrollTime )

Parameters

TInt aTime = EUseDefaultScrollTime

Parser()

CFsTextParser * Parser ( )

PrepareRangedVisL(MFsRichTextObject *, CAlfLayout *)

TFsRangedVisual PrepareRangedVisL ( MFsRichTextObject * aObject,
CAlfLayout * aLayout
) [private]

Parameters

MFsRichTextObject * aObject
CAlfLayout * aLayout

PrevVisibleHotspotL(TBool &)

TBool PrevVisibleHotspotL ( TBool & aChanged )

Parameters

TBool & aChanged

RedrawPartBgsL()

void RedrawPartBgsL ( )

RefreshPartBgsL()

void RefreshPartBgsL ( )

ReloadL()

void ReloadL ( )

ReloadPicturesL(TInt)

void ReloadPicturesL ( TInt aLine )

Parameters

TInt aLine

RemoveEndLinesL(TInt)

void RemoveEndLinesL ( TInt aLines )

Parameters

TInt aLines

RemoveStatusLayout()

void RemoveStatusLayout ( )

ReplaceTextL(CFsRichText *, CFsSmileyDictionary *)

void ReplaceTextL ( CFsRichText * aRichText,
CFsSmileyDictionary * aSmDict = NULL
)

Parameters

CFsRichText * aRichText
CFsSmileyDictionary * aSmDict = NULL

Reset()

void Reset ( )

RootLayout()

CAlfLayout * RootLayout ( )

ScrollDownL(TInt, TInt)

void ScrollDownL ( TInt aOffset = EUseDefaultScrollOffset,
TInt aTime = EUseDefaultScrollTime
)

Parameters

TInt aOffset = EUseDefaultScrollOffset
TInt aTime = EUseDefaultScrollTime

ScrollUpL(TInt, TInt)

void ScrollUpL ( TInt aOffset = EUseDefaultScrollOffset,
TInt aTime = EUseDefaultScrollTime
)

Parameters

TInt aOffset = EUseDefaultScrollOffset
TInt aTime = EUseDefaultScrollTime

SetBackgroundColorL(const TRgb &)

void SetBackgroundColorL ( const TRgb & aColor )

Parameters

const TRgb & aColor

SetBackgroundImageL(CAlfTexture &)

void SetBackgroundImageL ( CAlfTexture & aTexture )

Parameters

CAlfTexture & aTexture

SetBackgroundOpacity()

void SetBackgroundOpacity ( )

SetColumnsL(TBool)

void SetColumnsL ( TBool aShowScrollBar ) [private]

Parameters

TBool aShowScrollBar

SetCurrentHotspotByCharL(TInt)

void SetCurrentHotspotByCharL ( TInt aIndex )

Parameters

TInt aIndex

SetCurrentHotspotByOrderL(TInt, TBool)

void SetCurrentHotspotByOrderL ( TInt aIndex,
TBool aFocusLine = EFalse
)

Parameters

TInt aIndex
TBool aFocusLine = EFalse

SetCursorDelay(TInt)

void SetCursorDelay ( TInt aDelay )

Parameters

TInt aDelay

SetScrollDelay(TInt)

void SetScrollDelay ( TInt aDelay )

Parameters

TInt aDelay

SetScrollOffsetInLines(TInt)

void SetScrollOffsetInLines ( TInt aLineOffset )

Parameters

TInt aLineOffset

SetScrollOffsetInPx(TInt)

void SetScrollOffsetInPx ( TInt aPxOffset )

Parameters

TInt aPxOffset

SetSmileySize(TSize)

void SetSmileySize ( TSize aSize )

Parameters

TSize aSize

SetWatermarkL(CFsTextViewerWatermark *)

void SetWatermarkL ( CFsTextViewerWatermark * aWatermark )

Parameters

CFsTextViewerWatermark * aWatermark

SmileysEnabled()

TBool SmileysEnabled ( )

StackLayout()

CAlfLayout * StackLayout ( )

SwitchMarkL()

void SwitchMarkL ( )

UpdateDisplaySize()

void UpdateDisplaySize ( )

UpdateScrollbarL()

void UpdateScrollbarL ( ) [private]

UpdateStatusLayout()

void UpdateStatusLayout ( )

Member Enumerations Documentation

Enum anonymous

Enumerators

EUseDefaultScrollOffset = -10000
EUseDefaultScrollTime = -1

Member Data Documentation

CAlfBrush * iBackgroundBrush

CAlfBrush * iBackgroundBrush [private]

CAlfLayout * iBackgroundLayout

CAlfLayout * iBackgroundLayout [private]

CAlfBorderBrush * iBorder

CAlfBorderBrush * iBorder [private]

CFsRichText * iCFsRichText

CFsRichText * iCFsRichText [private]

CAlfGridLayout * iComponentLayout

CAlfGridLayout * iComponentLayout [private]

CAlfAnchorLayout * iContentLayout

CAlfAnchorLayout * iContentLayout [private]

TSize iContentSize

TSize iContentSize

CFsTextViewerControl * iControl

CFsTextViewerControl * iControl [private]

CAlfVisual * iCursor

CAlfVisual * iCursor [private]

TInt iCursorDelay

TInt iCursorDelay [private]

TBool iCursorEnabled

TBool iCursorEnabled [private]

TSize iDisplaySize

TSize iDisplaySize

CAlfImageVisual * iDummyScrollbar

CAlfImageVisual * iDummyScrollbar [private]

TAlfTimedValue iEffectiveOffset

TAlfTimedValue iEffectiveOffset [private]

CAlfEnv * iEnv

CAlfEnv * iEnv [private]

TInt iExpandDelay

TInt iExpandDelay [private]

TInt iFirstLine

TInt iFirstLine

TFsTextureObserver iFsTextureObserver

TFsTextureObserver iFsTextureObserver [private]

CFsTextViewerCoordinator * iHelper

CFsTextViewerCoordinator * iHelper [private]

TBool iIsLayouted

TBool iIsLayouted [private]

CFsTextViewerLayouter * iLayouter

CFsTextViewerLayouter * iLayouter [private]

TInt iLineOffset

TInt iLineOffset [private]

TBool iMark

TBool iMark [private]

CFsTextViewerMarkFacility * iMarkFacility

CFsTextViewerMarkFacility * iMarkFacility [private]

CAlfLayout * iMarkingLayout

CAlfLayout * iMarkingLayout [private]

CFsTextViewerVisualizerData * iNavigator

CFsTextViewerVisualizerData * iNavigator [private]

CFsTextParser * iParser

CFsTextParser * iParser [private]

TInt iRichTextLength

TInt iRichTextLength [private]

CAlfDeckLayout * iRootLayout

CAlfDeckLayout * iRootLayout [private]

CWsScreenDevice * iScreenDev

CWsScreenDevice * iScreenDev [private]

TBool iScrollByCursor

TBool iScrollByCursor [private]

CAknDoubleSpanScrollBar * iScrollbar

CAknDoubleSpanScrollBar * iScrollbar [private]

TAknDoubleSpanScrollBarModel iScrollbarModel

TAknDoubleSpanScrollBarModel iScrollbarModel [private]

TInt iScrollbarPos

TInt iScrollbarPos [private]

Scrollbar position

TFsScrollbarVisibility iScrollbarVisibility

TFsScrollbarVisibility iScrollbarVisibility [private]

Visibility of scrollbar

TBool iScrollbarVisible

TBool iScrollbarVisible [private]

TInt iScrollingDelay

TInt iScrollingDelay [private]

TInt iScrollingOffset

TInt iScrollingOffset [private]

CFsTextViewerSelectsManager * iSelector

CFsTextViewerSelectsManager * iSelector [private]

CFsTextViewerVisualizerSettings * iSettings

CFsTextViewerVisualizerSettings * iSettings

CFsTextViewerSkinData * iSkinData

CFsTextViewerSkinData * iSkinData

CFsSmileyDictionary * iSmileyDict

CFsSmileyDictionary * iSmileyDict [private]

TBool iSmileyEnabled

TBool iSmileyEnabled [private]

CAlfAnchorLayout * iStatusLineLayout

CAlfAnchorLayout * iStatusLineLayout [private]

CAlfTextVisual * iText

CAlfTextVisual * iText [private]

CFsTextStyleManager * iTextStyleManager

CFsTextStyleManager * iTextStyleManager

CFsTextureLoader * iTextureLoader

CFsTextureLoader * iTextureLoader [private]

TInt iTotalHeight

TInt iTotalHeight [private]

TInt iTotalLines

TInt iTotalLines

CFsTextViewerWatermark * iWatermark

CFsTextViewerWatermark * iWatermark [private]

CAlfImageVisual * iWatermarkVisual

CAlfImageVisual * iWatermarkVisual [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.