blob: 38699616124a3fcbebb2440b311e7159e486cc6a (
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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_frame_XDispatchRecorder_idl__
#define __com_sun_star_frame_XDispatchRecorder_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/util/URL.idl>
#include <com/sun/star/beans/PropertyValue.idl>
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!
Otherwise the macro will be released.
</p>
@returns
the recorded data as a string which can be interpreted as a script
*/
string getRecordedMacro();
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
