Symbian^3 Product Developer Library >

CFsTextViewer Class Reference

class CFsTextViewer : public CBase

Inherits from

Public Member Functions
~CFsTextViewer()
IMPORT_C const TAlfTimedValue &BackgroundOpacity()
IMPORT_C TBoolCursorUpDown()
IMPORT_C voidEnableCursorUpDown(TBool)
IMPORT_C voidEnableSmileys(TBool)
IMPORT_C voidFocusLineL(TInt, TBool)
IMPORT_C CAlfControl *GetControl()
IMPORT_C TIntGetCurrentHotspotByOrder()
IMPORT_C voidGetCurrentHotspotL(TInt &, TInt &)
IMPORT_C HBufC *GetCurrentHotspotTextL()
IMPORT_C TIntGetFirstCharInLine(TInt)
IMPORT_C TIntGetFirstDisplayedLine()
IMPORT_C TIntGetLastDisplayedLine()
IMPORT_C TIntGetLineNumber(TInt)
IMPORT_C voidGetMarkedArea(TInt &, TInt &)
IMPORT_C CAlfLayout *GetStatusLayout()
IMPORT_C TIntGetTotalLines()
IMPORT_C TBoolGetVisibleFocusedHotspotLine(TInt &)
IMPORT_C voidHide()
IMPORT_C voidHideActionButtonFromCurrentHighlightedHotspot()
IMPORT_C CFsTextViewerKeys *Keys()
IMPORT_C CFsTextViewer *NewL(CAlfEnv &)
IMPORT_C voidReloadPicturesL(TInt)
IMPORT_C voidReloadTextL()
IMPORT_C voidRemoveEndLinesL(TInt)
IMPORT_C voidRemoveStatusLayout()
IMPORT_C voidReplaceTextL(CFsRichText *, CFsSmileyDictionary *)
IMPORT_C CAlfLayout *RootLayout()
IMPORT_C voidSetActionButton(CAlfTexture &, TReal32)
IMPORT_C voidSetActionButtonMargin(TReal32)
IMPORT_C voidSetActionButtonSize(TReal32, TReal32)
IMPORT_C voidSetBackgroundColorL(const TRgb &)
IMPORT_C voidSetBackgroundImageL(CAlfTexture &)
IMPORT_C voidSetBackgroundOpacity(const TAlfTimedValue &)
IMPORT_C voidSetCurrentHotspotByCharL(TInt)
IMPORT_C voidSetCurrentHotspotByOrderL(TInt, TBool)
IMPORT_C voidSetCursorDelay(TInt)
IMPORT_C voidSetCustomKeys(CFsTextViewerKeys *)
IMPORT_C voidSetLeftMargin(TInt)
IMPORT_C voidSetLiteLineBg(CAlfTexture &, TReal32)
IMPORT_C voidSetMirroring(TBool)
IMPORT_C voidSetObserver(MFsTextViewerObserver *)
IMPORT_C voidSetPartBgColorL(TInt, TInt, const TRgb &)
IMPORT_C voidSetPartBgImageL(TInt, TInt, CAlfTexture &)
IMPORT_C voidSetPictureSize(TSize)
IMPORT_C voidSetRightMargin(TInt)
IMPORT_C voidSetScrollDelay(TInt)
IMPORT_C voidSetScrollOffsetInLines(TInt)
IMPORT_C voidSetScrollOffsetInPx(TInt)
IMPORT_C voidSetSmileySize(TSize)
IMPORT_C voidSetTextL(CFsRichText *, CFsSmileyDictionary *)
IMPORT_C voidSetWatermarkL(CFsTextViewerWatermark *)
IMPORT_C voidShow()
IMPORT_C voidShowActionButtonForCurrentHighlightedHotspotL()
IMPORT_C TBoolSmileys()
IMPORT_C voidUpdateStatusLayout()
Private Member Functions
CFsTextViewer(CAlfEnv &)
voidConstructL(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 &)

voidConstructL(CAlfEnv &aEnv)[private]

Parameters

CAlfEnv & aEnv

CursorUpDown()

IMPORT_C TBoolCursorUpDown()

EnableCursorUpDown(TBool)

IMPORT_C voidEnableCursorUpDown(TBoolaStatus = ETrue)

Parameters

TBool aStatus = ETrue

EnableSmileys(TBool)

IMPORT_C voidEnableSmileys(TBoolaStatus = ETrue)

Parameters

TBool aStatus = ETrue

FocusLineL(TInt, TBool)

IMPORT_C voidFocusLineL(TIntaLine,
TBoolaShowAsFirstLine = EFalse
)

Parameters

TInt aLine
TBool aShowAsFirstLine = EFalse

GetControl()

IMPORT_C CAlfControl *GetControl()const

GetCurrentHotspotByOrder()

IMPORT_C TIntGetCurrentHotspotByOrder()

GetCurrentHotspotL(TInt &, TInt &)

IMPORT_C voidGetCurrentHotspotL(TInt &aBegin,
TInt &aEnd
)

Parameters

TInt & aBegin
TInt & aEnd

GetCurrentHotspotTextL()

IMPORT_C HBufC *GetCurrentHotspotTextL()

GetFirstCharInLine(TInt)

IMPORT_C TIntGetFirstCharInLine(TIntaChar)

Parameters

TInt aChar

GetFirstDisplayedLine()

IMPORT_C TIntGetFirstDisplayedLine()

GetLastDisplayedLine()

IMPORT_C TIntGetLastDisplayedLine()

GetLineNumber(TInt)

IMPORT_C TIntGetLineNumber(TIntaLineOffset)

Parameters

TInt aLineOffset

GetMarkedArea(TInt &, TInt &)

IMPORT_C voidGetMarkedArea(TInt &aBegin,
TInt &aEnd
)

Parameters

TInt & aBegin
TInt & aEnd

GetStatusLayout()

IMPORT_C CAlfLayout *GetStatusLayout()

GetTotalLines()

IMPORT_C TIntGetTotalLines()

GetVisibleFocusedHotspotLine(TInt &)

IMPORT_C TBoolGetVisibleFocusedHotspotLine(TInt &aLineNum)const

Parameters

TInt & aLineNum

Hide()

IMPORT_C voidHide()

HideActionButtonFromCurrentHighlightedHotspot()

IMPORT_C voidHideActionButtonFromCurrentHighlightedHotspot()

Keys()

IMPORT_C CFsTextViewerKeys *Keys()

NewL(CAlfEnv &)

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

Parameters

CAlfEnv & aEnv

ReloadPicturesL(TInt)

IMPORT_C voidReloadPicturesL(TIntaLine = -1)

Parameters

TInt aLine = -1

ReloadTextL()

IMPORT_C voidReloadTextL()

RemoveEndLinesL(TInt)

IMPORT_C voidRemoveEndLinesL(TIntaLines)

Parameters

TInt aLines

RemoveStatusLayout()

IMPORT_C voidRemoveStatusLayout()

ReplaceTextL(CFsRichText *, CFsSmileyDictionary *)

IMPORT_C voidReplaceTextL(CFsRichText *aRichText,
CFsSmileyDictionary *aSmDict = NULL
)

Parameters

CFsRichText * aRichText
CFsSmileyDictionary * aSmDict = NULL

RootLayout()

IMPORT_C CAlfLayout *RootLayout()

SetActionButton(CAlfTexture &, TReal32)

IMPORT_C voidSetActionButton(CAlfTexture &aTexture,
TReal32aOpacity
)

Parameters

CAlfTexture & aTexture
TReal32 aOpacity

SetActionButtonMargin(TReal32)

IMPORT_C voidSetActionButtonMargin(TReal32aMargin)

Parameters

TReal32 aMargin

SetActionButtonSize(TReal32, TReal32)

IMPORT_C voidSetActionButtonSize(TReal32aWidth,
TReal32aHeight
)

Parameters

TReal32 aWidth
TReal32 aHeight

SetBackgroundColorL(const TRgb &)

IMPORT_C voidSetBackgroundColorL(const TRgb &aColor)

Parameters

const TRgb & aColor

SetBackgroundImageL(CAlfTexture &)

IMPORT_C voidSetBackgroundImageL(CAlfTexture &aTexture)

Parameters

CAlfTexture & aTexture

SetBackgroundOpacity(const TAlfTimedValue &)

IMPORT_C voidSetBackgroundOpacity(const TAlfTimedValue &aOpacity)

Parameters

const TAlfTimedValue & aOpacity

SetCurrentHotspotByCharL(TInt)

IMPORT_C voidSetCurrentHotspotByCharL(TIntaIndex)

Parameters

TInt aIndex

SetCurrentHotspotByOrderL(TInt, TBool)

IMPORT_C voidSetCurrentHotspotByOrderL(TIntaIndex,
TBoolaFocusLine = EFalse
)

Parameters

TInt aIndex
TBool aFocusLine = EFalse

SetCursorDelay(TInt)

IMPORT_C voidSetCursorDelay(TIntaDelay)

Parameters

TInt aDelay

SetCustomKeys(CFsTextViewerKeys *)

IMPORT_C voidSetCustomKeys(CFsTextViewerKeys *aKeys)

Parameters

CFsTextViewerKeys * aKeys

SetLeftMargin(TInt)

IMPORT_C voidSetLeftMargin(TIntaMargin)

Parameters

TInt aMargin

SetLiteLineBg(CAlfTexture &, TReal32)

IMPORT_C voidSetLiteLineBg(CAlfTexture &aTexture,
TReal32aOpacity
)

Parameters

CAlfTexture & aTexture
TReal32 aOpacity

SetMirroring(TBool)

IMPORT_C voidSetMirroring(TBoolaEnable = ETrue)

Parameters

TBool aEnable = ETrue

SetObserver(MFsTextViewerObserver *)

IMPORT_C voidSetObserver(MFsTextViewerObserver *aObserver)

Parameters

MFsTextViewerObserver * aObserver

SetPartBgColorL(TInt, TInt, const TRgb &)

IMPORT_C voidSetPartBgColorL(TIntaStartChar,
TIntaEndChar,
const TRgb &aColor
)

Parameters

TInt aStartChar
TInt aEndChar
const TRgb & aColor

SetPartBgImageL(TInt, TInt, CAlfTexture &)

IMPORT_C voidSetPartBgImageL(TIntaStartChar,
TIntaEndChar,
CAlfTexture &aTexture
)

Parameters

TInt aStartChar
TInt aEndChar
CAlfTexture & aTexture

SetPictureSize(TSize)

IMPORT_C voidSetPictureSize(TSizeaSize)

Parameters

TSize aSize

SetRightMargin(TInt)

IMPORT_C voidSetRightMargin(TIntaMargin)

Parameters

TInt aMargin

SetScrollDelay(TInt)

IMPORT_C voidSetScrollDelay(TIntaDelay)

Parameters

TInt aDelay

SetScrollOffsetInLines(TInt)

IMPORT_C voidSetScrollOffsetInLines(TIntaLineOffset)

Parameters

TInt aLineOffset

SetScrollOffsetInPx(TInt)

IMPORT_C voidSetScrollOffsetInPx(TIntaPxOffset)

Parameters

TInt aPxOffset

SetSmileySize(TSize)

IMPORT_C voidSetSmileySize(TSizeaSize)

Parameters

TSize aSize

SetTextL(CFsRichText *, CFsSmileyDictionary *)

IMPORT_C voidSetTextL(CFsRichText *aText,
CFsSmileyDictionary *aSmDict
)

Parameters

CFsRichText * aText
CFsSmileyDictionary * aSmDict

SetWatermarkL(CFsTextViewerWatermark *)

IMPORT_C voidSetWatermarkL(CFsTextViewerWatermark *aWatermark)

Parameters

CFsTextViewerWatermark * aWatermark

Show()

IMPORT_C voidShow()

ShowActionButtonForCurrentHighlightedHotspotL()

IMPORT_C voidShowActionButtonForCurrentHighlightedHotspotL()

Smileys()

IMPORT_C TBoolSmileys()

UpdateStatusLayout()

IMPORT_C voidUpdateStatusLayout()

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.