AxTextInputDialog Class Reference
[Basic AxTk UI classes]

A class for getting textual input from the user. More...

#include <ax/ax_textinputdialog.h>

List of all members.

Public Member Functions

 AxTextInputDialog ()
 Constructors.
 AxTextInputDialog (wxWindow *parent, const wxString &message, const wxString &caption, const wxString &defaultValue, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=SYMBOL_AXTEXTINPUTDIALOG_STYLE)
bool Create (wxWindow *parent, const wxString &message, const wxString &caption, const wxString &defaultValue, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=SYMBOL_AXTEXTINPUTDIALOG_STYLE)
 Creation.
 ~AxTextInputDialog ()
 Destructor.
void Init ()
 Initialises member variables.
void CreateControls (const wxString &defaultValue, const wxString &message)
 Creates the controls and sizers.
wxString GetValue () const
void SetValue (const wxString &value)
wxString GetDescription () const
void SetDescription (const wxString &descr)
void SetSpeech (AxSpeech *speech)
AxSpeechGetSpeech () const
void SetShortcutManager (wxShortcutManager *shortcuts)
void SpeakCurrentText (bool initialView=false)
void OnInitDialog (wxInitDialogEvent &event)
 wxEVT_INIT_DIALOG event handler for wxID_ANY
void OnAnyTextUpdated (wxCommandEvent &event)
 wxEVT_COMMAND_TEXT_UPDATED event handler for wxID_ANY
void OnChar (wxKeyEvent &event)
 wxEVT_CHAR event handler for wxID_ANY
wxBitmap GetBitmapResource (const wxString &name)
 Retrieves bitmap resources.
wxIcon GetIconResource (const wxString &name)
 Retrieves icon resources.

Static Public Member Functions

static bool ShowToolTips ()
 Should we show tooltips?

Public Attributes

wxStaticText * m_descriptionCtrl
AxTextCtrlm_valueCtrl
wxString m_value
wxString m_description
AxSpeechm_speech
bool m_disableEvents


Detailed Description

A class for getting textual input from the user.

Constructor & Destructor Documentation

AxTextInputDialog::AxTextInputDialog (  ) 

Constructors.

AxTextInputDialog::AxTextInputDialog ( wxWindow *  parent,
const wxString &  message,
const wxString &  caption,
const wxString &  defaultValue,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
long  style = SYMBOL_AXTEXTINPUTDIALOG_STYLE 
)

AxTextInputDialog::~AxTextInputDialog (  ) 

Destructor.


Member Function Documentation

bool AxTextInputDialog::Create ( wxWindow *  parent,
const wxString &  message,
const wxString &  caption,
const wxString &  defaultValue,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
long  style = SYMBOL_AXTEXTINPUTDIALOG_STYLE 
)

Creation.

void AxTextInputDialog::CreateControls ( const wxString &  defaultValue,
const wxString &  message 
)

Creates the controls and sizers.

wxBitmap AxTextInputDialog::GetBitmapResource ( const wxString &  name  ) 

Retrieves bitmap resources.

wxString AxTextInputDialog::GetDescription (  )  const [inline]

wxIcon AxTextInputDialog::GetIconResource ( const wxString &  name  ) 

Retrieves icon resources.

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

wxString AxTextInputDialog::GetValue (  )  const [inline]

void AxTextInputDialog::Init (  ) 

Initialises member variables.

void AxTextInputDialog::OnAnyTextUpdated ( wxCommandEvent &  event  ) 

wxEVT_COMMAND_TEXT_UPDATED event handler for wxID_ANY

wxEVT_COMMAND_TEXT_UPDATED event handler for wxID_ANY

void AxTextInputDialog::OnChar ( wxKeyEvent &  event  ) 

wxEVT_CHAR event handler for wxID_ANY

wxEVT_CHAR event handler for wxID_ANY

void AxTextInputDialog::OnInitDialog ( wxInitDialogEvent &  event  ) 

wxEVT_INIT_DIALOG event handler for wxID_ANY

void AxTextInputDialog::SetDescription ( const wxString &  descr  )  [inline]

void AxTextInputDialog::SetShortcutManager ( wxShortcutManager shortcuts  ) 

void AxTextInputDialog::SetSpeech ( AxSpeech speech  ) 

void AxTextInputDialog::SetValue ( const wxString &  value  )  [inline]

bool AxTextInputDialog::ShowToolTips (  )  [static]

Should we show tooltips?

void AxTextInputDialog::SpeakCurrentText ( bool  initialView = false  ) 


Member Data Documentation


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