1d1766043SAndrew Rist/**************************************************************
2d1766043SAndrew Rist *
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
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
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.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_XWizardPage_idl__
25cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_XWizardPage_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#include <com/sun/star/awt/XWindow.idl>
28cdf0e10cSrcweir
29cdf0e10cSrcweir//==================================================================================================================
30cdf0e10cSrcweir
31cdf0e10cSrcweirmodule com { module sun { module star { module ui { module dialogs {
32cdf0e10cSrcweir
33cdf0e10cSrcweir//==================================================================================================================
34cdf0e10cSrcweir
35cdf0e10cSrcweir/** is a single page of a <type>Wizard</type>
36105086f9SAriel Constenla-Haile
37105086f9SAriel Constenla-Haile    @since OpenOffice 3.3
38cdf0e10cSrcweir */
39*8e964030SAriel Constenla-Haileinterface XWizardPage : ::com::sun::star::lang::XComponent
40cdf0e10cSrcweir{
41cdf0e10cSrcweir    /** provides read-only access to the window of the page
42cdf0e10cSrcweir    */
43cdf0e10cSrcweir    [attribute, readonly]   ::com::sun::star::awt::XWindow  Window;
44cdf0e10cSrcweir
45cdf0e10cSrcweir    /** denotes the ID of the page.
46cdf0e10cSrcweir
47cdf0e10cSrcweir        <p>Within a wizard, no two pages are allowed to have the same ID.</p>
48cdf0e10cSrcweir    */
49cdf0e10cSrcweir    [attribute, readonly]   short PageId;
50cdf0e10cSrcweir
51cdf0e10cSrcweir    /** called when the page is activated
52cdf0e10cSrcweir    */
53cdf0e10cSrcweir    void    activatePage();
54cdf0e10cSrcweir
55cdf0e10cSrcweir    /** is called when the page is about to be left
56cdf0e10cSrcweir
57cdf0e10cSrcweir        <p>An implementation can veto the leave by returning <FALSE/> here. Usually, the decision about this
58cdf0e10cSrcweir        depends on the current state of the page.</p>
59cdf0e10cSrcweir
60cdf0e10cSrcweir        @param Reason
61cdf0e10cSrcweir            is one of the <type>WizardTravelType</type> contants denoting the reason why the page should be
62cdf0e10cSrcweir            committed.
63cdf0e10cSrcweir    */
64cdf0e10cSrcweir    boolean commitPage( [in] short Reason );
65cdf0e10cSrcweir
66cdf0e10cSrcweir    /** determines whether it is allowed to travel to a later page in the wizard
67cdf0e10cSrcweir
68cdf0e10cSrcweir        <p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually,
69cdf0e10cSrcweir        you return <FALSE/> here if and only if not all necessary input on the page has been provided by the user,
70cdf0e10cSrcweir        or the provided input is not valid.</p>
71cdf0e10cSrcweir
72cdf0e10cSrcweir        <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity
73cdf0e10cSrcweir        than a disabled <code>Next</code> button in the wizard, then move your checks to the <member>commitPage</member>
74cdf0e10cSrcweir        method.</p>
75cdf0e10cSrcweir    */
76cdf0e10cSrcweir    boolean canAdvance();
77cdf0e10cSrcweir};
78cdf0e10cSrcweir
79cdf0e10cSrcweir//==================================================================================================================
80cdf0e10cSrcweir
81cdf0e10cSrcweir}; }; }; }; };
82cdf0e10cSrcweir
83cdf0e10cSrcweir//==================================================================================================================
84cdf0e10cSrcweir
85cdf0e10cSrcweir#endif
86