summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/document/DocumentEvent.idl
blob: 0b5b2cd5a2056b6f0ff16750b4d4e9a8dec3d2e2 (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
/*************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: DocumentEvent.idl,v $
*
* $Revision: 1.4.2.2 $
*
* 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_document_DocumentEvent_idl__
#define __com_sun_star_document_DocumentEvent_idl__

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif
#ifndef __com_sun_star_frame_XController2_idl__
#include <com/sun/star/frame/XController2.idl>
#endif

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

module com { module sun { module star { module document {

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

/** describes an event happening in an <type>OfficeDocument</type>

    <p>The <member scope="com::sun::star::lang">EventObject::Source</member> member
    of the base type refers to the document which broadcasts the event.</p>

    <p>This type is the successor of the EventObject type, which should not be used
    anymore.</p>

    @see XDocumentEventBroadcaster
    @since OpenOffice.org 3.1
 */
struct DocumentEvent : ::com::sun::star::lang::EventObject
{
    /** specifies the name of the event.

        <p>It's the responsibility of the component supporting the <type>XDocumentEventBroadcaster</type>
        interface to specify which events it supports.</p>
    */
    string  EventName;

    /** denotes the view respectively controller which the event applies to.

        <p>Might be <NULL/> if the event is not related to a concrete view of
        the document.</p>
    */
    ::com::sun::star::frame::XController2
            ViewController;

    /** contains supplemental information about the even which is being notified

        <p>The semantics of this additional information needs to be specified by the broadcaster
        of the event.</p>
    */
    any     Supplement;
};

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

}; }; }; };

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

#endif