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