Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

textctrl_wizardpage Class Reference

A wizard page with a labeled textctrl, and a descriptive message. More...

#include <textctrl_wizardpage.h>

Inheritance diagram for textctrl_wizardpage:

wxWizardPageSimple List of all members.

Public Methods

  textctrl_wizardpage (wxWizard *parent, const wxArrayString message_string_array, const wxString &textctrl_label=wxEmptyString, const wxString &textctrl_value=wxEmptyString, bool entry_required=TRUE, wxBitmap bitmap=wxNullBitmap)
  Constructor.

  ~textctrl_wizardpage ()
  Destructor.

wxString  get_textctrl_value ()
  Get the value of the textctrl.

wxTextCtrl *  get_textctrl () const
  Get a pointer to the textctrl.


Detailed Description

A wizard page with a labeled textctrl, and a descriptive message.

Contains a single textctrl below a custom message. The value of the textctrl can be queried by the wizard parent.


Constructor & Destructor Documentation

textctrl_wizardpage::textctrl_wizardpage wxWizard   parent,
const wxArrayString    message_string_array,
const wxString &    textctrl_label = wxEmptyString,
const wxString &    textctrl_value = wxEmptyString,
bool    entry_required = TRUE,
wxBitmap    bitmap = wxNullBitmap
 

Constructor.

\note: An implementation using a wxString[] for the messages doesn't seem to work, but wxArrayString works fine.

Parameters:
parent  The parent wizard.
message_string_array  An array of strings to use as the message. Each array item is placed on a separate line.
textctrl_label  The label displayed beside the textctrl.
textctrl_value  The initial value of the textctrl.
entry_required  TRUE if an entry is required to go onto the next page.
textctrl_empty_error_message  Message to show to user if textctrl was empty.
textctrl_empty_error_title  Title of the eror dialog.
bitmap  Optional bitmap to show instead of the one the parent wizard is using.

Member Function Documentation

wxTextCtrl* textctrl_wizardpage::get_textctrl   const [inline]
 

Get a pointer to the textctrl.

Returns :
Pointer to the textctrl.
wxString textctrl_wizardpage::get_textctrl_value  
 

Get the value of the textctrl.

Returns :
TRUE The string that user entered into the textctrl.