Main Page   Modules   Alphabetical List   Compound List   File List   Compound Members   File Members  

FXWizardPage Class Reference

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

#include <FXWizard.h>

List of all members.

Public Types

enum  { ID_WIZARDPAGE_CHANGED = FXPacker::ID_LAST, ID_WIZARDPAGE_CHANGING, ID_LAST }

Public Methods

 FXWizardPage (FXWizard *wizard, FXImage *image=FXNullImage, FXWizardPage *prev=(FXWizardPage *) NULL, FXWizardPage *next=(FXWizardPage *) NULL, FXuint opts=FRAME_NONE)
virtual long onPageChanging (FXObject *, FXSelector, void *ptr)
virtual long onPageChanged (FXObject *, FXSelector, void *ptr)
virtual long onPageCancel (FXObject *, FXSelector, void *ptr)
virtual long onPageHelp (FXObject *, FXSelector, void *ptr)
long onFocusNext (FXObject *sender, FXSelector sel,void *ptr)
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 ()

Protected Methods

 FXWizardPage ()

Protected Attributes

FXImage * _pageImage


Detailed Description

One of the screens in an FXWizard dialog.

FXWizardPage is one of the screens in an FXWizard: 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.


Member Enumeration Documentation

anonymous enum
 

FXWizardPage Selector Types.

Enumeration values:
ID_WIZARDPAGE_CHANGED 
ID_WIZARDPAGE_CHANGING 
ID_LAST 


Constructor & Destructor Documentation

FXWizardPage::FXWizardPage   [inline, protected]
 

FXWizardPage::FXWizardPage FXWizard   wizard,
FXImage *    image = FXNullImage,
FXWizardPage *    prev = (FXWizardPage *)NULL,
FXWizardPage *    next = (FXWizardPage *)NULL,
FXuint    opts = FRAME_NONE
 

Constructor for a FXWizardPage.

Parameters:
wizard  The FXWizard 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.


Member Function Documentation

FXbool FXWizardPage::canFocus   [inline]
 

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

void 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.

void FXWizardPage::enableFocus   [inline]
 

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

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

This method is called by FXWizard 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.

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

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

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

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

long FXWizardPage::onFocusNext FXObject *    sender,
FXSelector    sel,
void *    ptr
 

Used to enable focus only for the current page. Not overridable.

virtual long FXWizardPage::onPageCancel FXObject *   ,
FXSelector   ,
void *    ptr
[inline, virtual]
 

Override this to process input from a wizard dialog when the user attemps to cancel the wizard

virtual long FXWizardPage::onPageChanged FXObject *   ,
FXSelector   ,
void *    ptr
[inline, virtual]
 

Override this to process input from a wizard dialog after the current page has changed.

virtual long FXWizardPage::onPageChanging FXObject *   ,
FXSelector   ,
void *    ptr
[inline, virtual]
 

Override this to process input from a wizard dialog before the current page is changed.

virtual long FXWizardPage::onPageHelp FXObject *   ,
FXSelector   ,
void *    ptr
[inline, virtual]
 

Override this to process input from a wizard dialog when the <HELP> button is pressed.

void FXWizardPage::setNext FXWizardPage *    next [inline]
 

Sets the next page.

void FXWizardPage::setPrev FXWizardPage *    prev [inline]
 

Sets the previous page.

virtual bool 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.


Member Data Documentation

FXImage* FXWizardPage::_pageImage [protected]
 

image displayed to the left of this page when current.


The documentation for this class was generated from the following file:
Generated on Fri Mar 8 09:33:38 2002 by doxygen1.2.13 written by Dimitri van Heesch, © 1997-2001