offapi/com/sun/star/document/DocumentEvent.idl

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