1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_document_DocumentEvent_idl__
25#define __com_sun_star_document_DocumentEvent_idl__
26
27#ifndef __com_sun_star_lang_EventObject_idl__
28#include <com/sun/star/lang/EventObject.idl>
29#endif
30#ifndef __com_sun_star_frame_XController2_idl__
31#include <com/sun/star/frame/XController2.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module document {
37
38//=============================================================================
39
40/** describes an event happening in an <type>OfficeDocument</type>
41
42    <p>The <member scope="com::sun::star::lang">EventObject::Source</member> member
43    of the base type refers to the document which broadcasts the event.</p>
44
45    <p>This type is the successor of the EventObject type, which should not be used
46    anymore.</p>
47
48    @see XDocumentEventBroadcaster
49    @since OpenOffice 3.1
50 */
51published struct DocumentEvent : ::com::sun::star::lang::EventObject
52{
53    /** specifies the name of the event.
54
55        <p>It's the responsibility of the component supporting the <type>XDocumentEventBroadcaster</type>
56        interface to specify which events it supports.</p>
57    */
58    string  EventName;
59
60    /** denotes the view respectively controller which the event applies to.
61
62        <p>Might be <NULL/> if the event is not related to a concrete view of
63        the document.</p>
64    */
65    ::com::sun::star::frame::XController2
66            ViewController;
67
68    /** contains supplemental information about the even which is being notified
69
70        <p>The semantics of this additional information needs to be specified by the broadcaster
71        of the event.</p>
72    */
73    any     Supplement;
74};
75
76//=============================================================================
77
78}; }; }; };
79
80//=============================================================================
81
82#endif
83