| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef __com_sun_star_ui_dialogs_XWizardPage_idl__ |
| #define __com_sun_star_ui_dialogs_XWizardPage_idl__ |
| |
| #include <com/sun/star/awt/XWindow.idl> |
| |
| //================================================================================================================== |
| |
| module com { module sun { module star { module ui { module dialogs { |
| |
| //================================================================================================================== |
| |
| /** is a single page of a <type>Wizard</type> |
| */ |
| published interface XWizardPage : ::com::sun::star::lang::XComponent |
| { |
| /** provides read-only access to the window of the page |
| */ |
| [attribute, readonly] ::com::sun::star::awt::XWindow Window; |
| |
| /** denotes the ID of the page. |
| |
| <p>Within a wizard, no two pages are allowed to have the same ID.</p> |
| */ |
| [attribute, readonly] short PageId; |
| |
| /** called when the page is activated |
| */ |
| void activatePage(); |
| |
| /** is called when the page is about to be left |
| |
| <p>An implementation can veto the leave by returning <FALSE/> here. Usually, the decision about this |
| depends on the current state of the page.</p> |
| |
| @param Reason |
| is one of the <type>WizardTravelType</type> contants denoting the reason why the page should be |
| committed. |
| */ |
| boolean commitPage( [in] short Reason ); |
| |
| /** determines whether it is allowed to travel to a later page in the wizard |
| |
| <p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually, |
| you return <FALSE/> here if and only if not all necessary input on the page has been provided by the user, |
| or the provided input is not valid.</p> |
| |
| <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity |
| than a disabled <code>Next</code> button in the wizard, then move your checks to the <member>commitPage</member> |
| method.</p> |
| */ |
| boolean canAdvance(); |
| }; |
| |
| //================================================================================================================== |
| |
| }; }; }; }; }; |
| |
| //================================================================================================================== |
| |
| #endif |