1d1766043SAndrew Rist/************************************************************** 2*99c4f019SAriel Constenla-Haile * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*99c4f019SAriel Constenla-Haile * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*99c4f019SAriel Constenla-Haile * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19*99c4f019SAriel Constenla-Haile * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_XWizardPage_idl__ 23cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_XWizardPage_idl__ 24cdf0e10cSrcweir 25cdf0e10cSrcweir#include <com/sun/star/awt/XWindow.idl> 26cdf0e10cSrcweir 27cdf0e10cSrcweirmodule com { module sun { module star { module ui { module dialogs { 28cdf0e10cSrcweir 29cdf0e10cSrcweir/** is a single page of a <type>Wizard</type> 30105086f9SAriel Constenla-Haile 31105086f9SAriel Constenla-Haile @since OpenOffice 3.3 32cdf0e10cSrcweir */ 338e964030SAriel Constenla-Haileinterface XWizardPage : ::com::sun::star::lang::XComponent 34cdf0e10cSrcweir{ 35cdf0e10cSrcweir /** provides read-only access to the window of the page 36cdf0e10cSrcweir */ 37cdf0e10cSrcweir [attribute, readonly] ::com::sun::star::awt::XWindow Window; 38cdf0e10cSrcweir 39cdf0e10cSrcweir /** denotes the ID of the page. 40cdf0e10cSrcweir 41cdf0e10cSrcweir <p>Within a wizard, no two pages are allowed to have the same ID.</p> 42cdf0e10cSrcweir */ 43cdf0e10cSrcweir [attribute, readonly] short PageId; 44cdf0e10cSrcweir 45cdf0e10cSrcweir /** called when the page is activated 46cdf0e10cSrcweir */ 47cdf0e10cSrcweir void activatePage(); 48cdf0e10cSrcweir 49cdf0e10cSrcweir /** is called when the page is about to be left 50cdf0e10cSrcweir 51cdf0e10cSrcweir <p>An implementation can veto the leave by returning <FALSE/> here. Usually, the decision about this 52cdf0e10cSrcweir depends on the current state of the page.</p> 53cdf0e10cSrcweir 54cdf0e10cSrcweir @param Reason 55cdf0e10cSrcweir is one of the <type>WizardTravelType</type> contants denoting the reason why the page should be 56cdf0e10cSrcweir committed. 57cdf0e10cSrcweir */ 58cdf0e10cSrcweir boolean commitPage( [in] short Reason ); 59cdf0e10cSrcweir 60cdf0e10cSrcweir /** determines whether it is allowed to travel to a later page in the wizard 61cdf0e10cSrcweir 62cdf0e10cSrcweir <p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually, 63cdf0e10cSrcweir you return <FALSE/> here if and only if not all necessary input on the page has been provided by the user, 64cdf0e10cSrcweir or the provided input is not valid.</p> 65cdf0e10cSrcweir 66cdf0e10cSrcweir <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity 67cdf0e10cSrcweir than a disabled <code>Next</code> button in the wizard, then move your checks to the <member>commitPage</member> 68cdf0e10cSrcweir method.</p> 69cdf0e10cSrcweir */ 70cdf0e10cSrcweir boolean canAdvance(); 71cdf0e10cSrcweir}; 72cdf0e10cSrcweir 73cdf0e10cSrcweir}; }; }; }; }; 74cdf0e10cSrcweir 75cdf0e10cSrcweir#endif 76