AxTextEvtHandler Class Reference
[Basic AxTk UI classes]

An event handler that processes events from a wxTextCtrl and speaks, as appropriate. More...

#include <ax/ax_textctrl.h>

Inheritance diagram for AxTextEvtHandler:

AxVoicedEvtHandler

List of all members.

Public Member Functions

 AxTextEvtHandler (wxTextCtrlBase *ctrl=NULL, AxSpeech *speech=NULL)
 ~AxTextEvtHandler ()
void Init ()
virtual wxString GetControlName ()
 Override to return the name of the control.
virtual wxString GetControlStateText ()
 Override to return text representing the state of the control, for example the current value.
virtual bool ReadCurrentSentence ()
 Read the current sentence.
virtual bool ReadNextSentence ()
 Read the next sentence.
virtual bool ReadPreviousSentence ()
 Read the previous sentence.
virtual bool ReadCurrentParagraph ()
 Read the current paragraph.
virtual bool ReadPreviousParagraph ()
 Read the previous paragraph.
virtual bool ReadNextParagraph ()
 Read the next paragraph.
virtual bool ReadCurrentWord ()
 Read the current word.
virtual bool ReadPreviousWord ()
 Read the previous word.
virtual bool ReadNextWord ()
 Read the next word.
virtual bool SpellWord ()
 Spell the current word.
virtual bool ReadFromCurrentPosition ()
 Read from the current position.
virtual bool ReadFromStart ()
 Read from the start.
virtual bool DescribeContext ()
 Describe current context.
void SetTextCtrl (wxTextCtrlBase *ctrl)
wxTextCtrlBase * GetTextCtrl () const
bool GetWord (long currentPos, long &from, long &to, wxString &value)
bool GetSentence (long currentPos, long &from, long &to, wxString &value)
bool GetParagraph (long currentPos, long &from, long &to, wxString &value)
long FindNextWordPosition (long currentPos, int direction)
long FindNextSentencePosition (long currentPos, int direction)
long FindNextParagraphPosition (long currentPos, int direction)
bool EatWhitespace (long &pos)
wxChar GetChar (long pos)
void OnReadCurrentWord (wxCommandEvent &event)
void OnReadNextWord (wxCommandEvent &event)
void OnReadPreviousWord (wxCommandEvent &event)
void OnReadCurrentSentence (wxCommandEvent &event)
void OnReadNextSentence (wxCommandEvent &event)
void OnReadPreviousSentence (wxCommandEvent &event)
void OnReadCurrentParagraph (wxCommandEvent &event)
void OnReadNextParagraph (wxCommandEvent &event)
void OnReadPreviousParagraph (wxCommandEvent &event)
void OnReadFromHere (wxCommandEvent &event)
void OnReadAll (wxCommandEvent &event)
void OnDescribeContext (wxCommandEvent &event)

Protected Attributes

wxTextCtrlBase * m_textCtrl


Detailed Description

An event handler that processes events from a wxTextCtrl and speaks, as appropriate.

Constructor & Destructor Documentation

AxTextEvtHandler::AxTextEvtHandler ( wxTextCtrlBase *  ctrl = NULL,
AxSpeech speech = NULL 
) [inline]

AxTextEvtHandler::OnReadNextWord AxTextEvtHandler::OnReadCurrentSentence AxTextEvtHandler::OnReadPreviousSentence AxTextEvtHandler::OnReadNextParagraph AxTextEvtHandler::OnReadFromHere AxTextEvtHandler::OnDescribeContext AxTextEvtHandler::OnPauseResumeSpeech AxTextEvtHandler::~AxTextEvtHandler (  ) 


Member Function Documentation

bool AxTextEvtHandler::DescribeContext (  )  [virtual]

Describe current context.

bool AxTextEvtHandler::EatWhitespace ( long &  pos  ) 

long AxTextEvtHandler::FindNextParagraphPosition ( long  currentPos,
int  direction 
)

long AxTextEvtHandler::FindNextSentencePosition ( long  currentPos,
int  direction 
)

long AxTextEvtHandler::FindNextWordPosition ( long  currentPos,
int  direction 
)

wxChar AxTextEvtHandler::GetChar ( long  pos  ) 

wxString AxTextEvtHandler::GetControlName (  )  [virtual]

Override to return the name of the control.

Implements AxVoicedEvtHandler.

wxString AxTextEvtHandler::GetControlStateText (  )  [virtual]

Override to return text representing the state of the control, for example the current value.

Implements AxVoicedEvtHandler.

bool AxTextEvtHandler::GetParagraph ( long  currentPos,
long &  from,
long &  to,
wxString &  value 
)

bool AxTextEvtHandler::GetSentence ( long  currentPos,
long &  from,
long &  to,
wxString &  value 
)

wxTextCtrlBase* AxTextEvtHandler::GetTextCtrl (  )  const [inline]

bool AxTextEvtHandler::GetWord ( long  currentPos,
long &  from,
long &  to,
wxString &  value 
)

void AxTextEvtHandler::Init (  ) 

Reimplemented from AxVoicedEvtHandler.

void AxTextEvtHandler::OnDescribeContext ( wxCommandEvent &  event  ) 

Reimplemented from AxVoicedEvtHandler.

void AxTextEvtHandler::OnReadAll ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadCurrentParagraph ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadCurrentSentence ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadCurrentWord ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadFromHere ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadNextParagraph ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadNextSentence ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadNextWord ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadPreviousParagraph ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadPreviousSentence ( wxCommandEvent &  event  ) 

void AxTextEvtHandler::OnReadPreviousWord ( wxCommandEvent &  event  ) 

bool AxTextEvtHandler::ReadCurrentParagraph (  )  [virtual]

Read the current paragraph.

bool AxTextEvtHandler::ReadCurrentSentence (  )  [virtual]

Read the current sentence.

bool AxTextEvtHandler::ReadCurrentWord (  )  [virtual]

Read the current word.

bool AxTextEvtHandler::ReadFromCurrentPosition (  )  [virtual]

Read from the current position.

bool AxTextEvtHandler::ReadFromStart (  )  [virtual]

Read from the start.

bool AxTextEvtHandler::ReadNextParagraph (  )  [virtual]

Read the next paragraph.

bool AxTextEvtHandler::ReadNextSentence (  )  [virtual]

Read the next sentence.

bool AxTextEvtHandler::ReadNextWord (  )  [virtual]

Read the next word.

bool AxTextEvtHandler::ReadPreviousParagraph (  )  [virtual]

Read the previous paragraph.

bool AxTextEvtHandler::ReadPreviousSentence (  )  [virtual]

Read the previous sentence.

bool AxTextEvtHandler::ReadPreviousWord (  )  [virtual]

Read the previous word.

void AxTextEvtHandler::SetTextCtrl ( wxTextCtrlBase *  ctrl  )  [inline]

bool AxTextEvtHandler::SpellWord (  )  [virtual]

Spell the current word.


Member Data Documentation

wxTextCtrlBase* AxTextEvtHandler::m_textCtrl [protected]


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

Generated on Thu Apr 23 13:14:00 2009 for AxTk by  doxygen 1.5.8