Symbian^3 Product Developer Library >

CTtsParsedText Class Reference

class CTtsParsedText : public CBase

Class to store parsed text for TTS.

nssttscommon.lib
Since
2.8

Inherits from

Public Member Functions
~CTtsParsedText()
IMPORT_C voidAddSegmentL(const TTtsSegment &, TInt)
IMPORT_C voidDeleteSegmentL(TInt)
IMPORT_C TBoolIsValid()
IMPORT_C CTtsParsedText *NewL(const TDesC &, const TDesC8 &, const TDesC &)
IMPORT_C TIntNumberOfSegments()
IMPORT_C const TDesC &PhonemeNotation()
IMPORT_C const TDesC8 &PhonemeSequence()
IMPORT_C const TTtsSegment &SegmentL(TInt)
IMPORT_C voidSetPhonemeNotationL(const TDesC &)
IMPORT_C voidSetPhonemeSequenceL(const TDesC8 &)
IMPORT_C voidSetTextL(const TDesC &)
IMPORT_C const TDesC &Text()
Private Member Functions
CTtsParsedText()
voidConstructL(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 voidAddSegmentL(const TTtsSegment &aSegment,
TIntaIndex =  KMaxTInt
)
Adds new segment and takes its ownership.
Since
2.8

Parameters

const TTtsSegment & aSegmentA 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 &)

voidConstructL(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 voidDeleteSegmentL(TIntaIndex)
Deletes a segment
Since
2.8

Parameters

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

IsValid()

IMPORT_C TBoolIsValid()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 TIntNumberOfSegments()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(TIntaIndex)const
Returns segment from given index
Since
2.8

Parameters

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

SetPhonemeNotationL(const TDesC &)

IMPORT_C voidSetPhonemeNotationL(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 & aPhonemeNotationPhoneme notation.

SetPhonemeSequenceL(const TDesC8 &)

IMPORT_C voidSetPhonemeSequenceL(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 & aPhonemeSequencePhoneme sequence.

SetTextL(const TDesC &)

IMPORT_C voidSetTextL(const TDesC &aText)
Sets a text. The descriptor is copied and can be released after the function call.
Since
2.8

Parameters

const TDesC & aTextText.

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]

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.