AxTextCtrlAdapter 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 AxTextCtrlAdapter:

AxAdapter AxSearchCtrlAdapter

List of all members.

Public Member Functions

 AxTextCtrlAdapter (wxTextCtrlBase *ctrl=NULL, AxSpeech *speech=NULL)
 ~AxTextCtrlAdapter ()
void Init ()
virtual wxString GetName ()
 Override to return the name of the control.
virtual wxString GetStateText (AxContentLevel level)
 Override to return text representing the state of the control, for example the current value.
virtual wxString GetContent (AxContentLevel level)
 Get content.
virtual wxString GetLabel ()
 Override to return the label for the control.
virtual bool UpdateAppearance (int hints)
 Update the appearance - text size, background, etc.
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

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

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


Member Function Documentation

bool AxTextCtrlAdapter::DescribeContext (  )  [virtual]

Describe current context.

bool AxTextCtrlAdapter::EatWhitespace ( long &  pos  ) 

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

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

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

wxChar AxTextCtrlAdapter::GetChar ( long  pos  ) 

wxString AxTextCtrlAdapter::GetContent ( AxContentLevel  level  )  [virtual]

Get content.

Implements AxAdapter.

Reimplemented in AxSearchCtrlAdapter.

virtual wxString AxTextCtrlAdapter::GetLabel (  )  [inline, virtual]

Override to return the label for the control.

Reimplemented from AxAdapter.

wxString AxTextCtrlAdapter::GetName (  )  [virtual]

Override to return the name of the control.

Implements AxAdapter.

Reimplemented in AxSearchCtrlAdapter.

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

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

wxString AxTextCtrlAdapter::GetStateText ( AxContentLevel  level  )  [virtual]

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

Implements AxAdapter.

Reimplemented in AxSearchCtrlAdapter.

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

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

void AxTextCtrlAdapter::Init (  ) 

Reimplemented from AxAdapter.

void AxTextCtrlAdapter::OnDescribeContext ( wxCommandEvent &  event  ) 

Reimplemented from AxAdapter.

void AxTextCtrlAdapter::OnReadAll ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadCurrentParagraph ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadCurrentSentence ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadCurrentWord ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadFromHere ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadNextParagraph ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadNextSentence ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadNextWord ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadPreviousParagraph ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadPreviousSentence ( wxCommandEvent &  event  ) 

void AxTextCtrlAdapter::OnReadPreviousWord ( wxCommandEvent &  event  ) 

bool AxTextCtrlAdapter::ReadCurrentParagraph (  )  [virtual]

Read the current paragraph.

bool AxTextCtrlAdapter::ReadCurrentSentence (  )  [virtual]

Read the current sentence.

bool AxTextCtrlAdapter::ReadCurrentWord (  )  [virtual]

Read the current word.

bool AxTextCtrlAdapter::ReadFromCurrentPosition (  )  [virtual]

Read from the current position.

bool AxTextCtrlAdapter::ReadFromStart (  )  [virtual]

Read from the start.

bool AxTextCtrlAdapter::ReadNextParagraph (  )  [virtual]

Read the next paragraph.

bool AxTextCtrlAdapter::ReadNextSentence (  )  [virtual]

Read the next sentence.

bool AxTextCtrlAdapter::ReadNextWord (  )  [virtual]

Read the next word.

bool AxTextCtrlAdapter::ReadPreviousParagraph (  )  [virtual]

Read the previous paragraph.

bool AxTextCtrlAdapter::ReadPreviousSentence (  )  [virtual]

Read the previous sentence.

bool AxTextCtrlAdapter::ReadPreviousWord (  )  [virtual]

Read the previous word.

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

bool AxTextCtrlAdapter::SpellWord (  )  [virtual]

Spell the current word.

bool AxTextCtrlAdapter::UpdateAppearance ( int  hints  )  [virtual]

Update the appearance - text size, background, etc.

Reimplemented from AxAdapter.


Member Data Documentation

wxTextCtrlBase* AxTextCtrlAdapter::m_textCtrl [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