AxSpeechEvent Class Reference
[Basic AxTk UI classes]

A class holding information about a speech event. More...

#include <ax/ax_speech.h>

List of all members.

Public Member Functions

 AxSpeechEvent ()
 AxSpeechEvent (const wxString &eventType, const wxString &text=wxEmptyString, int verbosityLevel=0)
 AxSpeechEvent (const AxSpeechEvent &event)
void Init ()
void Copy (const AxSpeechEvent &event)
virtual wxEvent * Clone () const
void SetSpeechEventType (const wxString &eventType)
const wxString & GetSpeechEventType () const
void SetText (const wxString &text)
const wxString & GetText () const
void SetVerbosityLevel (int level)
 Set the verbosity of the event.
int GetVerbosityLevel () const
void SetVerbosityPolicy (int level)
 Sets the current verbosity policy.
int GetVerbosityPolicy () const
void SetNavigationHint (AxNavigationHint hint)
int GetNavigationHint () const
void PurgeSpeech ()
void PurgeAllSpeech ()
bool GetPurgeSpeech () const
bool GetPurgeAllSpeech () const
void SetFlags (int flags)
int GetFlags () const
void SetMenu (AxMenu *menu)
AxMenuGetMenu () const
void SetMenuItem (AxMenuItem *item)
AxMenuItemGetMenuItem () const
AxSpeechChannel GetChannel () const

Protected Attributes

wxString m_speechEventType
wxString m_text
int m_verbosityLevel
int m_verbosityPolicy
int m_flags
AxNavigationHint m_navigationHint

Detailed Description

A class holding information about a speech event.

Currently these events are not processed in the same way as wxWidgets events, but we derive from wxNotifyEvent in case we allow convention event processing in the future.

Constructor & Destructor Documentation

AxSpeechEvent::AxSpeechEvent (  )  [inline]

AxSpeechEvent::AxSpeechEvent ( const wxString &  eventType,
const wxString &  text = wxEmptyString,
int  verbosityLevel = 0 
) [inline]

AxSpeechEvent::AxSpeechEvent ( const AxSpeechEvent event  )  [inline]

Member Function Documentation

virtual wxEvent* AxSpeechEvent::Clone (  )  const [inline, virtual]

void AxSpeechEvent::Copy ( const AxSpeechEvent event  ) 

AxSpeechChannel AxSpeechEvent::GetChannel (  )  const [inline]

int AxSpeechEvent::GetFlags (  )  const [inline]

AxMenu* AxSpeechEvent::GetMenu (  )  const [inline]

AxMenuItem* AxSpeechEvent::GetMenuItem (  )  const [inline]

int AxSpeechEvent::GetNavigationHint (  )  const [inline]

bool AxSpeechEvent::GetPurgeAllSpeech (  )  const [inline]

bool AxSpeechEvent::GetPurgeSpeech (  )  const [inline]

const wxString& AxSpeechEvent::GetSpeechEventType (  )  const [inline]

const wxString& AxSpeechEvent::GetText (  )  const [inline]

int AxSpeechEvent::GetVerbosityLevel (  )  const [inline]

int AxSpeechEvent::GetVerbosityPolicy (  )  const [inline]

void AxSpeechEvent::Init (  ) 

void AxSpeechEvent::PurgeAllSpeech (  )  [inline]

void AxSpeechEvent::PurgeSpeech (  )  [inline]

void AxSpeechEvent::SetFlags ( int  flags  )  [inline]

void AxSpeechEvent::SetMenu ( AxMenu menu  )  [inline]

void AxSpeechEvent::SetMenuItem ( AxMenuItem item  )  [inline]

void AxSpeechEvent::SetNavigationHint ( AxNavigationHint  hint  )  [inline]

void AxSpeechEvent::SetSpeechEventType ( const wxString &  eventType  )  [inline]

void AxSpeechEvent::SetText ( const wxString &  text  )  [inline]

void AxSpeechEvent::SetVerbosityLevel ( int  level  )  [inline]

Set the verbosity of the event.

This will be compared with the current verbosity level in AxSpeech, to see whether it's applicable. The lower the verbosity level in the event, the more chance it has of being spoken. The default is zero, which means the event will not be ruled out immediately but will be considered on its own merits inside the speech event handler.

void AxSpeechEvent::SetVerbosityPolicy ( int  level  )  [inline]

Sets the current verbosity policy.

By default, this is -1 and will be set to the current global setting. This can be set to a specific value in order to specify the level of detail (for example describing the current context in lesser or greater detail).

Member Data Documentation

int AxSpeechEvent::m_flags [protected]

wxString AxSpeechEvent::m_speechEventType [protected]

wxString AxSpeechEvent::m_text [protected]

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

Generated on Wed May 6 19:22:08 2009 for AxTk by  doxygen 1.5.8