Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::Wizard

VCF::Wizard Class Reference

A Wizard is used to disaplay a UI in a wizard dialog. More...

#include <vcf/ApplicationKit/Wizard.h>

Inheritance diagram for VCF::Wizard:

VCF::Interface List of all members.

Public Member Functions

virtual ~Wizard ()
virtual String getName ()=0
 returns the name of the Wizard in human readable format
virtual uint32 getNumberOfSteps ()=0
virtual String getStepTitle (const uint32 &step)=0
 Returns a string used in the Title area.
virtual String getStepDescription (const uint32 &step)=0
 Returns a string used in the Description area.
virtual Image * getStepImage (const uint32 &step, const Size &dimensions)=0
 returns a new Image object for the Image area - callers responsibility to clean this up.
virtual Control * getStepPage (const uint32 &step)=0
 returns a page to display
virtual Size getStepPreferredDimensions (const uint32 &step)=0
virtual void finish ()=0

Detailed Description

A Wizard is used to disaplay a UI in a wizard dialog.

The layout of the dialog looks like this: 

	+-------------------------------------------------+
	|	TITLE                                  +----+ |
	|                                          |    | <----Image here
	|		Description                        +----+ |
	+-------------------------------------------------+
	|                                                 |
	|                                                 |
	|                                                 |
	|                                                 |
	|                                                 |
	|                 Wizard UI                       |
	|                                                 |
	|                                                 |
	|                                                 |
	+-------------------------------------------------+
	|                                                 |
	|            <<Back next>="">>    Finish    Cancel |
	|                                                 |
	+-------------------------------------------------+

Constructor & Destructor Documentation

virtual VCF::Wizard::~Wizard (   )  [inline, virtual]
 

Member Function Documentation

virtual void VCF::Wizard::finish (   )  [pure virtual]
 

virtual String VCF::Wizard::getName (   )  [pure virtual]
 

returns the name of the Wizard in human readable format

virtual uint32 VCF::Wizard::getNumberOfSteps (   )  [pure virtual]
 

virtual String VCF::Wizard::getStepDescription (  const uint32 &  step  )  [pure virtual]
 

Returns a string used in the Description area.

virtual Image* VCF::Wizard::getStepImage (  const uint32 &  step,
const Size &  dimensions
)  [pure virtual]
 

returns a new Image object for the Image area - callers responsibility to clean this up.

The Image returned MUST have dimensions equal to or less than those specified in the dimensions parameter

Parameters:
Size dimensions the maximum dimensions of the image

virtual Control* VCF::Wizard::getStepPage (  const uint32 &  step  )  [pure virtual]
 

returns a page to display

virtual Size VCF::Wizard::getStepPreferredDimensions (  const uint32 &  step  )  [pure virtual]
 

virtual String VCF::Wizard::getStepTitle (  const uint32 &  step  )  [pure virtual]
 

Returns a string used in the Title area.

The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information