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