provides a framework for implementing a wizard dialog. More...
import"Wizard.idl";
Inheritance diagram for Wizard:
Public Member Functions | |
| createSinglePathWizard ([in] sequence< short > PageIds, [in] XWizardController Controller) raises ( ::com::sun::star::lang::IllegalArgumentException ) | |
| creates a wizard with a single execution path More... | |
| createMultiplePathsWizard ([in] sequence< sequence< short > > PageIds, [in] XWizardController Controller) raises ( ::com::sun::star::lang::IllegalArgumentException ) | |
| creates a wizard with a multiple possible execution paths More... | |
 Public Member Functions inherited from XWizard | |
| XWizardPage | getCurrentPage () |
| provides access to the current page of the wizard More... | |
| void | enableButton ([in] short WizardButton, [in] boolean Enable) |
| enables or disables a certain button in the wizard More... | |
| void | setDefaultButton ([in] short WizardButton) |
| sets a button in the wizard as default button More... | |
| boolean | travelNext () |
| travels to the next page, if possible More... | |
| boolean | travelPrevious () |
| travels to the next page, if possible More... | |
| void | enablePage ([in] short PageID, [in] boolean Enable) raises ( ::com::sun::star::container::NoSuchElementException , ::com::sun::star::util::InvalidStateException ) |
| enables or disables the given page More... | |
| void | updateTravelUI () |
| updates the wizard elements which are related to traveling. More... | |
| boolean | advanceTo ([in] short PageId) |
| advances to the given page, if possible. More... | |
| boolean | goBackTo ([in] short PageId) |
| goes back to the given page, if possible. More... | |
| void | activatePath ([in] short PathIndex, [in] boolean Final) raises ( ::com::sun::star::container::NoSuchElementException , ::com::sun::star::util::InvalidStateException ) |
| activates a path More... | |
| Public Member Functions inherited from XExecutableDialog | |
| void | setTitle ([in] string aTitle) |
| Sets the title of the dialog. More... | |
| short | execute () |
| Executes (shows) the dialog. More... | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
Additional Inherited Members | |
| Exported Interfaces inherited from XWizard | |
| interface | XExecutableDialog |
| Public Attributes inherited from XWizard | |
| string | HelpURL |
| is the help URL of the wizard's main window. More... | |
| ::com::sun::star::awt::XWindow | DialogWindow |
Detailed Description
provides a framework for implementing a wizard dialog.
- Since
- OOo 3.3
Member Function Documentation
◆ createMultiplePathsWizard()
| createMultiplePathsWizard | ( | [in] sequence< sequence< short > > | PageIds, |
| [in] XWizardController | Controller | ||
| ) | |||
| raises | ( | ::com::sun::star::lang::IllegalArgumentException | |
| ) | |||
creates a wizard with a multiple possible execution paths
- Parameters
-
PageIds the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order. Controller the wizard controller.
◆ createSinglePathWizard()
| createSinglePathWizard | ( | [in] sequence< short > | PageIds, |
| [in] XWizardController | Controller | ||
| ) | |||
| raises | ( | ::com::sun::star::lang::IllegalArgumentException | |
| ) | |||
creates a wizard with a single execution path
- Parameters
-
PageIds the IDs of the pages which constitute the execution path. IDs must be in ascending order. Controller the wizard controller.
The documentation for this service was generated from the following file:
- com/sun/star/ui/dialogs/Wizard.idl
