xref: /AOO41X/main/offapi/com/sun/star/frame/DispatchRecorderSupplier.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_DispatchRecorderSupplier_idl__
24cdf0e10cSrcweir#define __com_sun_star_frame_DispatchRecorderSupplier_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_frame_XDispatchRecorderSupplier_idl__
27cdf0e10cSrcweir#include <com/sun/star/frame/XDispatchRecorderSupplier.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir//=============================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweir module com {  module sun {  module star {  module frame {
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir/** provides a <type>DispatchRecorder</type>
36cdf0e10cSrcweir
37cdf0e10cSrcweir    <p>
38cdf0e10cSrcweir    This supplier regulate macro recording of <member>XDispatch::dispatch()</member>
39cdf0e10cSrcweir    calls. For that it capsulate a reference to a <type>DispatchRecorder</type>.
40cdf0e10cSrcweir    Such recorder is used internaly and can be used externaly too.
41cdf0e10cSrcweir    A supplier will be available on a <type>Frame</type> if recording was enabled,
42cdf0e10cSrcweir    otherwise not. A frame supports a special property for that.
43cdf0e10cSrcweir    This modular concept of recorder, supplier and frame makes it possible to
44cdf0e10cSrcweir    implement local recording on one frame; global recording by using all currently
45cdf0e10cSrcweir    opened frames or only some of them; and so on.
46cdf0e10cSrcweir    </p>
47cdf0e10cSrcweir
48cdf0e10cSrcweir    @see DispatchRecorder
49cdf0e10cSrcweir    @see Frame
50*c4dc0a1aSJürgen Schmidt    @since OpenOffice 1.1.2
51cdf0e10cSrcweir */
52cdf0e10cSrcweirpublished service DispatchRecorderSupplier
53cdf0e10cSrcweir{
54cdf0e10cSrcweir	//-------------------------------------------------------------------------
55cdf0e10cSrcweir    /** provides access to a <type>DispatchRecorder</type> and helps on recording
56cdf0e10cSrcweir	 */
57cdf0e10cSrcweir    interface com::sun::star::frame::XDispatchRecorderSupplier;
58cdf0e10cSrcweir};
59cdf0e10cSrcweir
60cdf0e10cSrcweir//=============================================================================
61cdf0e10cSrcweir
62cdf0e10cSrcweir}; }; }; };
63cdf0e10cSrcweir
64cdf0e10cSrcweir#endif
65