1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: FilterOptionsDialog.idl,v $
*
* $Revision: 1.8 $
*
* last change: $Author: kz $ $Date: 2008-03-06 17:03:01 $
*
* 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.
<p>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>.</p>
<p>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>.</p>
<p>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>.</p>
<p>Otherwise, the filter operation is canceled.</p>
@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
|
