Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members

FXEX::FXWizardDialog Class Reference

FXWizardDialog : Adds support for Windows like wizard dialogs. More...

#include <FXWizardDialog.h>

Inheritance diagram for FXEX::FXWizardDialog::

FXDialogBox List of all members.

Public Types

enum  {
  ID_WIZARD_PREV = FXDialogBox::ID_LAST,
  ID_WIZARD_NEXT,
  ID_WIZARD_CANCEL,
  ID_WIZARD_HELP,
  ID_LAST
}

Public Methods

 FXWizardDialog (FXApp *app, const FXString &name, FXImage *image=NULL, FXPoint position=FXPlacementScreen, FXint padding=DEFAULT_PAD)
 FXWizardDialog (FXWindow *owner, const FXString &name, FXImage *image=NULL, FXPoint position=FXPlacementScreen, FXint padding=DEFAULT_PAD)
void create ()
int run (FXWizardPage *startPage)
void move (FXuint x, FXuint y)
void move (FXPoint pos)
virtual ~FXWizardDialog ()

Static Public Methods

void chain (FXWizardPage *first,...)

Public Attributes

FXArray< FXWizardPage *> pageArray

Detailed Description

FXWizardDialog : Adds support for Windows like wizard dialogs.

FXWizardDialog is the central class for implementing 'wizard-like' dialogs. These dialogs are mostly familiar to Windows users and are nothing else but a sequence of 'pages' each of them displayed inside a dialog which has the buttons to pass to the next (and previous) pages.

The wizards are typically used to decompose a complex dialog into several simple steps and are mainly useful to the novice users, hence it is important to keep them as simple as possible.

To show a wizard dialog, you must first create an object of FXWizardDialog class. Then you should add all pages you want the wizard to show and then call FXWizardDialog::run.

Definition at line 59 of file FXWizardDialog.h.


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
ID_WIZARD_PREV   This message is sent to the wizard when the <NEXT> button is selected.
ID_WIZARD_NEXT  
ID_WIZARD_CANCEL   This message is sent to the wizard when the <HELP> button is selected.

This message is sent to the wizard when the <CANCEL> button is selected, and, if the wizard contains a title bar, when the user selects [X].

ID_WIZARD_HELP  
ID_LAST  

Definition at line 63 of file FXWizardDialog.h.


Constructor & Destructor Documentation

FXEX::FXWizardDialog::FXWizardDialog FXApp * app,
const FXString & name,
FXImage * image = NULL,
FXPoint position = FXPlacementScreen,
FXint padding = DEFAULT_PAD
 

Construct a free-floating FXWizardDialog dialog. This is the construtor to use if creating a dialog-based FXWizardDialog application.

Parameters:
app   The application object.
name   The name of the wizard which will be display on the title bar
image   The default image to display on the left of the pages. This should be a user image or one the default image types.
position   A FXPoint location on the display where the wizard will will be displayed. The value can be an explicit FXPoint or one of the default placement types.
padding   The padding between the different components in the FXWizardDialog.

FXEX::FXWizardDialog::FXWizardDialog FXWindow * owner,
const FXString & name,
FXImage * image = NULL,
FXPoint position = FXPlacementScreen,
FXint padding = DEFAULT_PAD
 

Construct a model FXWizardDialog dialog which will always float over the owner window.

Parameters:
owner   The parent window to which the wizard is owned by.
name   The name of the wizard which will be display on the title bar
image   The default image to display on the left of the pages. This should be a user image or one the default image types.
position   A FXPoint location on the display where the wizard will will be displayed. The value can be an explicit FXPoint or one of the default placement types.
padding   The padding between the different components in the FXWizardDialog.

virtual FXEX::FXWizardDialog::~FXWizardDialog [virtual]
 

dtor.


Member Function Documentation

void FXEX::FXWizardDialog::create
 

Create the server side resources for the wizard.

int FXEX::FXWizardDialog::run FXWizardPage * startPage
 

Executes the wizard starting from the given page, returns TRUE if it was successfully finished or FALSE if user cancelled it.

The first Page can not be NULL.

void FXEX::FXWizardDialog::move FXuint x,
FXuint y
 

Moves the wizard window to a specific location.

This can be called anytime before FXWizardDialog::run()

void FXEX::FXWizardDialog::move FXPoint pos
 

Moves the wizard window to a specific location.

This can be called anytime before FXWizardDialog::run()

void FXEX::FXWizardDialog::chain FXWizardPage * first,
...
[static]
 

A convenience function to make the pages follow each other.

A NULL value should terminate the list.


Member Data Documentation

FXArray<FXWizardPage*> FXEX::FXWizardDialog::pageArray
 

Called when the <NEXT>, <PREV>, and <FINISH>(last page only) is pressed. Called when the <CANCEL> or [X](if toolbar is active) is pressed. Called when the <HELP> button is pressed.

Holds an array of FXWizard pages. This is the only thing that effects portablility(it uses template classes). Therefore future versions may replace this with a more portable method. But for now it works :) This should also be made private and accessed through member functions but i'll save that for later.

Definition at line 96 of file FXWizardDialog.h.