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

FXEX::FXWizardPage Class Reference

FXWizardPage : One of the screens in an FXWizard dialog. More...

#include <FXWizardPage.h>

Inheritance diagram for FXEX::FXWizardPage::

FXPacker List of all members.

Public Methods

 FXWizardPage (FXWizardDialog *wizard, FXImage *image=NULL, FXWizardPage *prev=NULL, FXWizardPage *next=NULL, FXuint opts=FRAME_NONE)
void setPrev (FXWizardPage *prev)
void setNext (FXWizardPage *next)
virtual FXWizardPage * getPrev () const
virtual FXWizardPage * getNext () const
virtual bool transferDataFromPage ()
virtual FXImage * getImage ()
void enableFocus ()
void disableFocus ()
FXbool canFocus ()
virtual ~FXWizardPage ()

Detailed Description

FXWizardPage : One of the screens in an FXWizard dialog.

FXWizardPage is one of the screens in an FXWizardDialog: it must know what are the following and preceding pages (which may be NULL for the first/last page). Except for this extra knowledge, FXWizardPage is just a FXPacker, so the controls may be placed directly on it in the usual way.

Definition at line 49 of file FXWizardPage.h.


Constructor & Destructor Documentation

FXEX::FXWizardPage::FXWizardPage FXWizardDialog * wizard,
FXImage * image = NULL,
FXWizardPage * prev = NULL,
FXWizardPage * next = NULL,
FXuint opts = FRAME_NONE
 

FXWizardPage Selector Types.

Constructor for a FXWizardPage.

Parameters:
wizard   The FXWizardDialog to which this page will belong.
image   The image to display on the left of the page. This should be a user image or one the default image types.
prev   The FXWizardPage that is to be shown if the <PREV> button on the wizard is pressed when this page is active.
next   The FXWizardPage that is to be shown if the <NEXT> button on the wizard is pressed when this page is active.

virtual FXEX::FXWizardPage::~FXWizardPage [inline, virtual]
 

dtor.

Definition at line 129 of file FXWizardPage.h.


Member Function Documentation

void FXEX::FXWizardPage::setPrev FXWizardPage * prev [inline]
 

Sets the previous page.

Definition at line 88 of file FXWizardPage.h.

void FXEX::FXWizardPage::setNext FXWizardPage * next [inline]
 

Sets the next page.

Definition at line 91 of file FXWizardPage.h.

virtual FXWizardPage* FXEX::FXWizardPage::getPrev const [inline, virtual]
 

Get the page which should be shown when the user chooses the "Prev" button.

Definition at line 94 of file FXWizardPage.h.

virtual FXWizardPage* FXEX::FXWizardPage::getNext const [inline, virtual]
 

Get the page which should be shown when the user chooses the "Next" button.

Definition at line 97 of file FXWizardPage.h.

virtual bool FXEX::FXWizardPage::transferDataFromPage [inline, virtual]
 

Used to test the validity of the user input.

By default, it just returns TRUE. You should normally override this function in your own code if validity checking is required.

Definition at line 103 of file FXWizardPage.h.

virtual FXImage* FXEX::FXWizardPage::getImage [inline, virtual]
 

This method is called by FXWizardDialog to get the image to display alongside the page.

If the image was not explicitly set (i.e. if FXNullImage is returned), the default image for the wizard should be used. If FXEmptyImage is returned, then no image should be displayed for the page.

The only cases when you would want to override this function is if the page image depends dynamically on the user choices, i.e. almost never.

Definition at line 115 of file FXWizardPage.h.

void FXEX::FXWizardPage::enableFocus [inline]
 

Used by the wizard to enable the controls on this page to receive focus.

Definition at line 118 of file FXWizardPage.h.

void FXEX::FXWizardPage::disableFocus [inline]
 

Used by the wizard to disable the controls on this page from receiving focus.

Normally done when the page is not the current one being displayed.

Definition at line 123 of file FXWizardPage.h.

FXbool FXEX::FXWizardPage::canFocus [inline]
 

returns whether the controls on this page can receive focus or not.

Definition at line 126 of file FXWizardPage.h.