xref: /trunk/main/offapi/com/sun/star/ui/dialogs/Wizard.idl (revision 99c4f019)
1d1766043SAndrew Rist/**************************************************************
2*99c4f019SAriel Constenla-Haile *
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
10*99c4f019SAriel Constenla-Haile *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*99c4f019SAriel Constenla-Haile *
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.
19*99c4f019SAriel Constenla-Haile *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22cdf0e10cSrcweir#ifndef __com_sun_star_ui_dialogs_Wizard_idl__
23cdf0e10cSrcweir#define __com_sun_star_ui_dialogs_Wizard_idl__
24cdf0e10cSrcweir
25cdf0e10cSrcweir#include <com/sun/star/ui/dialogs/XWizard.idl>
26cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
27cdf0e10cSrcweir
28cdf0e10cSrcweirmodule com { module sun { module star { module ui { module dialogs {
29cdf0e10cSrcweir
308e964030SAriel Constenla-Haileinterface XWizardController;
31cdf0e10cSrcweir
32cdf0e10cSrcweir/** provides a framework for implementing a wizard dialog.
33105086f9SAriel Constenla-Haile
34105086f9SAriel Constenla-Haile    @since OpenOffice 3.3
35cdf0e10cSrcweir */
368e964030SAriel Constenla-Haileservice Wizard : XWizard
37cdf0e10cSrcweir{
38cdf0e10cSrcweir    /** creates a wizard with a single execution path
39cdf0e10cSrcweir        @param PageIds
40cdf0e10cSrcweir            the IDs of the pages which constitute the execution path. IDs must be in ascending order.
41cdf0e10cSrcweir    */
42cdf0e10cSrcweir    createSinglePathWizard(
43cdf0e10cSrcweir        [in] sequence< short > PageIds,
44cdf0e10cSrcweir        [in] XWizardController Controller
45cdf0e10cSrcweir    )
46cdf0e10cSrcweir    raises  (   ::com::sun::star::lang::IllegalArgumentException
47cdf0e10cSrcweir            );
48cdf0e10cSrcweir
49cdf0e10cSrcweir    /** creates a wizard with a multiple possible execution paths
50cdf0e10cSrcweir
51cdf0e10cSrcweir        @param PageIds
52cdf0e10cSrcweir            the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order.
53cdf0e10cSrcweir    */
54cdf0e10cSrcweir    createMultiplePathsWizard(
55cdf0e10cSrcweir        [in] sequence< sequence< short > > PageIds,
56cdf0e10cSrcweir        [in] XWizardController Controller
57cdf0e10cSrcweir    )
58cdf0e10cSrcweir    raises  (   ::com::sun::star::lang::IllegalArgumentException
59cdf0e10cSrcweir            );
60cdf0e10cSrcweir};
61cdf0e10cSrcweir
62cdf0e10cSrcweir}; }; }; }; };
63cdf0e10cSrcweir
64cdf0e10cSrcweir#endif
65