AxVoicedControlAdapter Class Reference
[Basic AxTk UI classes]

A class that can voice-enable an existing window containing controls, by inserting event handlers. More...

#include <ax/ax_ui_adaptation.h>

List of all members.

Public Member Functions

 AxVoicedControlAdapter (wxWindow *window=NULL, AxSpeech *speech=NULL, wxShortcutManager *shortcutManager=NULL)
 ~AxVoicedControlAdapter ()
void Init ()
virtual bool Adapt (wxWindow *window=NULL)
 Adapt the controls in this window.
virtual bool UndoAdaptation ()
 Restore the controls in this window.
virtual bool AdaptWindow (wxWindow *window, bool recurse=true)
 Adapt a single window, optionally recursing.
virtual bool UnadaptWindow (wxWindow *window, bool recurse=true)
 Unadapt a single window, optionally recursing.
void SetSpeech (AxSpeech *speech)
AxSpeechGetSpeech () const
void SetWindow (wxWindow *win)
wxWindow * GetWindow () const
void SetShortcutManager (wxShortcutManager *shortcutManager)
wxShortcutManagerGetShortcutManager () const
bool IsAdapted () const

Static Public Member Functions

static
AxVoiceAdaptationHandlerArray & 
GetAdaptationHandlers ()
 Returns the array of handlers that can create event handlers for specific windows.
static void AddAdaptationHandler (AxVoiceAdaptationHandler *handler)
 Adds an adaptation handler.
static void InsertAdaptationHandler (AxVoiceAdaptationHandler *handler)
 Inserts an adaptation handler at the front of the list.
static void AddStandardAdaptationHandlers ()
 Adds standard handlers.
static void ClearAdaptationHandlers ()
 Clears the handlers.
static AxVoiceAdaptationHandlerFindAdaptationHandler (wxWindow *window)
 Finds a handler for the given window.
static AxVoicedEvtHandlerFindVoicedEventHandler (wxWindow *window)
 Finds a voice event handler in the given window's event stack.

Protected Attributes

wxWindow * m_window
AxSpeechm_speech
wxShortcutManagerm_shortcutManager
bool m_adapted
wxArrayInt m_adaptedCtrls

Static Protected Attributes

static
AxVoiceAdaptationHandlerArray 
m_voiceAdaptationHandlers


Detailed Description

A class that can voice-enable an existing window containing controls, by inserting event handlers.

You can add an object of this class to your own dialogs and panels.


Constructor & Destructor Documentation

AxVoicedControlAdapter::AxVoicedControlAdapter ( wxWindow *  window = NULL,
AxSpeech speech = NULL,
wxShortcutManager shortcutManager = NULL 
)

AxVoicedControlAdapter::~AxVoicedControlAdapter (  ) 


Member Function Documentation

bool AxVoicedControlAdapter::Adapt ( wxWindow *  window = NULL  )  [virtual]

Adapt the controls in this window.

If window is passed, it becomes the window associated with the adpater.

bool AxVoicedControlAdapter::AdaptWindow ( wxWindow *  window,
bool  recurse = true 
) [virtual]

Adapt a single window, optionally recursing.

static void AxVoicedControlAdapter::AddAdaptationHandler ( AxVoiceAdaptationHandler handler  )  [inline, static]

Adds an adaptation handler.

void AxVoicedControlAdapter::AddStandardAdaptationHandlers (  )  [static]

Adds standard handlers.

void AxVoicedControlAdapter::ClearAdaptationHandlers (  )  [static]

Clears the handlers.

AxVoiceAdaptationHandler * AxVoicedControlAdapter::FindAdaptationHandler ( wxWindow *  window  )  [static]

Finds a handler for the given window.

AxVoicedEvtHandler * AxVoicedControlAdapter::FindVoicedEventHandler ( wxWindow *  window  )  [static]

Finds a voice event handler in the given window's event stack.

static AxVoiceAdaptationHandlerArray& AxVoicedControlAdapter::GetAdaptationHandlers (  )  [inline, static]

Returns the array of handlers that can create event handlers for specific windows.

wxShortcutManager* AxVoicedControlAdapter::GetShortcutManager (  )  const [inline]

AxSpeech* AxVoicedControlAdapter::GetSpeech (  )  const [inline]

wxWindow* AxVoicedControlAdapter::GetWindow (  )  const [inline]

void AxVoicedControlAdapter::Init (  ) 

static void AxVoicedControlAdapter::InsertAdaptationHandler ( AxVoiceAdaptationHandler handler  )  [inline, static]

Inserts an adaptation handler at the front of the list.

bool AxVoicedControlAdapter::IsAdapted (  )  const [inline]

void AxVoicedControlAdapter::SetShortcutManager ( wxShortcutManager shortcutManager  )  [inline]

void AxVoicedControlAdapter::SetSpeech ( AxSpeech speech  )  [inline]

void AxVoicedControlAdapter::SetWindow ( wxWindow *  win  )  [inline]

bool AxVoicedControlAdapter::UnadaptWindow ( wxWindow *  window,
bool  recurse = true 
) [virtual]

Unadapt a single window, optionally recursing.

bool AxVoicedControlAdapter::UndoAdaptation (  )  [virtual]

Restore the controls in this window.


Member Data Documentation

AxVoiceAdaptationHandlerArray AxVoicedControlAdapter::m_voiceAdaptationHandlers [static, protected]

wxWindow* AxVoicedControlAdapter::m_window [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