Symbian^3 Application Developer Library >

CTtsParsedTextBody Class Reference

class CTtsParsedTextBody : public CBase

Class to store parsed text for TTS.

ttscommon.lib
Since
2.8

Inherits from

Public Member Functions
~CTtsParsedTextBody ()
void AddSegmentL (const TTtsSegment &, TInt )
void DeleteSegmentL ( TInt )
TBool IsValid ()
CTtsParsedTextBody * NewL (const TDesC &, const TDesC8 &, const TDesC &)
TInt NumberOfSegments ()
const TDesC & PhonemeNotation ()
const TDesC8 & PhonemeSequence ()
const TTtsSegment & SegmentL ( TInt )
void SetPhonemeNotationL (const TDesC &)
void SetPhonemeSequenceL (const TDesC8 &)
void SetTextL (const TDesC &)
const TDesC & Text ()
Private Member Functions
CTtsParsedTextBody ()
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
HBufC * iPhonemeNotation
HBufC8 * iPhonemeSequence
RArray < TTtsSegment > iSegmentArray
HBufC * iText

Constructor & Destructor Documentation

CTtsParsedTextBody()

CTtsParsedTextBody ( ) [private]

C++ default constructor.

~CTtsParsedTextBody()

~CTtsParsedTextBody ( ) [virtual]

Destructor.

Member Functions Documentation

AddSegmentL(const TTtsSegment &, TInt)

void AddSegmentL ( const TTtsSegment & aSegment,
TInt aIndex
)
Adds new segment and takes its ownership.
Since
2.8

Parameters

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

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)

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()

TBool IsValid ( ) const
Checks that the internal structure is valid.
Since
2.8

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

CTtsParsedTextBody * NewL ( const TDesC & aText,
const TDesC8 & aPhonemeSequence,
const TDesC & aPhonemeNotation
) [static]

Two-phased constructor.

Parameters

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

NumberOfSegments()

TInt NumberOfSegments ( ) const
Returns the number of segments.
Since
2.8

PhonemeNotation()

const TDesC & PhonemeNotation ( ) const
Returns phoneme notation definition.
Since
2.8

PhonemeSequence()

const TDesC8 & PhonemeSequence ( ) const
Returns phoneme sequence.
Since
2.8

SegmentL(TInt)

const TTtsSegment & SegmentL ( TInt aIndex ) const
Returns segment from given index
Since
2.8

Parameters

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

SetPhonemeNotationL(const TDesC &)

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 &)

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 &)

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()

const TDesC & Text ( ) const
Returns text.
Since
2.8

Member Data Documentation

HBufC * iPhonemeNotation

HBufC * iPhonemeNotation [private]

HBufC8 * iPhonemeSequence

HBufC8 * iPhonemeSequence [private]

RArray< TTtsSegment > iSegmentArray

RArray < TTtsSegment > iSegmentArray [private]

HBufC * iText

HBufC * iText [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.