Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » ui » dialogs

Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

:: 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

---

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

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

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