wxTTSExternalCommandHandler Class Reference

#include <tts/tts_process.h>

Inheritance diagram for wxTTSExternalCommandHandler:

wxTTSHandler wxTTSCepstralHandler wxTTSEspeakHandler List of all members.

Public Member Functions

 wxTTSExternalCommandHandler (const wxString &id, const wxString &displayName)
 ~wxTTSExternalCommandHandler ()
void Init ()
 Member initialisation.
virtual bool Initialize ()
 Initialize the engine. Can call multiple times.
virtual bool Uninitialize ()
 Clean up the engine. Can call multiple times.
virtual bool IsSpeaking () const
 Is it speaking?
virtual bool Stop ()
 Stop speaking.
virtual bool Launch (const wxString &cmd, int options)
 Launch command.
virtual bool VoicesAreCompatible (const wxString &voice1, const wxString &voice2) const
 The voice names can be the same.
void SetLastCommand (const wxString &command)
 Set/get the last command.
wxString GetLastCommand () const
 Get last command, if using external command.
void SetErrorCode (int errorCode)
 Set/get the error code.
int GetErrorCode () const
void SetPID (long pid)
 Set/get the process id.
long GetPID () const
void SetOutput (const wxArrayString &output)
 Set/get the output from the command.
const wxArrayString & GetOutput () const
virtual bool ProcessInput ()
 Process any pending input.
virtual void WriteOutput (const wxString &output)
 Add a line of output.
void SetProcess (wxTTSExternalCommandHandlerProcess *process)
 Set/get process.
wxTTSExternalCommandHandlerProcessGetProcess () const

Static Public Member Functions

static bool IsStopping ()
 Cannot safely start engine while another is in a yield loop, so test this and fail if necessary.

Protected Attributes

wxString m_command
wxArrayString m_output
int m_errorCode
wxTTSExternalCommandHandlerProcessm_process
long m_pid

Static Protected Attributes

static int sm_stopping

Constructor & Destructor Documentation

wxTTSExternalCommandHandler::wxTTSExternalCommandHandler ( const wxString &  id,
const wxString &  displayName 
)

wxTTSExternalCommandHandler::~wxTTSExternalCommandHandler (  ) 


Member Function Documentation

void wxTTSExternalCommandHandler::Init (  ) 

Member initialisation.

Reimplemented from wxTTSHandler.

Reimplemented in wxTTSCepstralHandler, and wxTTSEspeakHandler.

virtual bool wxTTSExternalCommandHandler::Initialize (  )  [inline, virtual]

Initialize the engine. Can call multiple times.

Reimplemented from wxTTSHandler.

Reimplemented in wxTTSCepstralHandler, and wxTTSEspeakHandler.

virtual bool wxTTSExternalCommandHandler::Uninitialize (  )  [inline, virtual]

Clean up the engine. Can call multiple times.

Reimplemented from wxTTSHandler.

Reimplemented in wxTTSCepstralHandler, and wxTTSEspeakHandler.

virtual bool wxTTSExternalCommandHandler::IsSpeaking (  )  const [inline, virtual]

Is it speaking?

Implements wxTTSHandler.

Reimplemented in wxTTSCepstralHandler, and wxTTSEspeakHandler.

bool wxTTSExternalCommandHandler::Stop (  )  [virtual]

Stop speaking.

Implements wxTTSHandler.

bool wxTTSExternalCommandHandler::Launch ( const wxString &  cmd,
int  options 
) [virtual]

Launch command.

virtual bool wxTTSExternalCommandHandler::VoicesAreCompatible ( const wxString &  voice1,
const wxString &  voice2 
) const [virtual]

The voice names can be the same.

void wxTTSExternalCommandHandler::SetLastCommand ( const wxString &  command  )  [inline]

Set/get the last command.

wxString wxTTSExternalCommandHandler::GetLastCommand (  )  const [inline, virtual]

Get last command, if using external command.

Reimplemented from wxTTSHandler.

void wxTTSExternalCommandHandler::SetErrorCode ( int  errorCode  )  [inline]

Set/get the error code.

Reimplemented from wxTTSHandler.

int wxTTSExternalCommandHandler::GetErrorCode (  )  const [inline]

Reimplemented from wxTTSHandler.

void wxTTSExternalCommandHandler::SetPID ( long  pid  )  [inline]

Set/get the process id.

long wxTTSExternalCommandHandler::GetPID (  )  const [inline]

void wxTTSExternalCommandHandler::SetOutput ( const wxArrayString &  output  )  [inline]

Set/get the output from the command.

const wxArrayString& wxTTSExternalCommandHandler::GetOutput (  )  const [inline]

bool wxTTSExternalCommandHandler::ProcessInput (  )  [virtual]

Process any pending input.

Reimplemented from wxTTSHandler.

virtual void wxTTSExternalCommandHandler::WriteOutput ( const wxString &  output  )  [inline, virtual]

Add a line of output.

void wxTTSExternalCommandHandler::SetProcess ( wxTTSExternalCommandHandlerProcess process  )  [inline]

Set/get process.

wxTTSExternalCommandHandlerProcess* wxTTSExternalCommandHandler::GetProcess (  )  const [inline]

static bool wxTTSExternalCommandHandler::IsStopping (  )  [inline, static]

Cannot safely start engine while another is in a yield loop, so test this and fail if necessary.


Member Data Documentation

wxString wxTTSExternalCommandHandler::m_command [protected]

wxArrayString wxTTSExternalCommandHandler::m_output [protected]

int wxTTSExternalCommandHandler::m_errorCode [protected]

Reimplemented from wxTTSHandler.

wxTTSExternalCommandHandlerProcess* wxTTSExternalCommandHandler::m_process [protected]

long wxTTSExternalCommandHandler::m_pid [protected]

int wxTTSExternalCommandHandler::sm_stopping [static, protected]


The documentation for this class was generated from the following files:
Generated on Wed May 6 19:20:23 2009 for AxTk by  doxygen 1.5.1