1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_ui_dialogs_FilterOptionsDialog_idl__ 24#define __com_sun_star_ui_dialogs_FilterOptionsDialog_idl__ 25 26#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__ 27#include <com/sun/star/ui/dialogs/XExecutableDialog.idl> 28#endif 29 30#ifndef __com_sun_star_beans_XPropertyAccess_idl__ 31#include <com/sun/star/beans/XPropertyAccess.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module ui { module dialogs { 37 38//============================================================================= 39 40/** This service enables a filter developer to register a dialog to query 41 for user options before the filter operation is performed. 42 43 <p>The user options are stored inside the <type scope="com::sun::star::document">MediaDescriptor</type> 44 and can be queried from the <type scope="com::sun::star::document">MediaDescriptor</type> by 45 the component that implements <type scope="com::sun::star::document">XFilter</type>.</p> 46 47 <p>The application will set the <type scope="com::sun::star::document">MediaDescriptor</type> 48 using the interface <type scope="com::sun::star::beans">XPropertyAccess</type> and then 49 call <method>XExecutableDialog::execute<method>.</p> 50 51 <p>If that method returns <code>ExecutableDialogResults::OK</code>, 52 the application will retrieve the changed <type scope="com::sun::star::document">MediaDescriptor</type> 53 back using the interface <type scope="com::sun::star::beans">XPropertyAccess</type>. The filter 54 operation is than continued, using the new <type scope="com::sun::star::document">MediaDescriptor</type>.</p> 55 56 <p>Otherwise, the filter operation is canceled.</p> 57 58 @since OpenOffice 1.1.2 59 */ 60published service FilterOptionsDialog 61{ 62 //------------------------------------------------------------------------- 63 /** this interface is used to set the property values of the 64 <type scope="com::sun::star::document">MediaDescriptor</type> before executing 65 the dialog and to retrieve the changed <type scope="com::sun::star::document">MediaDescriptor</type> 66 67 afterwards. 68 */ 69 interface com::sun::star::beans::XPropertyAccess; 70 71 //------------------------------------------------------------------------- 72 /** this interface executes a dialog that displays the options 73 for a filter. 74 If <method>XExecutableDialog::execute<method> 75 returns <code>ExecutableDialogResults::OK</code>, 76 the options can be retrieved by calling <method scope="com::sun::star::beans">XPropertyAccess::getPropertyValues<method>. 77 */ 78 interface ::com::sun::star::ui::dialogs::XExecutableDialog; 79}; 80 81//============================================================================= 82 83}; }; }; }; }; 84 85#endif 86