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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_document_DocumentEvent_idl__
  21 #define __com_sun_star_document_DocumentEvent_idl__
  22
  23 #include <com/sun/star/lang/EventObject.idl>
  24 #include <com/sun/star/frame/XController2.idl>
  25
  26
  27 module com { module sun { module star { module document {
  28
  29
  30 /** describes an event happening in an OfficeDocument
  31
  32     <p>The com::sun::star::lang::EventObject::Source member
  33     of the base type refers to the document which broadcasts the event.</p>
  34
  35     <p>This type is the successor of the EventObject type, which should not be used
  36     anymore.</p>
  37
  38     @see XDocumentEventBroadcaster
  39     @since OOo 3.1
  40  */
  41 struct DocumentEvent : ::com::sun::star::lang::EventObject
  42 {
  43     /** specifies the name of the event.
  44
  45         <p>It's the responsibility of the component supporting the XDocumentEventBroadcaster
  46         interface to specify which events it supports.</p>
  47     */
  48     string  EventName;
  49
  50     /** denotes the view respectively controller which the event applies to.
  51
  52         <p>Might be `NULL` if the event is not related to a concrete view of
  53         the document.</p>
  54     */
  55     ::com::sun::star::frame::XController2
  56             ViewController;
  57
  58     /** contains supplemental information about the event which is being notified
  59
  60         <p>The semantics of this additional information needs to be specified by the broadcaster
  61         of the event.</p>
  62     */
  63     any     Supplement;
  64 };
  65
  66
  67 }; }; }; };
  68
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */