wxTTSTransformer Class Reference
[Text to speech classes]

A class for applying various transformations to text before it is sent to the speech engine. More...

#include <tts/tts.h>

List of all members.

Public Member Functions
	wxTTSTransformer ()
virtual	~wxTTSTransformer ()
void	AddString (const wxString &word, const wxString &replacement)
	Add a string.
void	InsertString (const wxString &word, const wxString &replacement, int pos)
	Insert string before this one.
void	RemoveString (const wxString &word)
	Remove a string.
void	RemoveString (size_t i)
wxString	GetString (const wxString &word)
	Get a string.
bool	HasString (const wxString &word)
	Has string.
virtual void	Clear ()
	Clear.
virtual void	Index ()
	Index the strings.
virtual bool	TransformString (const wxString &input, wxString &output, int options=wxTTS_TRANSFORM_OPTIONS_WORD_SUBSTITUTION)
	Do transformations in a text string.
virtual bool	TransformFile (const wxString &filename, const wxString &newFilename, int options=wxTTS_TRANSFORM_OPTIONS_WORD_SUBSTITUTION)
	Do transformations in a text file.
virtual bool	SaveFile (const wxString &filename)
	Save the table to a file.
virtual bool	LoadFile (const wxString &filename)
	Load the table from a file.
virtual bool	ConvertFormat (const wxString &filename, wxOutputStream &rawStream, wxTextOutputStream &stream, int options)
	Convert from one format to another, e.g. text to XML, or HTML to text.
virtual bool	ConvertHTMLToText (const wxString &filename, wxOutputStream &rawStream, wxTextOutputStream &stream, int options)
	Convert HTML to text, SAPI XML or SSML.
virtual bool	ConvertTextToXML (const wxString &filename, wxOutputStream &rawStream, wxTextOutputStream &stream, int options)
	Convert plain text to SAPI XML or SSML.
wxArrayString &	GetStrings ()
	Get words.
wxArrayString &	GetReplacements ()
bool	HasStrings () const
	Are their strings?
void	SetDirty (bool dirty)
	Set dirty flag - if true, needs indexing.
bool	GetDirty () const
void	SetModified (bool mod=true)
	Set modified flag - if true, needs saving.
bool	GetModified () const
void	SetUsageDescription (const wxString &descr)
	Set a summary of how to use the table, preferably in simplified HTML.
wxString	GetUsageDescription () const
	Get a summary of how to use the table, preferably in simplified HTML.
Static Public Member Functions
static bool	ReplaceChar (wxString &str, const wxChar &ch1, const wxChar &ch2)
	Replace character with another character.
Protected Attributes
wxArrayString	m_strings
wxArrayString	m_replacements
wxTTSStringHashMap	m_hashMap
bool	m_dirty
bool	m_modified
wxString	m_usageDescription

---

Detailed Description

A class for applying various transformations to text before it is sent to the speech engine.

---

Constructor & Destructor Documentation

wxTTSTransformer::wxTTSTransformer

(

)

wxTTSTransformer::~wxTTSTransformer

(

)

[virtual]

---

Member Function Documentation

void wxTTSTransformer::AddString	(	const wxString &	word,
		const wxString &	replacement
	)

Add a string.

void wxTTSTransformer::Clear

(

)

[virtual]

Clear.

bool wxTTSTransformer::ConvertFormat	(	const wxString &	filename,
		wxOutputStream &	rawStream,
		wxTextOutputStream &	stream,
		int	options
	)			[virtual]

Convert from one format to another, e.g. text to XML, or HTML to text.

virtual bool wxTTSTransformer::ConvertHTMLToText	(	const wxString &	filename,
		wxOutputStream &	rawStream,
		wxTextOutputStream &	stream,
		int	options
	)			[virtual]

Convert HTML to text, SAPI XML or SSML.

virtual bool wxTTSTransformer::ConvertTextToXML	(	const wxString &	filename,
		wxOutputStream &	rawStream,
		wxTextOutputStream &	stream,
		int	options
	)			[virtual]

Convert plain text to SAPI XML or SSML.

bool wxTTSTransformer::GetDirty

(

)

const [inline]

bool wxTTSTransformer::GetModified

(

)

const [inline]

wxArrayString& wxTTSTransformer::GetReplacements

(

)

[inline]

wxString wxTTSTransformer::GetString

(

const wxString &

word

)

Get a string.

wxArrayString& wxTTSTransformer::GetStrings

(

)

[inline]

Get words.

wxString wxTTSTransformer::GetUsageDescription

(

)

const [inline]

Get a summary of how to use the table, preferably in simplified HTML.

bool wxTTSTransformer::HasString

(

const wxString &

word

)

Has string.

bool wxTTSTransformer::HasStrings

(

)

const [inline]

Are their strings?

void wxTTSTransformer::Index

(

)

[virtual]

Index the strings.

void wxTTSTransformer::InsertString	(	const wxString &	word,
		const wxString &	replacement,
		int	pos
	)

Insert string before this one.

bool wxTTSTransformer::LoadFile

(

const wxString &

filename

)

[virtual]

Load the table from a file.

void wxTTSTransformer::RemoveString

(

size_t

i

)

void wxTTSTransformer::RemoveString

(

const wxString &

word

)

Remove a string.

bool wxTTSTransformer::ReplaceChar	(	wxString &	str,
		const wxChar &	ch1,
		const wxChar &	ch2
	)			[static]

Replace character with another character.

bool wxTTSTransformer::SaveFile

(

const wxString &

filename

)

[virtual]

Save the table to a file.

void wxTTSTransformer::SetDirty

(

bool

dirty

)

[inline]

Set dirty flag - if true, needs indexing.

void wxTTSTransformer::SetModified

(

bool

mod = true

)

[inline]

Set modified flag - if true, needs saving.

void wxTTSTransformer::SetUsageDescription

(

const wxString &

descr

)

[inline]

Set a summary of how to use the table, preferably in simplified HTML.

bool wxTTSTransformer::TransformFile	(	const wxString &	filename,
		const wxString &	newFilename,
		int	options = wxTTS_TRANSFORM_OPTIONS_WORD_SUBSTITUTION
	)			[virtual]

Do transformations in a text file.

virtual bool wxTTSTransformer::TransformString	(	const wxString &	input,
		wxString &	output,
		int	options = wxTTS_TRANSFORM_OPTIONS_WORD_SUBSTITUTION
	)			[virtual]

Do transformations in a text string.

---

Member Data Documentation

bool wxTTSTransformer::m_dirty [protected]

wxTTSStringHashMap wxTTSTransformer::m_hashMap [protected]

bool wxTTSTransformer::m_modified [protected]

wxArrayString wxTTSTransformer::m_replacements [protected]

wxArrayString wxTTSTransformer::m_strings [protected]

wxString wxTTSTransformer::m_usageDescription [protected]

---

The documentation for this class was generated from the following files:

• include/tts/tts.h
• src/tts/tts.cpp