Collapse all Symbian^3 Product Developer Library

CInlineTextSource Class Reference

class CInlineTextSource : public CBase

Concrete implementation of MTmInlineTextSource, adding an edit observation interface and common infrastructure for managing inline texts

InlineText

Since: 3.2

Inherits from

CInlineTextSource
- CBase

Public Member Functions
	CInlineTextSource()
	~CInlineTextSource()
void	CheckFormattingL(const TTmDocPos &, const TTmDocPos &)
void	ConstructL()
void	EditObserver(TInt, TInt)
TPtrC	GetInlineText(const TTmDocPos &)
TInt	GetNextInlineTextPosition(const TTmDocPos &, TInt, TTmDocPos &)
TBool	HasInlineTextAt(const TTmDocPos &, TPtrC &)

Protected Member Functions
CInlineTextStore *	InlineTextStore()

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
CInlineTextStore *	iInlineTextStore

Constructor & Destructor Documentation

CInlineTextSource()

CInlineTextSource

(

)

~CInlineTextSource()

~CInlineTextSource

(

)

Member Functions Documentation

CheckFormattingL(const TTmDocPos &, const TTmDocPos &)

void	CheckFormattingL	(	const TTmDocPos &	aFrom,
			const TTmDocPos &	aTo
		)	[virtual]

Framework method to inform subclasses what part of the document is currently being interrogated for inline edits. Currently this will be where formatting is performed and the store of inline texts updated. (In future, an edit observer interface of some kind will be used to trigger that)

Empty implementation as all "when to format policy" is determined by sub-classes. However, this class implements so that sub-classes only have to implement what they need.

Parameters

const TTmDocPos & aFrom	position from which to re-consider the formatting
const TTmDocPos & aTo	position up to which to re-consider the formatting

ConstructL()

void

ConstructL

(

)

2nd state constructor

EditObserver(TInt, TInt)

void	EditObserver	(	TInt	aStart,
			TInt	aExtent
		)	[virtual]

See medobsrv.h

This class implements an empty implementation of this method. Implement in subclass only if action is to be taken upon edit - and if edit event is actually going to be supplied, which is only available in the context of CEikRichTextEditor

Empty implementation as all upon-edit policy is determined by sub-classes. However, this class implements so that sub-classes only have to implement what they need.

Parameters

TInt aStart
TInt aExtent

GetInlineText(const TTmDocPos &)

TPtrC

GetInlineText

(

const TTmDocPos &

aAt

)

[virtual]

Gets a view of the text to be inserted at aAt.

See inlinetext.h

Parameters

const TTmDocPos & aAt

GetNextInlineTextPosition(const TTmDocPos &, TInt, TTmDocPos &)

TInt	GetNextInlineTextPosition	(	const TTmDocPos &	aFrom,
			TInt	aMaxLength,
			TTmDocPos &	aNext
		)	[virtual]

Reports the next position into which inline text should be inserted

See inlinetext.h

Parameters

const TTmDocPos & aFrom
TInt aMaxLength
TTmDocPos & aNext

HasInlineTextAt(const TTmDocPos &, TPtrC &)

TBool	HasInlineTextAt	(	const TTmDocPos &	aAt,
			TPtrC &	aPtrFound
		)	const

Non-virtual method for checking for inline text. Similar behaviour to GetInlineText, except that is it const, and will not panic (but just return EFalse) if there is no inline text at the input TTmDocPos.

Parameters

const TTmDocPos & aAt	Position at which to access inline text
TPtrC & aPtrFound	This contains the inline text if ETrue is returned

InlineTextStore()

CInlineTextStore *

InlineTextStore

(

)

const [protected]

Access to the inline text store for derived classes

Member Data Documentation

CInlineTextStore * iInlineTextStore

CInlineTextStore *

iInlineTextStore

[private]