summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl
blob: f94444b5e210344a48ffc5db5ba0f5381eef2f4a (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
/*************************************************************************
 *
 * 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_DispatchRecorderSupplier_idl__
#define __com_sun_star_frame_DispatchRecorderSupplier_idl__

#ifndef __com_sun_star_frame_XDispatchRecorderSupplier_idl__
#include <com/sun/star/frame/XDispatchRecorderSupplier.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module frame {

//=============================================================================
/** provides a <type>DispatchRecorder</type>

    <p>
    This supplier regulate macro recording of <member>XDispatch::dispatch()</member>
    calls. For that it capsulate a reference to a <type>DispatchRecorder</type>.
    Such recorder is used internaly and can be used externaly too.
    A supplier will be available on a <type>Frame</type> if recording was enabled,
    otherwise not. A frame supports a special property for that.
    This modular concept of recorder, supplier and frame makes it possible to
    implement local recording on one frame; global recording by using all currently
    opened frames or only some of them; and so on.
    </p>

    @see DispatchRecorder
    @see Frame
    @since OOo 1.1.2
 */
published service DispatchRecorderSupplier
{
    //-------------------------------------------------------------------------
    /** provides access to a <type>DispatchRecorder</type> and helps on recording
     */
    interface com::sun::star::frame::XDispatchRecorderSupplier;
};

//=============================================================================

}; }; }; };

#endif