1/*************************************************************************
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * Copyright 2000, 2010 Oracle and/or its affiliates.
5 *
6 * OpenOffice.org - a multi-platform office productivity suite
7 *
8 * This file is part of OpenOffice.org.
9 *
10 * OpenOffice.org is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License version 3
12 * only, as published by the Free Software Foundation.
13 *
14 * OpenOffice.org is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU Lesser General Public License version 3 for more details
18 * (a copy is included in the LICENSE file that accompanied this code).
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * version 3 along with OpenOffice.org.  If not, see
22 * <http://www.openoffice.org/license.html>
23 * for a copy of the LGPLv3 License.
24 *
25************************************************************************/
26
27#ifndef __com_sun_star_document_DocumentEvent_idl__
28#define __com_sun_star_document_DocumentEvent_idl__
29
30#ifndef __com_sun_star_lang_EventObject_idl__
31#include <com/sun/star/lang/EventObject.idl>
32#endif
33#ifndef __com_sun_star_frame_XController2_idl__
34#include <com/sun/star/frame/XController2.idl>
35#endif
36
37//=============================================================================
38
39module com { module sun { module star { module document {
40
41//=============================================================================
42
43/** describes an event happening in an <type>OfficeDocument</type>
44
45    <p>The <member scope="com::sun::star::lang">EventObject::Source</member> member
46    of the base type refers to the document which broadcasts the event.</p>
47
48    <p>This type is the successor of the EventObject type, which should not be used
49    anymore.</p>
50
51    @see XDocumentEventBroadcaster
52    @since OOo 3.1
53 */
54published struct DocumentEvent : ::com::sun::star::lang::EventObject
55{
56    /** specifies the name of the event.
57
58        <p>It's the responsibility of the component supporting the <type>XDocumentEventBroadcaster</type>
59        interface to specify which events it supports.</p>
60    */
61    string  EventName;
62
63    /** denotes the view respectively controller which the event applies to.
64
65        <p>Might be <NULL/> if the event is not related to a concrete view of
66        the document.</p>
67    */
68    ::com::sun::star::frame::XController2
69            ViewController;
70
71    /** contains supplemental information about the even which is being notified
72
73        <p>The semantics of this additional information needs to be specified by the broadcaster
74        of the event.</p>
75    */
76    any     Supplement;
77};
78
79//=============================================================================
80
81}; }; }; };
82
83//=============================================================================
84
85#endif
86