XWizard.idl

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

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


interface XWizardPage;

interface XWizard
{
    interface   XExecutableDialog;

    [attribute] string  HelpURL;

    [attribute, readonly] ::com::sun::star::awt::XWindow
                        DialogWindow;

    XWizardPage
            getCurrentPage();

    void    enableButton( [in] short WizardButton, [in] boolean Enable );

    void    setDefaultButton( [in] short WizardButton );

    boolean travelNext();

    boolean travelPrevious();

    void    enablePage( [in] short PageID, [in] boolean Enable )
        raises  (   ::com::sun::star::container::NoSuchElementException
                ,   ::com::sun::star::util::InvalidStateException );

    void    updateTravelUI();

    boolean advanceTo( [in] short PageId );

    boolean goBackTo( [in] short PageId );

    void    activatePath( [in] short PathIndex, [in] boolean Final )
        raises  (   ::com::sun::star::container::NoSuchElementException
                ,   ::com::sun::star::util::InvalidStateException );
};


}; }; }; }; };


/* vim:set shiftwidth=4 softtabstop=4 expandtab: */