xref: /AOO41X/main/offapi/com/sun/star/frame/DispatchRecorder.idl (revision c4dc0a1aba8e7aaa49e08ea6b3b605484dad910b)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_frame_DispatchRecorder_idl__
24cdf0e10cSrcweir#define __com_sun_star_frame_DispatchRecorder_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_frame_XDispatchRecorder_idl__
27cdf0e10cSrcweir#include <com/sun/star/frame/XDispatchRecorder.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexReplace_idl__
31cdf0e10cSrcweir#include <com/sun/star/container/XIndexReplace.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir
36cdf0e10cSrcweir module com {  module sun {  module star {  module frame {
37cdf0e10cSrcweir
38cdf0e10cSrcweir//=============================================================================
39cdf0e10cSrcweir/** provides functionality to record <member>XDispatch::dispatch()</member> requests
40cdf0e10cSrcweir
41cdf0e10cSrcweir    <p>
42cdf0e10cSrcweir    It records all neccessary parameters of a call <member>XDispatch::dispatch()</member>
43cdf0e10cSrcweir    and generate code which can be executed at later time to run same operations
44cdf0e10cSrcweir    again. Which code will be generated depends from real implementation. So it's
45cdf0e10cSrcweir    possible to generate e.g. Java/Basic or may Perl code.
46cdf0e10cSrcweir    By using of a <type>DispatchRecorderSupplier</type>, which is available on
47cdf0e10cSrcweir    a property of a <member>Frame::DispatchRecorderSupplier</member>, it's possible to change such code generation
48cdf0e10cSrcweir    for further requests or disable it in general by setting this property to <NULL/>.
49cdf0e10cSrcweir    </p>
50cdf0e10cSrcweir
51cdf0e10cSrcweir    @see DispatchRecorderSupplier
52cdf0e10cSrcweir    @see Frame::RecorderSupplier
53cdf0e10cSrcweir
54*c4dc0a1aSJürgen Schmidt    @since OpenOffice 1.1.2
55cdf0e10cSrcweir */
56cdf0e10cSrcweirpublished service DispatchRecorder
57cdf0e10cSrcweir{
58cdf0e10cSrcweir	//-------------------------------------------------------------------------
59cdf0e10cSrcweir    /** provides the record functionality and access on the generated code
60cdf0e10cSrcweir	 */
61cdf0e10cSrcweir    interface com::sun::star::frame::XDispatchRecorder;
62cdf0e10cSrcweir    /** provides replacement capability of recorded statements
63cdf0e10cSrcweir	*/
64cdf0e10cSrcweir    interface com::sun::star::container::XIndexReplace;
65cdf0e10cSrcweir};
66cdf0e10cSrcweir
67cdf0e10cSrcweir//=============================================================================
68cdf0e10cSrcweir
69cdf0e10cSrcweir}; }; }; };
70cdf0e10cSrcweir
71cdf0e10cSrcweir#endif
72