1 files changed, 85 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/dialogs/XWizardController.idl b/offapi/com/sun/star/ui/dialogs/XWizardController.idl
new file mode 100644
index 000000000000..6a51a67360fe
--- /dev/null
+++ b/offapi/com/sun/star/ui/dialogs/XWizardController.idl
@@ -0,0 +1,85 @@
+/*************************************************************************
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_ui_dialogs_XWizardController_idl__
+#define __com_sun_star_ui_dialogs_XWizardController_idl__
+
+#include <com/sun/star/ui/dialogs/XWizardPage.idl>
+
+//==================================================================================================================
+
+module com { module sun { module star { module ui { module dialogs {
+
+//==================================================================================================================
+
+/** is the interface of a client-provided controller of a custom <type>Wizard</type>.
+ */
+interface XWizardController
+{
+    /** creates a page
+
+        <p>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.</p>
+
+        @param ParentWindow
+            the parent window to use for the page window
+        @param PageId
+            the ID of the page.
+        @return
+            the requested page.
+    */
+    XWizardPage createPage( [in] ::com::sun::star::awt::XWindow ParentWindow, [in] short PageId );
+
+    /** provides the title of a page given by ID
+
+        <p>The page titles are displayed in the wizard's roadmap.</p>
+    */
+    string  getPageTitle( [in] short PageId );
+
+    boolean canAdvance();
+
+    /** called when a new page in the wizard is being activated
+    */
+    void    onActivatePage( [in] short PageId );
+
+    /** called when a page in the wizard is being deactivated
+    */
+    void    onDeactivatePage( [in] short PageId );
+
+    /** called when the wizard is about to be finished.
+
+        <p>This method allows the controller to do any final checks, and ultimatively veto finishing the wizard.</p>
+    */
+    boolean confirmFinish();
+};
+
+//==================================================================================================================
+
+}; }; }; }; };
+
+//==================================================================================================================
+
+#endif