blob: aa22d573f37613106487c51d0199eb0bde19e2de (
plain)
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
98
99
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XDispatchHelper.idl,v $
* $Revision: 1.8 $
*
* 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_frame_XDispatchHelper_idl__
#define __com_sun_star_frame_XDispatchHelper_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_frame_XDispatchProvider_idl__
#include <com/sun/star/frame/XDispatchProvider.idl>
#endif
#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif
//=============================================================================
module com { module sun { module star { module frame {
//=============================================================================
/** provides an easy way to dispatch functions useful at UI level.
@see XDispatch
@since OOo 1.1.2
*/
published interface XDispatchHelper : com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** executes the dispatch.
Listeners are not supported here!
@param DispatchProvider
points to the provider, which should be asked for valid dispatch objects
@param URL
describes the feature which should be supported by internally used dispatch object
@param TargetFrameName
specifies the frame which should be the target for this request
@param SearchFlags
optional search parameter for finding the frame if no special
<var>TargetFrameName</var> was used
@param Arguments
optional arguments for this request
They depend on the real implementation of the dispatch object.
@return
A possible result of the executed internal dispatch.
The information behind this <atom>any</atom> depends on the dispatch!
@see XDispatch::dispatch()
*/
any executeDispatch(
[in] XDispatchProvider DispatchProvider,
[in] string URL,
[in] string TargetFrameName,
[in] long SearchFlags,
[in] sequence< com::sun::star::beans::PropertyValue > Arguments );
};
//=============================================================================
}; }; }; };
#endif
|
