1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3*cdf0e10cSrcweir * 4*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 5*cdf0e10cSrcweir * 6*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 7*cdf0e10cSrcweir * 8*cdf0e10cSrcweir * This file is part of OpenOffice.org. 9*cdf0e10cSrcweir * 10*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 11*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 12*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 13*cdf0e10cSrcweir * 14*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 15*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 16*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 18*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 19*cdf0e10cSrcweir * 20*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 21*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 22*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 23*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 24*cdf0e10cSrcweir * 25*cdf0e10cSrcweir ************************************************************************/ 26*cdf0e10cSrcweir 27*cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_XWizardController_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_XWizardController_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#include <com/sun/star/ui/dialogs/XWizardPage.idl> 31*cdf0e10cSrcweir 32*cdf0e10cSrcweir//================================================================================================================== 33*cdf0e10cSrcweir 34*cdf0e10cSrcweirmodule com { module sun { module star { module ui { module dialogs { 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir//================================================================================================================== 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir/** is the interface of a client-provided controller of a custom <type>Wizard</type>. 39*cdf0e10cSrcweir */ 40*cdf0e10cSrcweirpublished interface XWizardController 41*cdf0e10cSrcweir{ 42*cdf0e10cSrcweir /** creates a page 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir <p>Wizard pages are created on demand, when the respective page is reached during traveling through the 45*cdf0e10cSrcweir wizard. Effectively, this means the method is called at most once for each possible page ID.</p> 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir @param ParentWindow 48*cdf0e10cSrcweir the parent window to use for the page window 49*cdf0e10cSrcweir @param PageId 50*cdf0e10cSrcweir the ID of the page. 51*cdf0e10cSrcweir @return 52*cdf0e10cSrcweir the requested page. 53*cdf0e10cSrcweir */ 54*cdf0e10cSrcweir XWizardPage createPage( [in] ::com::sun::star::awt::XWindow ParentWindow, [in] short PageId ); 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir /** provides the title of a page given by ID 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir <p>The page titles are displayed in the wizard's roadmap.</p> 59*cdf0e10cSrcweir */ 60*cdf0e10cSrcweir string getPageTitle( [in] short PageId ); 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir boolean canAdvance(); 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir /** called when a new page in the wizard is being activated 65*cdf0e10cSrcweir */ 66*cdf0e10cSrcweir void onActivatePage( [in] short PageId ); 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir /** called when a page in the wizard is being deactivated 69*cdf0e10cSrcweir */ 70*cdf0e10cSrcweir void onDeactivatePage( [in] short PageId ); 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir /** called when the wizard is about to be finished. 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir <p>This method allows the controller to do any final checks, and ultimatively veto finishing the wizard.</p> 75*cdf0e10cSrcweir */ 76*cdf0e10cSrcweir boolean confirmFinish(); 77*cdf0e10cSrcweir}; 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir//================================================================================================================== 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir}; }; }; }; }; 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir//================================================================================================================== 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir#endif 86