ADMBaseWizPage Class Reference
Base class for ADM Wizard Page dialogs. More...
#include <ADMBaseWizDialog.h>
Inherits ADMBaseDialog.
Inherited by ADMLicenseWizPage.
Public Member Functions | |
| ADMBaseWizPage (const char *pName, ASInt32 uID) | |
| Page constructor; page is not created until the wizard needs it. | |
| virtual void | OnBtnClicked (ASInt32 nID) |
| Called when the user clicks a notification button. | |
Protected Member Functions | |
| ADMBaseWizDialog * | GetWizard () |
| Retrieves the parent wizard. | |
| virtual bool | OnKillActive () |
| Called when the page is to be replaced; can cancel the operation. | |
| virtual int | GetNextPage () |
| Called to retrieve the number of the next page to be displayed by the wizard. | |
| virtual int | GetPrevPage () |
| Called to retrieve the number of the previous page to be displayed by the wizard. | |
| virtual ASErr | OnInitDialog () |
| Called when the dialog is initialized. | |
| virtual void | OnDialogNotify (ADMNotifierRef inNotifier) |
| Called when a dialog notification is sent; used to keep track of the dialog location on the screen. | |
Protected Attributes | |
| ADMBaseWizDialog * | m_pWizard |
| Pointer to the parent wizard. | |
| ASRect | m_rectBounds |
| Location of the dialog; used to initialize the replacement page in the same place. | |
Friends | |
| class | ADMBaseWizDialog |
Detailed Description
Base class for ADM Wizard Page dialogs.
Definition at line 35 of file ADMBaseWizDialog.h.
Constructor & Destructor Documentation
| ADMBaseWizPage::ADMBaseWizPage | ( | const char * | pName, | |
| ASInt32 | uID | |||
| ) | [inline] |
Page constructor; page is not created until the wizard needs it.
- Parameters:
-
pName Unique name of page dialog uID ID of the page resource
Definition at line 44 of file ADMBaseWizDialog.h.
References m_rectBounds.
Member Function Documentation
| virtual int ADMBaseWizPage::GetNextPage | ( | ) | [inline, protected, virtual] |
Called to retrieve the number of the next page to be displayed by the wizard.
- Returns:
- -1 to display the next page in the original order, any other number to display that page
Reimplemented in ADMWizLicenseTypePage, and ADMWizSamplePage.
Definition at line 80 of file ADMBaseWizDialog.h.
| virtual int ADMBaseWizPage::GetPrevPage | ( | ) | [inline, protected, virtual] |
Called to retrieve the number of the previous page to be displayed by the wizard.
- Returns:
- -1 to display the previous page in the original order, any other number to display that page
Reimplemented in ADMWizJurisdicationPage, ADMWizSummeryPage, and ADMWizSamplePage.
Definition at line 85 of file ADMBaseWizDialog.h.
| ADMBaseWizDialog* ADMBaseWizPage::GetWizard | ( | ) | [inline, protected] |
Retrieves the parent wizard.
- Returns:
- Pointer to the parent wizard
Definition at line 62 of file ADMBaseWizDialog.h.
References m_pWizard.
Referenced by ADMWizSummeryPage::OnInitDialog(), ADMWizSamplePage::UpdateControls(), ADMWizJurisdicationPage::UpdateControls(), ADMWizModificationPage::UpdateControls(), ADMWizUsagePage::UpdateControls(), and ADMWizLicenseTypePage::UpdateControls().
| void ADMBaseWizPage::OnBtnClicked | ( | ASInt32 | nID | ) | [virtual] |
Called when the user clicks a notification button.
- Parameters:
-
nID ID of button clicked
Reimplemented from ADMBaseDialog.
Reimplemented in ADMWizLicenseTypePage, ADMWizUsagePage, ADMWizModificationPage, ADMWizJurisdicationPage, and ADMWizSamplePage.
Definition at line 96 of file ADMBaseWizDialog.cpp.
References m_pWizard, and ADMBaseWizDialog::OnWizButton().
| void ADMBaseWizPage::OnDialogNotify | ( | ADMNotifierRef | inNotifier | ) | [protected, virtual] |
Called when a dialog notification is sent; used to keep track of the dialog location on the screen.
- Parameters:
-
inNotifier ADM notification object
Reimplemented from ADMBaseDialog.
Definition at line 83 of file ADMBaseWizDialog.cpp.
References m_rectBounds, and ADMBaseDialog::m_refDialog.
| ASErr ADMBaseWizPage::OnInitDialog | ( | ) | [protected, virtual] |
Called when the dialog is initialized.
- Returns:
- kNoErr if all went well, any other error code if failed
This function adds notification buttons for the prev, next and cancel, and moves the dialog to the proper location if necessary
Reimplemented from ADMBaseDialog.
Reimplemented in ADMWizLicenseTypePage, ADMWizUsagePage, ADMWizModificationPage, ADMWizJurisdicationPage, ADMWizSummeryPage, and ADMWizSamplePage.
Definition at line 44 of file ADMBaseWizDialog.cpp.
References ADMBaseDialog::AddNotifyBtn(), IsRectEmpty(), m_rectBounds, ADMBaseDialog::m_refDialog, and ADMBaseDialog::SetCancelBtn().
| virtual bool ADMBaseWizPage::OnKillActive | ( | ) | [inline, protected, virtual] |
Called when the page is to be replaced; can cancel the operation.
- Returns:
- true to display the new page (default), false to leave this page active
Reimplemented in ADMWizLicenseTypePage, ADMWizUsagePage, ADMWizModificationPage, ADMWizJurisdicationPage, and ADMWizSamplePage.
Definition at line 75 of file ADMBaseWizDialog.h.
The documentation for this class was generated from the following files:
- General/ADMBaseWizDialog.h
- General/ADMBaseWizDialog.cpp
