Collapse all Symbian^3 Application Developer Library

CRichBio Class Reference

class CRichBio : public CCoeControl

A UI control used by Smart Messaging Viewers. This control owns an editor, which is capable of viewing rich text content. NOTE! This is only intended for use with the Smart Message Viewers.

Inherits from

CRichBio
- CCoeControl
  - CBase

Nested Classes and Structures

CRichBio::CEdwinSizeObserver

Public Member Functions
	CRichBio ( TRichBioMode )
	~CRichBio ()
IMPORT_C void	AddItemL (const TDesC &, const TDesC &)
IMPORT_C void	ConstructL (const CCoeControl *)
IMPORT_C TRect	CurrentLineRect ()
IMPORT_C CEikRichTextEditor &	Editor ()
IMPORT_C TBool	IsCursorLocation (TMsgCursorLocation)
IMPORT_C TBool	IsEditorBaseMode ()
IMPORT_C CRichBio *	NewL (const CCoeControl *, TRichBioMode )
IMPORT_C void	NotifyViewEvent (TMsgViewEvent, TInt )
TKeyResponse	OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C void	Reset ()
IMPORT_C TInt	ScrollL ( TInt , TMsgScrollDirection)
IMPORT_C void	SetAndGetSizeL ( TSize &)
IMPORT_C TInt	VirtualHeight ()
IMPORT_C TInt	VirtualVisibleTop ()

Private Member Functions
	CRichBio ()
	CRichBio (const CRichBio &)
void	AddItemToRichTextL (const TDesC &, const TDesC &)
void	AppendTextL (const TDesC &, const TCharFormat &, const TCharFormatMask &)
void	ApplyFormat (TCharFormat &, TCharFormatMask &, TBool )
void	ApplyLabelFormat (TCharFormat &, TCharFormatMask &)
void	ApplyValueFormat (TCharFormat &, TCharFormatMask &)
TBool	CacheExists ()
void	CacheItemL (const TDesC &, const TDesC &)
CCoeControl *	ComponentControl ( TInt )
TInt	CountComponentControls ()
void	Draw (const TRect &)
void	LoadFromCacheL ()
void	Panic ( TInt )
void	SizeChanged ()
const CRichBio &	operator= (const CRichBio &)

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()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::ActivateL()
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ConstructFromResourceL(TResourceReader &)
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::FocusChanged(TDrawNow)
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandlePointerEventL(const TPointerEvent &)
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HandleResourceChange(TInt)
	CCoeControl::HasBorder()const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::InputCapabilities()const
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MakeVisible(TBool)
	CCoeControl::MaximumWidth()const
	CCoeControl::MinimumSize()
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionChanged()
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::PrepareForFocusLossL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAdjacent(TInt)
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetContainerWindowL(const CCoeControl &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetDimmed(TBool)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateL(RWriteStream &)const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()

Inherited Enumerations
	CCoeControl:TZoomType

Private Attributes
CMsgExpandableControlEditor *	iEditor
CEdwinSizeObserver *	iEdwinSizeObserver
TBool	iIsFirstItem
CDesC16ArrayFlat *	iLabelCache
const TRichBioMode	iMode
CDesC16ArrayFlat *	iValueCache
TInt	iVirtualHeight

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize

Constructor & Destructor Documentation

CRichBio(TRichBioMode)

IMPORT_C

CRichBio

(

TRichBioMode

aMode

)

Constructor. ConstructL must be called after the container window is get. The type (TRichBioMode) is legacy code and has no effect on the construction or use of the object. Either ERichBioModeEditorBase or ERichBioModeStandard can be used with the same effect

Parameters

TRichBioMode aMode

Either ERichBioModeEditorBase or ERichBioModeStandard

CRichBio()

CRichBio

(

)

[private]

Default constructor prohibited

CRichBio(const CRichBio &)

CRichBio

(

const CRichBio &

aSource

)

[private]

Copy constructor hidden away.

Parameters

const CRichBio & aSource

~CRichBio()

~CRichBio

(

)

Destructor

Member Functions Documentation

AddItemL(const TDesC &, const TDesC &)

IMPORT_C void	AddItemL	(	const TDesC &	aLabel,
			const TDesC &	aValue
		)

Adds a label and value pair. The client does not need to check the length of the strings. This function will wrap strings that are too long.

Parameters

const TDesC & aLabel	text to displayed in label text format.
const TDesC & aValue	text to displayed in text format.

AddItemToRichTextL(const TDesC &, const TDesC &)

void	AddItemToRichTextL	(	const TDesC &	aLabel,
			const TDesC &	aValue
		)	[private]

Appends text to RichText viewer.

Parameters

const TDesC & aLabel	Label text
const TDesC & aValue	value text

AppendTextL(const TDesC &, const TCharFormat &, const TCharFormatMask &)

void	AppendTextL	(	const TDesC &	aText,
			const TCharFormat &	aFormat,
			const TCharFormatMask &	aMask
		)	[private]

Add text to viewer, checks and removes linefeeds and carriage returns

Parameters

const TDesC & aText	text to be added
const TCharFormat & aFormat	Character format
const TCharFormatMask & aMask	Character format mask

ApplyFormat(TCharFormat &, TCharFormatMask &, TBool)

void	ApplyFormat	(	TCharFormat &	aFormat,
			TCharFormatMask &	aMask,
			TBool	aIsLabel
		)	[private]

Applies the format of value and label text to viewer.

Parameters

TCharFormat & aFormat	Character format to be applied.
TCharFormatMask & aMask	Character format mask Determines is the text label or value.
TBool aIsLabel

ApplyLabelFormat(TCharFormat &, TCharFormatMask &)

void	ApplyLabelFormat	(	TCharFormat &	aFormat,
			TCharFormatMask &	aMask
		)	[private]

Applies the format of label text to viewer.

Parameters

TCharFormat & aFormat	Character format to be applied.
TCharFormatMask & aMask	Character format mask

ApplyValueFormat(TCharFormat &, TCharFormatMask &)

void	ApplyValueFormat	(	TCharFormat &	aFormat,
			TCharFormatMask &	aMask
		)	[private]

Applies the format of value text to viewer.

Parameters

TCharFormat & aFormat	Character format to be applied.
TCharFormatMask & aMask	Character format mask

CacheExists()

TBool

CacheExists

(

)

[private]

Checks either cache exists or not.

CacheItemL(const TDesC &, const TDesC &)

void	CacheItemL	(	const TDesC &	aLabel,
			const TDesC &	aValue
		)	[private]

Adds item to cache

Parameters

const TDesC & aLabel	label text
const TDesC & aValue	value text

ComponentControl(TInt)

CCoeControl *

ComponentControl

(

TInt

aIndex

)

const [private, virtual]

Parameters

TInt aIndex

ConstructL(const CCoeControl *)

IMPORT_C void

ConstructL

(

const CCoeControl *

aParent

)

Second phase constructor. The parent control has to have a container window at this stage.

Parameters

const CCoeControl * aParent

The parent control, which has container window.

CountComponentControls()

TInt

CountComponentControls

(

)

const [private, virtual]

CurrentLineRect()

IMPORT_C TRect

CurrentLineRect

(

)

This is needed for scrolling with Editor Base.

Draw(const TRect &)

void

Draw

(

const TRect &

aRect

)

const [private, virtual]

Parameters

const TRect & aRect

Editor()

IMPORT_C CEikRichTextEditor &

Editor

(

)

For accessing the richtext editor. Must not be called before ConstructL has been called.

Exceptions

Panics

if the iEditor is NULL.

IsCursorLocation(TMsgCursorLocation)

IMPORT_C TBool

IsCursorLocation

(

TMsgCursorLocation

aLocation

)

const

Find out if the cursor is at a certain position.

Parameters

TMsgCursorLocation aLocation

indicates either that the cursor is at the topmost position of the control or at the bottom most position.

IsEditorBaseMode()

IMPORT_C TBool

IsEditorBaseMode

(

)

const

Is the editor base mode on.

LoadFromCacheL()

void

LoadFromCacheL

(

)

[private]

Adds items to richtext from cache.

NewL(const CCoeControl *, TRichBioMode)

IMPORT_C CRichBio *	NewL	(	const CCoeControl *	aParent,
			TRichBioMode	aMode
		)	[static]

Two-phased constructor. Constructs the complete object. The parent control has to have a container window at this stage. The type (TRichBioMode) is legacy code and has no effect on the construction or use of the object. Either ERichBioModeEditorBase or ERichBioModeStandard can be used with the same effect

Parameters

const CCoeControl * aParent	The parent control.
TRichBioMode aMode	Either ERichBioModeEditorBase or ERichBioModeStandard

NotifyViewEvent(TMsgViewEvent, TInt)

IMPORT_C void	NotifyViewEvent	(	TMsgViewEvent	aEvent,
			TInt	aParam
		)

Prepares control for viewing.

Since: 3.2

Parameters

TMsgViewEvent aEvent	The event type
TInt aParam	Event related parameters

OfferKeyEventL(const TKeyEvent &, TEventCode)

TKeyResponse	OfferKeyEventL	(	const TKeyEvent &	aKeyEvent,
			TEventCode	aType
		)	[virtual]

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

Panic(TInt)

void

Panic

(

TInt

aPanic

)

[private, static]

panic wrapper

Parameters

TInt aPanic

Reset()

IMPORT_C void

Reset

(

)

Empties the data contents.

ScrollL(TInt, TMsgScrollDirection)

IMPORT_C TInt	ScrollL	(	TInt	aPixelsToScroll,
			TMsgScrollDirection	aDirection
		)

Performs the internal scrolling of control if needed.

Since: 3.2

Parameters

TInt aPixelsToScroll	Amount of pixels to scroll.
TMsgScrollDirection aDirection	Scrolling direction.

SetAndGetSizeL(TSize &)

IMPORT_C void

SetAndGetSizeL

(

TSize &

aSize

)

Returns the preferred size of the control.

Parameters

TSize & aSize

Control may set its preferred size

SizeChanged()

void

SizeChanged

(

)

[private, virtual]

VirtualHeight()

IMPORT_C TInt

VirtualHeight

(

)

Returns the rich text virtual length.

VirtualVisibleTop()

IMPORT_C TInt

VirtualVisibleTop

(

)

Returns the current cursor position. Even in the viewer mode control contains a hidden cursor. This method return its position.

operator=(const CRichBio &)

const CRichBio &

operator=

(

const CRichBio &

aSource

)

[private]

Assignment operator hidden away.

Parameters

const CRichBio & aSource

Member Data Documentation

CMsgExpandableControlEditor * iEditor

CMsgExpandableControlEditor *

iEditor

[private]

CEdwinSizeObserver * iEdwinSizeObserver

CEdwinSizeObserver *

iEdwinSizeObserver

[private]

TBool iIsFirstItem

TBool

iIsFirstItem

[private]

CDesC16ArrayFlat * iLabelCache

CDesC16ArrayFlat *

iLabelCache

[private]

const TRichBioMode iMode

const TRichBioMode

iMode

[private]

CDesC16ArrayFlat * iValueCache

CDesC16ArrayFlat *

iValueCache

[private]

TInt iVirtualHeight

TInt

iVirtualHeight

[private]