1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24#ifndef __com_sun_star_ui_dialogs_XWizardController_idl__ 25#define __com_sun_star_ui_dialogs_XWizardController_idl__ 26 27#include <com/sun/star/ui/dialogs/XWizardPage.idl> 28 29//================================================================================================================== 30 31module com { module sun { module star { module ui { module dialogs { 32 33//================================================================================================================== 34 35/** is the interface of a client-provided controller of a custom <type>Wizard</type>. 36 37 @since OpenOffice 3.3 38 */ 39interface XWizardController 40{ 41 /** creates a page 42 43 <p>Wizard pages are created on demand, when the respective page is reached during traveling through the 44 wizard. Effectively, this means the method is called at most once for each possible page ID.</p> 45 46 @param ParentWindow 47 the parent window to use for the page window 48 @param PageId 49 the ID of the page. 50 @return 51 the requested page. 52 */ 53 XWizardPage createPage( [in] ::com::sun::star::awt::XWindow ParentWindow, [in] short PageId ); 54 55 /** provides the title of a page given by ID 56 57 <p>The page titles are displayed in the wizard's roadmap.</p> 58 */ 59 string getPageTitle( [in] short PageId ); 60 61 boolean canAdvance(); 62 63 /** called when a new page in the wizard is being activated 64 */ 65 void onActivatePage( [in] short PageId ); 66 67 /** called when a page in the wizard is being deactivated 68 */ 69 void onDeactivatePage( [in] short PageId ); 70 71 /** called when the wizard is about to be finished. 72 73 <p>This method allows the controller to do any final checks, and ultimatively veto finishing the wizard.</p> 74 */ 75 boolean confirmFinish(); 76}; 77 78//================================================================================================================== 79 80}; }; }; }; }; 81 82//================================================================================================================== 83 84#endif 85