/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: FilterOptionsDialog.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 08:36:11 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_ui_dialogs_FilterOptionsDialog_idl__
#define __com_sun_star_ui_dialogs_FilterOptionsDialog_idl__

#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__
#include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
#endif

#ifndef __com_sun_star_beans_XPropertyAccess_idl__
#include <com/sun/star/beans/XPropertyAccess.idl>
#endif

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

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

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

/** This service enables a filter developer to register a dialog to query
    for user options before the filter operation is performed.

    The user options are stored inside the <type scope="com::sun::star::document">MediaDescriptor</type>
    and can be queried from the <type scope="com::sun::star::document">MediaDescriptor</type> by
    the component that implements <type scope="com::sun::star::document">XFilter</type>.

    The application will set the <type scope="com::sun::star::document">MediaDescriptor</type>
    using the interface <type scope="com::sun::star::beans">XPropertyAccess</type> and then
    call <method>XExecutableDialog::execute<method>.

    If that method returns <code>ExecutableDialogResults::OK</code>,
    the application will retrieve the changed <type scope="com::sun::star::document">MediaDescriptor</type>
    back using the interface <type scope="com::sun::star::beans">XPropertyAccess</type>. The filter
    operation is than continued, using the new <type scope="com::sun::star::document">MediaDescriptor</type>.

    Otherwise, the filter operation is canceled.

    @since OOo 1.1.2
 */
published service FilterOptionsDialog
{
    //-------------------------------------------------------------------------
    /** this interface is used to set the property values of the
        <type scope="com::sun::star::document">MediaDescriptor</type> before executing
        the dialog and to retrieve the changed <type scope="com::sun::star::document">MediaDescriptor</type>

        afterwards.
     */
    interface com::sun::star::beans::XPropertyAccess;

    //-------------------------------------------------------------------------
    /** this interface executes a dialog that displays the options
        for a filter.
        If <method>XExecutableDialog::execute<method>
        returns <code>ExecutableDialogResults::OK</code>,
        the options can be retrieved by calling <method scope="com::sun::star::beans">XPropertyAccess::getPropertyValues<method>.
     */
    interface ::com::sun::star::ui::dialogs::XExecutableDialog;
};

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

}; }; }; }; };

#endif
