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

checkbox_wizardpage Class Reference

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

#include <checkbox_wizardpage.h>

Inheritance diagram for checkbox_wizardpage:

wxWizardPageSimple List of all members.

Public Methods

  checkbox_wizardpage (wxWizard *parent, const wxArrayString message_string_array, const wxString &checkbox_label=wxEmptyString, bool is_checked=FALSE, wxBitmap bitmap=wxNullBitmap)
  Constructor.

  ~checkbox_wizardpage ()
  Destructor.

bool  get_checkbox_value ()
  Get the value of the checkbox.


Detailed Description

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

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


Constructor & Destructor Documentation

checkbox_wizardpage::checkbox_wizardpage wxWizard   parent,
const wxArrayString    message_string_array,
const wxString &    checkbox_label = wxEmptyString,
bool    is_checked = FALSE,
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.
checkbox_label  The label displayed beside the checkbox.
is_checked  TRUE if the the checkbox should be checked initially.
bitmap  Optional bitmap to show instead of the one the parent wizard is using.

Member Function Documentation

bool checkbox_wizardpage::get_checkbox_value  
 

Get the value of the checkbox.

Returns :
TRUE if the checkbox is checked.