Symbian^3 Application Developer Library >

CFsTextViewer Class Reference

class CFsTextViewer : public CBase

Inherits from

Public Member Functions
~CFsTextViewer ()
IMPORT_C const TAlfTimedValue & BackgroundOpacity ()
IMPORT_C TBool CursorUpDown ()
IMPORT_C void EnableCursorUpDown ( TBool )
IMPORT_C void EnableSmileys ( TBool )
IMPORT_C void FocusLineL ( TInt , TBool )
IMPORT_C CAlfControl * GetControl ()
IMPORT_C TInt GetCurrentHotspotByOrder ()
IMPORT_C void GetCurrentHotspotL ( TInt &, TInt &)
IMPORT_C HBufC * GetCurrentHotspotTextL ()
IMPORT_C TInt GetFirstCharInLine ( TInt )
IMPORT_C TInt GetFirstDisplayedLine ()
IMPORT_C TInt GetLastDisplayedLine ()
IMPORT_C TInt GetLineNumber ( TInt )
IMPORT_C void GetMarkedArea ( TInt &, TInt &)
IMPORT_C CAlfLayout * GetStatusLayout ()
IMPORT_C TInt GetTotalLines ()
IMPORT_C TBool GetVisibleFocusedHotspotLine ( TInt &)
IMPORT_C void Hide ()
IMPORT_C void HideActionButtonFromCurrentHighlightedHotspot ()
IMPORT_C CFsTextViewerKeys * Keys ()
IMPORT_C CFsTextViewer * NewL (CAlfEnv &)
IMPORT_C void ReloadPicturesL ( TInt )
IMPORT_C void ReloadTextL ()
IMPORT_C void RemoveEndLinesL ( TInt )
IMPORT_C void RemoveStatusLayout ()
IMPORT_C void ReplaceTextL ( CFsRichText *, CFsSmileyDictionary *)
IMPORT_C CAlfLayout * RootLayout ()
IMPORT_C void SetActionButton (CAlfTexture &, TReal32 )
IMPORT_C void SetActionButtonMargin ( TReal32 )
IMPORT_C void SetActionButtonSize ( TReal32 , TReal32 )
IMPORT_C void SetBackgroundColorL (const TRgb &)
IMPORT_C void SetBackgroundImageL (CAlfTexture &)
IMPORT_C void SetBackgroundOpacity (const TAlfTimedValue &)
IMPORT_C void SetCurrentHotspotByCharL ( TInt )
IMPORT_C void SetCurrentHotspotByOrderL ( TInt , TBool )
IMPORT_C void SetCursorDelay ( TInt )
IMPORT_C void SetCustomKeys ( CFsTextViewerKeys *)
IMPORT_C void SetLeftMargin ( TInt )
IMPORT_C void SetLiteLineBg (CAlfTexture &, TReal32 )
IMPORT_C void SetMirroring ( TBool )
IMPORT_C void SetObserver (MFsTextViewerObserver *)
IMPORT_C void SetPartBgColorL ( TInt , TInt , const TRgb &)
IMPORT_C void SetPartBgImageL ( TInt , TInt , CAlfTexture &)
IMPORT_C void SetPictureSize ( TSize )
IMPORT_C void SetRightMargin ( TInt )
IMPORT_C void SetScrollDelay ( TInt )
IMPORT_C void SetScrollOffsetInLines ( TInt )
IMPORT_C void SetScrollOffsetInPx ( TInt )
IMPORT_C void SetSmileySize ( TSize )
IMPORT_C void SetTextL ( CFsRichText *, CFsSmileyDictionary *)
IMPORT_C void SetWatermarkL ( CFsTextViewerWatermark *)
IMPORT_C void Show ()
IMPORT_C void ShowActionButtonForCurrentHighlightedHotspotL ()
IMPORT_C TBool Smileys ()
IMPORT_C void UpdateStatusLayout ()
Private Member Functions
CFsTextViewer (CAlfEnv &)
void ConstructL (CAlfEnv &)
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()
Private Attributes
TBool iBackColorSet
TRgb iColor
CFsTextViewerControl * iControl
CFsTextViewerVisualizerSettings * iSettings
CAlfTexture * iTexture
CFsTextViewerVisualizer * iVisualizer
CFsTextViewerWatermark * iWatermark

Constructor & Destructor Documentation

CFsTextViewer(CAlfEnv &)

CFsTextViewer ( CAlfEnv & aEnv ) [private]

Parameters

CAlfEnv & aEnv

~CFsTextViewer()

IMPORT_C ~CFsTextViewer ( )

Member Functions Documentation

BackgroundOpacity()

IMPORT_C const TAlfTimedValue & BackgroundOpacity ( ) const

ConstructL(CAlfEnv &)

void ConstructL ( CAlfEnv & aEnv ) [private]

Parameters

CAlfEnv & aEnv

CursorUpDown()

IMPORT_C TBool CursorUpDown ( )

EnableCursorUpDown(TBool)

IMPORT_C void EnableCursorUpDown ( TBool aStatus = ETrue )

Parameters

TBool aStatus = ETrue

EnableSmileys(TBool)

IMPORT_C void EnableSmileys ( TBool aStatus = ETrue )

Parameters

TBool aStatus = ETrue

FocusLineL(TInt, TBool)

IMPORT_C void FocusLineL ( TInt aLine,
TBool aShowAsFirstLine = EFalse
)

Parameters

TInt aLine
TBool aShowAsFirstLine = EFalse

GetControl()

IMPORT_C CAlfControl * GetControl ( ) const

GetCurrentHotspotByOrder()

IMPORT_C TInt GetCurrentHotspotByOrder ( )

GetCurrentHotspotL(TInt &, TInt &)

IMPORT_C void GetCurrentHotspotL ( TInt & aBegin,
TInt & aEnd
)

Parameters

TInt & aBegin
TInt & aEnd

GetCurrentHotspotTextL()

IMPORT_C HBufC * GetCurrentHotspotTextL ( )

GetFirstCharInLine(TInt)

IMPORT_C TInt GetFirstCharInLine ( TInt aChar )

Parameters

TInt aChar

GetFirstDisplayedLine()

IMPORT_C TInt GetFirstDisplayedLine ( )

GetLastDisplayedLine()

IMPORT_C TInt GetLastDisplayedLine ( )

GetLineNumber(TInt)

IMPORT_C TInt GetLineNumber ( TInt aLineOffset )

Parameters

TInt aLineOffset

GetMarkedArea(TInt &, TInt &)

IMPORT_C void GetMarkedArea ( TInt & aBegin,
TInt & aEnd
)

Parameters

TInt & aBegin
TInt & aEnd

GetStatusLayout()

IMPORT_C CAlfLayout * GetStatusLayout ( )

GetTotalLines()

IMPORT_C TInt GetTotalLines ( )

GetVisibleFocusedHotspotLine(TInt &)

IMPORT_C TBool GetVisibleFocusedHotspotLine ( TInt & aLineNum ) const

Parameters

TInt & aLineNum

Hide()

IMPORT_C void Hide ( )

HideActionButtonFromCurrentHighlightedHotspot()

IMPORT_C void HideActionButtonFromCurrentHighlightedHotspot ( )

Keys()

IMPORT_C CFsTextViewerKeys * Keys ( )

NewL(CAlfEnv &)

IMPORT_C CFsTextViewer * NewL ( CAlfEnv & aEnv ) [static]

Parameters

CAlfEnv & aEnv

ReloadPicturesL(TInt)

IMPORT_C void ReloadPicturesL ( TInt aLine = -1 )

Parameters

TInt aLine = -1

ReloadTextL()

IMPORT_C void ReloadTextL ( )

RemoveEndLinesL(TInt)

IMPORT_C void RemoveEndLinesL ( TInt aLines )

Parameters

TInt aLines

RemoveStatusLayout()

IMPORT_C void RemoveStatusLayout ( )

ReplaceTextL(CFsRichText *, CFsSmileyDictionary *)

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

Parameters

CFsRichText * aRichText
CFsSmileyDictionary * aSmDict = NULL

RootLayout()

IMPORT_C CAlfLayout * RootLayout ( )

SetActionButton(CAlfTexture &, TReal32)

IMPORT_C void SetActionButton ( CAlfTexture & aTexture,
TReal32 aOpacity
)

Parameters

CAlfTexture & aTexture
TReal32 aOpacity

SetActionButtonMargin(TReal32)

IMPORT_C void SetActionButtonMargin ( TReal32 aMargin )

Parameters

TReal32 aMargin

SetActionButtonSize(TReal32, TReal32)

IMPORT_C void SetActionButtonSize ( TReal32 aWidth,
TReal32 aHeight
)

Parameters

TReal32 aWidth
TReal32 aHeight

SetBackgroundColorL(const TRgb &)

IMPORT_C void SetBackgroundColorL ( const TRgb & aColor )

Parameters

const TRgb & aColor

SetBackgroundImageL(CAlfTexture &)

IMPORT_C void SetBackgroundImageL ( CAlfTexture & aTexture )

Parameters

CAlfTexture & aTexture

SetBackgroundOpacity(const TAlfTimedValue &)

IMPORT_C void SetBackgroundOpacity ( const TAlfTimedValue & aOpacity )

Parameters

const TAlfTimedValue & aOpacity

SetCurrentHotspotByCharL(TInt)

IMPORT_C void SetCurrentHotspotByCharL ( TInt aIndex )

Parameters

TInt aIndex

SetCurrentHotspotByOrderL(TInt, TBool)

IMPORT_C void SetCurrentHotspotByOrderL ( TInt aIndex,
TBool aFocusLine = EFalse
)

Parameters

TInt aIndex
TBool aFocusLine = EFalse

SetCursorDelay(TInt)

IMPORT_C void SetCursorDelay ( TInt aDelay )

Parameters

TInt aDelay

SetCustomKeys(CFsTextViewerKeys *)

IMPORT_C void SetCustomKeys ( CFsTextViewerKeys * aKeys )

Parameters

CFsTextViewerKeys * aKeys

SetLeftMargin(TInt)

IMPORT_C void SetLeftMargin ( TInt aMargin )

Parameters

TInt aMargin

SetLiteLineBg(CAlfTexture &, TReal32)

IMPORT_C void SetLiteLineBg ( CAlfTexture & aTexture,
TReal32 aOpacity
)

Parameters

CAlfTexture & aTexture
TReal32 aOpacity

SetMirroring(TBool)

IMPORT_C void SetMirroring ( TBool aEnable = ETrue )

Parameters

TBool aEnable = ETrue

SetObserver(MFsTextViewerObserver *)

IMPORT_C void SetObserver ( MFsTextViewerObserver * aObserver )

Parameters

MFsTextViewerObserver * aObserver

SetPartBgColorL(TInt, TInt, const TRgb &)

IMPORT_C void SetPartBgColorL ( TInt aStartChar,
TInt aEndChar,
const TRgb & aColor
)

Parameters

TInt aStartChar
TInt aEndChar
const TRgb & aColor

SetPartBgImageL(TInt, TInt, CAlfTexture &)

IMPORT_C void SetPartBgImageL ( TInt aStartChar,
TInt aEndChar,
CAlfTexture & aTexture
)

Parameters

TInt aStartChar
TInt aEndChar
CAlfTexture & aTexture

SetPictureSize(TSize)

IMPORT_C void SetPictureSize ( TSize aSize )

Parameters

TSize aSize

SetRightMargin(TInt)

IMPORT_C void SetRightMargin ( TInt aMargin )

Parameters

TInt aMargin

SetScrollDelay(TInt)

IMPORT_C void SetScrollDelay ( TInt aDelay )

Parameters

TInt aDelay

SetScrollOffsetInLines(TInt)

IMPORT_C void SetScrollOffsetInLines ( TInt aLineOffset )

Parameters

TInt aLineOffset

SetScrollOffsetInPx(TInt)

IMPORT_C void SetScrollOffsetInPx ( TInt aPxOffset )

Parameters

TInt aPxOffset

SetSmileySize(TSize)

IMPORT_C void SetSmileySize ( TSize aSize )

Parameters

TSize aSize

SetTextL(CFsRichText *, CFsSmileyDictionary *)

IMPORT_C void SetTextL ( CFsRichText * aText,
CFsSmileyDictionary * aSmDict
)

Parameters

CFsRichText * aText
CFsSmileyDictionary * aSmDict

SetWatermarkL(CFsTextViewerWatermark *)

IMPORT_C void SetWatermarkL ( CFsTextViewerWatermark * aWatermark )

Parameters

CFsTextViewerWatermark * aWatermark

Show()

IMPORT_C void Show ( )

ShowActionButtonForCurrentHighlightedHotspotL()

IMPORT_C void ShowActionButtonForCurrentHighlightedHotspotL ( )

Smileys()

IMPORT_C TBool Smileys ( )

UpdateStatusLayout()

IMPORT_C void UpdateStatusLayout ( )

Member Data Documentation

TBool iBackColorSet

TBool iBackColorSet [private]

TRgb iColor

TRgb iColor [private]

CFsTextViewerControl * iControl

CFsTextViewerControl * iControl [private]

CFsTextViewerVisualizerSettings * iSettings

CFsTextViewerVisualizerSettings * iSettings [private]

CAlfTexture * iTexture

CAlfTexture * iTexture [private]

CFsTextViewerVisualizer * iVisualizer

CFsTextViewerVisualizer * iVisualizer [private]

CFsTextViewerWatermark * iWatermark

CFsTextViewerWatermark * iWatermark [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.