AxHelpProvider Class Reference
[Basic AxTk UI classes]

A help provider class building on wxSimpleHelpProvider, but voicing the help as well as showing it. More...

#include <ax/ax_help_provider.h>

List of all members.

Public Member Functions
	AxHelpProvider (AxSpeech *speech=NULL)
	~AxHelpProvider ()
void	Init ()
wxString	GetWindowOrAdapterHelp (const wxWindowBase *window)
virtual wxString	GetHelp (const wxWindowBase *window)
virtual bool	ShowHelp (wxWindowBase *window)
AxSpeech *	GetSpeech () const
void	SetSpeech (AxSpeech *speech)
Static Public Member Functions
static void	SetHelpWindow (wxWindow *helpWindow)
static void	CleanUp ()
	Clean up dialog.
Public Attributes
AxSpeech *	m_speech
Static Public Attributes
static wxWindow *	sm_helpWindow = NULL
static wxWindow *	sm_invokedFrom = NULL

---

Detailed Description

A help provider class building on wxSimpleHelpProvider, but voicing the help as well as showing it.

Use a line like this to set the help provider in your application initialisation code:

    wxHelpProvider::Set(new AxHelpProvider(& GetViewManager().GetSpeech()));

See the wxWidgets manual for more on wxHelpProvider.

This class uses its own tip window implementation, since the default wxTipWindow class is not very flexible and because it's based on a frame, causes unnecessarily focus setting and therefore repeated control description. In contrast, AxHtmlToolTip uses wxPopupWindow where possible. It can also support more interesting text.

---

Constructor & Destructor Documentation

AxHelpProvider::AxHelpProvider

(

AxSpeech *

speech = NULL

)

AxHelpProvider::~AxHelpProvider

(

)

---

Member Function Documentation

void AxHelpProvider::CleanUp

(

)

[static]

Clean up dialog.

wxString AxHelpProvider::GetHelp

(

const wxWindowBase *

window

)

[virtual]

AxSpeech* AxHelpProvider::GetSpeech

(

)

const [inline]

wxString AxHelpProvider::GetWindowOrAdapterHelp

(

const wxWindowBase *

window

)

void AxHelpProvider::Init

(

)

static void AxHelpProvider::SetHelpWindow

(

wxWindow *

helpWindow

)

[inline, static]

void AxHelpProvider::SetSpeech

(

AxSpeech *

speech

)

[inline]

bool AxHelpProvider::ShowHelp

(

wxWindowBase *

window

)

[virtual]

---

Member Data Documentation

AxSpeech* AxHelpProvider::m_speech

wxWindow * AxHelpProvider::sm_helpWindow = NULL [static]

wxWindow * AxHelpProvider::sm_invokedFrom = NULL [static]

---

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

• include/ax/ax_help_provider.h
• src/ax/ax_help_provider.cpp