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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_XRecordableDispatch_idl__
#define __com_sun_star_frame_XRecordableDispatch_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_frame_XDispatchRecorder_idl__
#include <com/sun/star/frame/XDispatchRecorder.idl>
#endif
#ifndef __com_sun_star_util_URL_idl__
#include <com/sun/star/util/URL.idl>
#endif
//=============================================================================
module com { module sun { module star { module frame {
//=============================================================================
/** extends an existing <type>XDispatch</type> implementation with functionality
for dispatch recording
<p>
This interface can be implemented as an additional one beside an existing
<type>XDispatch</type> one to provide record functionality of dispatches.
Because it's an additional interface the status events are available there
and not at this interface.
</p>
<p>
But normaly this interface mustn't be used directly.
If a dispatch object is well known and recording was enabled
on a <type>XDispatchRecorderSupplier</type> it's possible to use method
<member>XDispatchRecorderSupplier::dispatchAndRecord()</member> of it
to make dispatch and recording automaticly. The interface XRecordableDispatch
is used transparently there.
</p>
@example
<listing>
<i>XDispatch</i> xDispatcher = xFrame.queryDispatch(aURL,"",0);
<i>XRecordableDispatch</i> xRecordable = (<i>XRecordableDispatch</i>)UnoRuntime.queryInterface(
XRecordableDispatch.class,
xDispatcher);
xDispatcher.addStatusListener(this,aURL);
<b>if</b> (xRecordable!=<b>null</b>)
xRecordable.dispatchAndRecord(aURL,lArguments,xRecorder);
else
xDispatcher.dispatch(aURL,lArguments);
...
xDispatcher.removeStatusListener(this,aURL);
</listing>
@see XDispatchRecorderSupplier
@see XDispatch
@since OOo 1.1.2
*/
published interface XRecordableDispatch: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** dispatch and record it
@param URL
full parsed URL wich describe the feature which should be dispatched (executed)
@param Arguments
optional arguments for this request
(see <type scope="com::sun::star::document">MediaDescriptor</type> for details)
@param Recorder
object which can be used to record the request
(available on <member>XDispatchRecorderSupplier::getDispatchRecorder()</member>)
*/
[oneway] void dispatchAndRecord(
[in] com::sun::star::util::URL URL,
[in] sequence<com::sun::star::beans::PropertyValue> Arguments,
[in] XDispatchRecorder Recorder);
};
//=============================================================================
}; }; }; };
#endif
|
