/*************************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_ui_dialogs_Wizard_idl__
#define __com_sun_star_ui_dialogs_Wizard_idl__

#include <com/sun/star/ui/dialogs/XWizard.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>

//==================================================================================================================

module com { module sun { module star { module ui { module dialogs {

interface XWizardController;

//==================================================================================================================

/** provides a framework for implementing a wizard dialog.
 */
service Wizard : XWizard
{
    /** creates a wizard with a single execution path
        @param PageIds
            the IDs of the pages which constitute the execution path. IDs must be in ascending order.
    */
    createSinglePathWizard(
        [in] sequence< short > PageIds,
        [in] XWizardController Controller
    )
    raises  (   ::com::sun::star::lang::IllegalArgumentException
            );

    /** creates a wizard with a multiple possible execution paths

        @param PageIds
            the IDs of the pages which constitute the execution paths. IDs in each path must be in ascending order.
    */
    createMultiplePathsWizard(
        [in] sequence< sequence< short > > PageIds,
        [in] XWizardController Controller
    )
    raises  (   ::com::sun::star::lang::IllegalArgumentException
            );
};

//==================================================================================================================

}; }; }; }; };

//==================================================================================================================

#endif
