blob: ed980d89f91d2bc61b6b342c4f12e6f909b07e95 (
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/*************************************************************************
*
* 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_XDispatchRecorder_idl__
#define __com_sun_star_frame_XDispatchRecorder_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_util_URL_idl__
#include <com/sun/star/util/URL.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 {
published interface XFrame;
//=============================================================================
/** provides recording functionality of dispatches
<p>
With such recorder it will be possible to record requests of type
<type>XDispatch</type> by using additional interface
<type>XRecordableDispatch</type>. The result of that will be a
a script which can be used to start the dispatch at later time again.
Such recorder objects are available on a <type>XDispatchRecorderSupplier</type>
which is provided by the <type>Frame</type> service.
</p>
@see Frame
@see XDispatchRecorderSupplier
@since OOo 1.1.2
*/
published interface XDispatchRecorder: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** initializes the recorder by passing the frame for which all
macro statements shall be recorded
@param Frame
it includes the document on which such requests shall be recorded
*/
void startRecording( [in] com::sun::star::frame::XFrame Frame );
//-------------------------------------------------------------------------
/** stops the recording process
<p>
Must be called in pairs with <member>XDispatchRecorder::startRecording()</member>.
</p>
@attention The recorder uses this method to control the lifetime of its internal
used macro buffer. It will be cleared here. So the macro must be fetched
before endRecording() is called.
@see getRecordedMacro()
*/
void endRecording();
//-------------------------------------------------------------------------
/** records a single dispatch call identified by its command URL
@param URL
the full parsed command URL
@param Arguments
optional arguments for the command URL
<br>
(see <type scope="com::sun::star::document">MediaDescriptor</type>
for further informations)
*/
void recordDispatch(
[in] com::sun::star::util::URL URL,
[in] sequence<com::sun::star::beans::PropertyValue> Arguments);
//-------------------------------------------------------------------------
/** records a single dispatch call identified by its command URL, but
comments it out
<p>
This way calls that failed on execution can be documented.
</p>
@param URL
the full parsed command URL
@param Arguments
optional arguments for the command URL
<br>
(see <type scope="com::sun::star::document">MediaDescriptor</type>
for further informations)
*/
void recordDispatchAsComment(
[in] com::sun::star::util::URL URL,
[in] sequence<com::sun::star::beans::PropertyValue> Arguments);
//-------------------------------------------------------------------------
/** returns the recorded source code
<p>
This method must be used before <member>endRecording()</member> is called!
Otherwhise the macro will be relased.
</p>
@returns
the recorded data as a string which can be interpreted as a script
*/
string getRecordedMacro();
};
//=============================================================================
}; }; }; };
#endif
|
