plucker_wizard_base Class Reference

Base class for all the wizards used in Plucker Desktop. More...

Inheritance diagram for plucker_wizard_base:


Public Methods
	plucker_wizard_base (wxWindow *parent=NULL, int id=-1, const wxString &title=wxEmptyString, const wxBitmap &bitmap=wxNullBitmap, const wxString &cancel_message=_("Abort the wizard?"))
	Constructor.
virtual	~plucker_wizard_base ()
	Destructor.
void	add_wizardpage_to_wizard (wxWizardPageSimple *wizardpage)
	Call this in constructor of derived class to add a wizardpagesimple to the wizard.
bool	run_wizard ()
	Call this after you have created an instance of the wizard.
virtual void	on_finish_button ()=0
	Pure virtuals: what to do when the Finish button was done,.
virtual void	on_help_button (wxWizardEvent &event)=0
	Pure virtual: what to do when the Help button was pressed.

Detailed Description

Base class for all the wizards used in Plucker Desktop.

Cancel buttton shows a dialog with the passed cancel message from the constructor.

plucker_wizard_base::plucker_wizard_base	(	wxWindow *	parent = NULL,
		int	id = -1,
		const wxString &	title = wxEmptyString,
		const wxBitmap &	bitmap = wxNullBitmap,
		const wxString &	cancel_message = _("Abort the wizard?")
	)

Constructor.

Parameters:

parent	The parent window. May be NULL.
title	The title of the wizard.
bitmap	The default bitmap used in the wizard. May be overriden by a page.
cancel_message	The message that appears when user clicks Cancel button.

void plucker_wizard_base::add_wizardpage_to_wizard

(

wizardpage

)

Call this in constructor of derived class to add a wizardpagesimple to the wizard.

Parameters:

wizardpage

The wizardpage to add to the wizard.

virtual void plucker_wizard_base::on_help_button ( wxWizardEvent & event ) [pure virtual]

Pure virtual: what to do when the Help button was pressed.

param event. The wxWizardEvent, can be queried for GetPage() to know what page was visible when clicked help.

bool plucker_wizard_base::run_wizard

(

)

Call this after you have created an instance of the wizard.