Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: ui :: dialogs ::

interface XWizardController
Description
is the interface of a client-provided controller of a custom Wizard.

Methods' Summary
createPage creates a page  
getPageTitle provides the title of a page given by ID  
canAdvance  
onActivatePage called when a new page in the wizard is being activated  
onDeactivatePage called when a page in the wizard is being deactivated  
confirmFinish called when the wizard is about to be finished.  
Methods' Details
createPage
XWizardPage
createPage( [in] ::com::sun::star::awt::XWindow  ParentWindow,
[in] short  PageId );

Description
creates a page

Wizard pages are created on demand, when the respective page is reached during traveling through the wizard. Effectively, this means the method is called at most once for each possible page ID.

Parameter ParentWindow
the parent window to use for the page window
Parameter PageId
the ID of the page.
Returns
the requested page.
getPageTitle
string
getPageTitle( [in] short  PageId );

Description
provides the title of a page given by ID

The page titles are displayed in the wizard's roadmap.

canAdvance
boolean
canAdvance();

onActivatePage
void
onActivatePage( [in] short  PageId );

Description
called when a new page in the wizard is being activated
onDeactivatePage
void
onDeactivatePage( [in] short  PageId );

Description
called when a page in the wizard is being deactivated
confirmFinish
boolean
confirmFinish();

Description
called when the wizard is about to be finished.

This method allows the controller to do any final checks, and ultimatively veto finishing the wizard.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.