Collapse all Symbian^3 Application Developer Library

CTtsParsedText Class Reference

class CTtsParsedText : public CBase

Class to store parsed text for TTS.

nssttscommon.lib

Since: 2.8

Inherits from

CTtsParsedText
- CBase

Public Member Functions
	~CTtsParsedText ()
IMPORT_C void	AddSegmentL (const TTtsSegment &, TInt )
IMPORT_C void	DeleteSegmentL ( TInt )
IMPORT_C TBool	IsValid ()
IMPORT_C CTtsParsedText *	NewL (const TDesC &, const TDesC8 &, const TDesC &)
IMPORT_C TInt	NumberOfSegments ()
IMPORT_C const TDesC &	PhonemeNotation ()
IMPORT_C const TDesC8 &	PhonemeSequence ()
IMPORT_C const TTtsSegment &	SegmentL ( TInt )
IMPORT_C void	SetPhonemeNotationL (const TDesC &)
IMPORT_C void	SetPhonemeSequenceL (const TDesC8 &)
IMPORT_C void	SetTextL (const TDesC &)
IMPORT_C const TDesC &	Text ()

Private Member Functions
	CTtsParsedText ()
void	ConstructL (const TDesC &, const TDesC8 &, const TDesC &)

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
CTtsParsedTextBody *	iBody
TAny *	iReserved

Constructor & Destructor Documentation

CTtsParsedText()

CTtsParsedText

(

)

[private]

C++ default constructor.

~CTtsParsedText()

IMPORT_C

~CTtsParsedText

(

)

[virtual]

Destructor.

Member Functions Documentation

AddSegmentL(const TTtsSegment &, TInt)

IMPORT_C void	AddSegmentL	(	const TTtsSegment &	aSegment,
			TInt	aIndex = KMaxTInt
		)

Adds new segment and takes its ownership.

Since: 2.8

Parameters

const TTtsSegment & aSegment	A new segment.
TInt aIndex = KMaxTInt	Index where to add segment. If index is equal or larger than NumberOfSegments(), the segment will be added into end.

ConstructL(const TDesC &, const TDesC8 &, const TDesC &)

void	ConstructL	(	const TDesC &	aText,
			const TDesC8 &	aPhonemeSequence,
			const TDesC &	aPhonemeNotation
		)	[private]

By default Symbian 2nd phase constructor is private.

Parameters

const TDesC & aText
const TDesC8 & aPhonemeSequence
const TDesC & aPhonemeNotation

DeleteSegmentL(TInt)

IMPORT_C void

DeleteSegmentL

(

TInt

aIndex

)

Deletes a segment

Since: 2.8

Parameters

TInt aIndex

The index of segment to be deleted. The index must be 0..NumberOfSegments()-1.

IsValid()

IMPORT_C TBool

IsValid

(

)

const

Checks that the internal structure is valid.

Since: 2.8

NewL(const TDesC &, const TDesC8 &, const TDesC &)

IMPORT_C CTtsParsedText *	NewL	(	const TDesC &	aText = KNullDesC ,
			const TDesC8 &	aPhonemeSequence = KNullDesC8 ,
			const TDesC &	aPhonemeNotation = KNullDesC
		)	[static]

Two-phased constructor.

Since: 2.8

Parameters

const TDesC & aText = KNullDesC	Text to be parsed.
const TDesC8 & aPhonemeSequence = KNullDesC8	Corresponding phoneme sequence. If the sequence is not given, it will be determined automatically.
const TDesC & aPhonemeNotation = KNullDesC	Identifier of phoneme notation. If the descriptor is empty, the TTS engine will use default notation.

NumberOfSegments()

IMPORT_C TInt

NumberOfSegments

(

)

const

Returns the number of segments.

Since: 2.8

PhonemeNotation()

IMPORT_C const TDesC &

PhonemeNotation

(

)

const

Returns phoneme notation definition.

Since: 2.8

PhonemeSequence()

IMPORT_C const TDesC8 &

PhonemeSequence

(

)

const

Returns phoneme sequence.

Since: 2.8

SegmentL(TInt)

IMPORT_C const TTtsSegment &

SegmentL

(

TInt

aIndex

)

const

Returns segment from given index

Since: 2.8

Parameters

TInt aIndex

The index of segment to be returned. The index must be 0..NumberOfSegments()-1.

SetPhonemeNotationL(const TDesC &)

IMPORT_C void

SetPhonemeNotationL

(

const TDesC &

aPhonemeNotation

)

Sets a phoneme notation. The descriptor is copied and can be released after the function call.

Since: 2.8

Parameters

const TDesC & aPhonemeNotation

Phoneme notation.

SetPhonemeSequenceL(const TDesC8 &)

IMPORT_C void

SetPhonemeSequenceL

(

const TDesC8 &

aPhonemeSequence

)

Sets a phoneme sequence. The descriptor is copied and can be released after the function call.

Since: 2.8

Parameters

const TDesC8 & aPhonemeSequence

Phoneme sequence.

SetTextL(const TDesC &)

IMPORT_C void

SetTextL

(

const TDesC &

aText

)

Sets a text. The descriptor is copied and can be released after the function call.

Since: 2.8

Parameters

const TDesC & aText

Text.

Text()

IMPORT_C const TDesC &

Text

(

)

const

Returns text.

Since: 2.8

Member Data Documentation

CTtsParsedTextBody * iBody

CTtsParsedTextBody *

iBody

[private]

TAny * iReserved

TAny *

iReserved

[private]