xref: /trunk/main/offapi/com/sun/star/ui/dialogs/Wizard.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2*d1766043SAndrew Rist *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_Wizard_idl__
25cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_Wizard_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#include <com/sun/star/ui/dialogs/XWizard.idl>
28cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
29cdf0e10cSrcweir
30cdf0e10cSrcweir//==================================================================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweirmodule com { module sun { module star { module ui { module dialogs {
33cdf0e10cSrcweir
34cdf0e10cSrcweirpublished interface XWizardController;
35cdf0e10cSrcweir
36cdf0e10cSrcweir//==================================================================================================================
37cdf0e10cSrcweir
38cdf0e10cSrcweir/** provides a framework for implementing a wizard dialog.
39cdf0e10cSrcweir */
40cdf0e10cSrcweirpublished service Wizard : XWizard
41cdf0e10cSrcweir{
42cdf0e10cSrcweir    /** creates a wizard with a single execution path
43cdf0e10cSrcweir        @param PageIds
44cdf0e10cSrcweir            the IDs of the pages which constitute the execution path. IDs must be in ascending order.
45cdf0e10cSrcweir    */
46cdf0e10cSrcweir    createSinglePathWizard(
47cdf0e10cSrcweir        [in] sequence< short > PageIds,
48cdf0e10cSrcweir        [in] XWizardController Controller
49cdf0e10cSrcweir    )
50cdf0e10cSrcweir    raises  (   ::com::sun::star::lang::IllegalArgumentException
51cdf0e10cSrcweir            );
52cdf0e10cSrcweir
53cdf0e10cSrcweir    /** creates a wizard with a multiple possible execution paths
54cdf0e10cSrcweir
55cdf0e10cSrcweir        @param PageIds
56cdf0e10cSrcweir            the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order.
57cdf0e10cSrcweir    */
58cdf0e10cSrcweir    createMultiplePathsWizard(
59cdf0e10cSrcweir        [in] sequence< sequence< short > > PageIds,
60cdf0e10cSrcweir        [in] XWizardController Controller
61cdf0e10cSrcweir    )
62cdf0e10cSrcweir    raises  (   ::com::sun::star::lang::IllegalArgumentException
63cdf0e10cSrcweir            );
64cdf0e10cSrcweir};
65cdf0e10cSrcweir
66cdf0e10cSrcweir//==================================================================================================================
67cdf0e10cSrcweir
68cdf0e10cSrcweir}; }; }; }; };
69cdf0e10cSrcweir
70cdf0e10cSrcweir//==================================================================================================================
71cdf0e10cSrcweir
72cdf0e10cSrcweir#endif
73