xref: /aoo42x/main/offapi/com/sun/star/ui/dialogs/Wizard.idl (revision 99c4f019)
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#ifndef __com_sun_star_ui_dialogs_Wizard_idl__
23#define __com_sun_star_ui_dialogs_Wizard_idl__
24
25#include <com/sun/star/ui/dialogs/XWizard.idl>
26#include <com/sun/star/lang/IllegalArgumentException.idl>
27
28module com { module sun { module star { module ui { module dialogs {
29
30interface XWizardController;
31
32/** provides a framework for implementing a wizard dialog.
33
34    @since OpenOffice 3.3
35 */
36service Wizard : XWizard
37{
38    /** creates a wizard with a single execution path
39        @param PageIds
40            the IDs of the pages which constitute the execution path. IDs must be in ascending order.
41    */
42    createSinglePathWizard(
43        [in] sequence< short > PageIds,
44        [in] XWizardController Controller
45    )
46    raises  (   ::com::sun::star::lang::IllegalArgumentException
47            );
48
49    /** creates a wizard with a multiple possible execution paths
50
51        @param PageIds
52            the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order.
53    */
54    createMultiplePathsWizard(
55        [in] sequence< sequence< short > > PageIds,
56        [in] XWizardController Controller
57    )
58    raises  (   ::com::sun::star::lang::IllegalArgumentException
59            );
60};
61
62}; }; }; }; };
63
64#endif
65