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_XWizardPage_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_ui_dialogs_XWizardPage_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/XWindow.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 a single page of a <type>Wizard</type> 36*b1cdbd2cSJim Jagielski */ 37*b1cdbd2cSJim Jagielskipublished interface XWizardPage : ::com::sun::star::lang::XComponent 38*b1cdbd2cSJim Jagielski{ 39*b1cdbd2cSJim Jagielski /** provides read-only access to the window of the page 40*b1cdbd2cSJim Jagielski */ 41*b1cdbd2cSJim Jagielski [attribute, readonly] ::com::sun::star::awt::XWindow Window; 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski /** denotes the ID of the page. 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski <p>Within a wizard, no two pages are allowed to have the same ID.</p> 46*b1cdbd2cSJim Jagielski */ 47*b1cdbd2cSJim Jagielski [attribute, readonly] short PageId; 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski /** called when the page is activated 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski void activatePage(); 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski /** is called when the page is about to be left 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski <p>An implementation can veto the leave by returning <FALSE/> here. Usually, the decision about this 56*b1cdbd2cSJim Jagielski depends on the current state of the page.</p> 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @param Reason 59*b1cdbd2cSJim Jagielski is one of the <type>WizardTravelType</type> contants denoting the reason why the page should be 60*b1cdbd2cSJim Jagielski committed. 61*b1cdbd2cSJim Jagielski */ 62*b1cdbd2cSJim Jagielski boolean commitPage( [in] short Reason ); 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski /** determines whether it is allowed to travel to a later page in the wizard 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski <p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually, 67*b1cdbd2cSJim Jagielski you return <FALSE/> here if and only if not all necessary input on the page has been provided by the user, 68*b1cdbd2cSJim Jagielski or the provided input is not valid.</p> 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity 71*b1cdbd2cSJim Jagielski than a disabled <code>Next</code> button in the wizard, then move your checks to the <member>commitPage</member> 72*b1cdbd2cSJim Jagielski method.</p> 73*b1cdbd2cSJim Jagielski */ 74*b1cdbd2cSJim Jagielski boolean canAdvance(); 75*b1cdbd2cSJim Jagielski}; 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski//================================================================================================================== 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski}; }; }; }; }; 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski//================================================================================================================== 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski#endif 84