offapi/com/sun/star/ui/dialogs/Wizard.idl

   1 /*************************************************************************
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3  *
   4  * Copyright 2000, 2010 Oracle and/or its affiliates.
   5  *
   6  * OpenOffice.org - a multi-platform office productivity suite
   7  *
   8  * This file is part of OpenOffice.org.
   9  *
  10  * OpenOffice.org is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Lesser General Public License version 3
  12  * only, as published by the Free Software Foundation.
  13  *
  14  * OpenOffice.org is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Lesser General Public License version 3 for more details
  18  * (a copy is included in the LICENSE file that accompanied this code).
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * version 3 along with OpenOffice.org.  If not, see
  22  * <http://www.openoffice.org/license.html>
  23  * for a copy of the LGPLv3 License.
  24  *
  25  ************************************************************************/
  26
  27 #ifndef __com_sun_star_ui_dialogs_Wizard_idl__
  28 #define __com_sun_star_ui_dialogs_Wizard_idl__
  29
  30 #include <com/sun/star/ui/dialogs/XWizard.idl>
  31 #include <com/sun/star/lang/IllegalArgumentException.idl>
  32
  33 //==================================================================================================================
  34
  35 module com { module sun { module star { module ui { module dialogs {
  36
  37 interface XWizardController;
  38
  39 //==================================================================================================================
  40
  41 /** provides a framework for implementing a wizard dialog.
  42  */
  43 service Wizard : XWizard
  44 {
  45     /** creates a wizard with a single execution path
  46         @param PageIds
  47             the IDs of the pages which constitute the execution path. IDs must be in ascending order.
  48     */
  49     createSinglePathWizard(
  50         [in] sequence< short > PageIds,
  51         [in] XWizardController Controller
  52     )
  53     raises  (   ::com::sun::star::lang::IllegalArgumentException
  54             );
  55
  56     /** creates a wizard with a multiple possible execution paths
  57
  58         @param PageIds
  59             the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order.
  60     */
  61     createMultiplePathsWizard(
  62         [in] sequence< sequence< short > > PageIds,
  63         [in] XWizardController Controller
  64     )
  65     raises  (   ::com::sun::star::lang::IllegalArgumentException
  66             );
  67 };
  68
  69 //==================================================================================================================
  70
  71 }; }; }; }; };
  72
  73 //==================================================================================================================
  74
  75 #endif