FX::FXWizard Class Reference

A Wizard widget guides the user through a number of panels in a predefined sequence; each step must be completed before moving on to the next step. More...

#include <FXWizard.h>

Inheritance diagram for FX::FXWizard:

List of all members.

Public Member Functions
	FXWizard (FXApp *a, const FXString &name, FXImage *image, FXuint opts=DECOR_TITLE|DECOR_BORDER|DECOR_RESIZE, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=10, FXint pr=10, FXint pt=10, FXint pb=10, FXint hs=10, FXint vs=10)
	FXWizard (FXWindow *owner, const FXString &name, FXImage *image, FXuint opts=DECOR_TITLE|DECOR_BORDER|DECOR_RESIZE, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=10, FXint pr=10, FXint pt=10, FXint pb=10, FXint hs=10, FXint vs=10)
FXHorizontalFrame *	buttonFrame () const
FXButton *	advanceButton () const
FXButton *	retreatButton () const
FXButton *	finishButton () const
FXButton *	cancelButton () const
FXSwitcher *	getContainer () const
void	setImage (FXImage *img)
FXImage *	getImage () const
FXint	getNumPanels () const
void	setCurrentPanel (FXint index)
FXint	getCurrentPanel () const
virtual void	save (FXStream &store) const
virtual void	load (FXStream &store)
virtual	~FXWizard ()

---

Detailed Description

A Wizard widget guides the user through a number of panels in a predefined sequence; each step must be completed before moving on to the next step.

For example, a Wizard may be used to install software components, and ask various questions at each step in the installation.

---

Constructor & Destructor Documentation

FX::FXWizard::FXWizard	(	FXApp *	a,
		const FXString &	name,
		FXImage *	image,
		FXuint	opts = DECOR_TITLE|DECOR_BORDER|DECOR_RESIZE,
		FXint	x = 0,
		FXint	y = 0,
		FXint	w = 0,
		FXint	h = 0,
		FXint	pl = 10,
		FXint	pr = 10,
		FXint	pt = 10,
		FXint	pb = 10,
		FXint	hs = 10,
		FXint	vs = 10
	)

Construct free-floating Wizard.

FX::FXWizard::FXWizard	(	FXWindow *	owner,
		const FXString &	name,
		FXImage *	image,
		FXuint	opts = DECOR_TITLE|DECOR_BORDER|DECOR_RESIZE,
		FXint	x = 0,
		FXint	y = 0,
		FXint	w = 0,
		FXint	h = 0,
		FXint	pl = 10,
		FXint	pr = 10,
		FXint	pt = 10,
		FXint	pb = 10,
		FXint	hs = 10,
		FXint	vs = 10
	)

Construct Wizard which will always float over the owner window.

virtual FX::FXWizard::~FXWizard

(

)

[virtual]

---

Member Function Documentation

FXHorizontalFrame* FX::FXWizard::buttonFrame

(

)

const [inline]

Return a pointer to the button frame.

FXButton* FX::FXWizard::advanceButton

(

)

const [inline]

Return a pointer to the "Advance" button.

FXButton* FX::FXWizard::retreatButton

(

)

const [inline]

Return a pointer to the "Retreat" button.

FXButton* FX::FXWizard::finishButton

(

)

const [inline]

Return a pointer to the "Finish" button.

FXButton* FX::FXWizard::cancelButton

(

)

const [inline]

Return a pointer to the "Cancel" button.

FXSwitcher* FX::FXWizard::getContainer

(

)

const [inline]

Return the container used as parent for the subpanels.

void FX::FXWizard::setImage

(

FXImage *

img

)

Change the image being displayed.

FXImage* FX::FXWizard::getImage

(

)

const

Return the current image.

FXint FX::FXWizard::getNumPanels

(

)

const

Return number of panels.

void FX::FXWizard::setCurrentPanel

(

FXint

index

)

Bring the child window at index to the top.

FXint FX::FXWizard::getCurrentPanel

(

)

const

Return the index of the child window currently on top.

virtual void FX::FXWizard::save

(

FXStream &

store

)

const [virtual]

Save to stream.

Reimplemented from FX::FXTopWindow.

virtual void FX::FXWizard::load

(

FXStream &

store

)

[virtual]

Load from stream.

Reimplemented from FX::FXTopWindow.