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