Hildon::WizardDialog Class Reference
[Dialogs]

The WizardDialog dialog provides a guided configuration process. More...

Inheritance diagram for Hildon::WizardDialog:

[legend]

List of all members.

Public Member Functions
virtual	~WizardDialog ()
HildonWizardDialog*	gobj ()
	Provides access to the underlying C GtkObject.
const HildonWizardDialog*	gobj () const
	Provides access to the underlying C GtkObject.
	WizardDialog (const Glib::ustring& wizard_name, Gtk::Notebook& wizard_notebook)
	Creates a new Hildon::WizardDialog.
	WizardDialog (const Glib::ustring& wizard_name)
	Creates a new Hildon::WizardDialog.
	WizardDialog (Gtk::Window& parent, const Glib::ustring& wizard_name, Gtk::Notebook& wizard_notebook)
	Creates a new Hildon::WizardDialog.
void	set_wizard_notebook (Gtk::Notebook& notebook)
	Sets the Notebook used by the WizardDialog.
Gtk::Notebook*	get_wizard_notebook ()
	Gets the Notebook used by the WizardDialog.
const Gtk::Notebook*	get_wizard_notebook () const
	Gets the Notebook used by the WizardDialog.
void	set_forward_page_func (const sigc::slot<bool, int>& page_func)
	Sets the page forwarding function to be page_func.
void	unset_forward_page_func ()
Related Functions
(Note that these are not member functions.)
Hildon::WizardDialog*	wrap (HildonWizardDialog* object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

The WizardDialog dialog provides a guided configuration process.

The dialog has four standard buttons, previous, next, finish, cancel, and contains several pages with optional icons. Response buttons are dimmed/undimmed automatically and the standard icon is shown/hidden in response to page navigation. The notebook widget provided by users contains the actual wizard pages.

See WizardDialogResponse for the possible responses from Gtk::Dialog::run() and Gtk::Dialog::signal_reponse().

---

Constructor & Destructor Documentation

virtual Hildon::WizardDialog::~WizardDialog

(

)

[virtual]

Hildon::WizardDialog::WizardDialog	(	const Glib::ustring &	wizard_name,
		Gtk::Notebook &	wizard_notebook
	)

Creates a new Hildon::WizardDialog.

Parameters:

	wizard_name	The name of dialog.
	wizard_notebook	The notebook to be shown on the dialog.

Hildon::WizardDialog::WizardDialog

(

const Glib::ustring &

wizard_name

)

[explicit]

Creates a new Hildon::WizardDialog.

Remember to call set_wizard_notebook().

Parameters:

wizard_name

The name of dialog.

Hildon::WizardDialog::WizardDialog	(	Gtk::Window &	parent,
		const Glib::ustring &	wizard_name,
		Gtk::Notebook &	wizard_notebook
	)

Creates a new Hildon::WizardDialog.

Parameters:

	parent	a Gtk::Window.
	wizard_name	The name of dialog.
	wizard_notebook	The notebook to be shown on the dialog.

---

Member Function Documentation

HildonWizardDialog* Hildon::WizardDialog::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

const HildonWizardDialog* Hildon::WizardDialog::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

void Hildon::WizardDialog::set_wizard_notebook

(

Gtk::Notebook &

notebook

)

Sets the Notebook used by the WizardDialog.

Each page in the notebook will be a page in the wizard dialog.

Gtk::Notebook* Hildon::WizardDialog::get_wizard_notebook

(

)

Gets the Notebook used by the WizardDialog.

const Gtk::Notebook* Hildon::WizardDialog::get_wizard_notebook

(

)

const

Gets the Notebook used by the WizardDialog.

void Hildon::WizardDialog::set_forward_page_func

(

const sigc::slot< bool, int > &

page_func

)

Sets the page forwarding function to be page_func.

This function will be used to determine whether it is possible to go to the next page when the user presses the forward button. Setting page_func to 0 wil make the wizard to simply go always to the next page.

Parameters:

	page_func	The Hildon::WizardDialogPageFunc.
	data	User data for page_func.
	destroy	Destroy notifier for data.

void Hildon::WizardDialog::unset_forward_page_func

(

)

---

Friends And Related Function Documentation

Hildon::WizardDialog* wrap	(	HildonWizardDialog *	object,
		bool	take_copy = false
	)			[related]

A Glib::wrap() method for this object.

Parameters:

	object	The C instance.
	take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns:

A C++ instance that wraps this C instance.

---

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

• wizard-dialog.h