offapi/com/sun/star/form/XUpdateBroadcaster.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 #ifndef __com_sun_star_form_XUpdateBroadcaster_idl__
  20 #define __com_sun_star_form_XUpdateBroadcaster_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/form/XUpdateListener.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module form {
  29
  30
  31 /** is the broadcaster interface for sending "approveUpdate" and "updated" events.
  32
  33     <p>The component supporting this interface must do approval calls
  34     (XUpdateListener::approveUpdate()) immediately
  35     before the data is updated, and notification calls
  36     (XUpdateListener::updated()) immediately afterwards.</p>
  37
  38     @see XUpdateListener
  39  */
  40 published interface XUpdateBroadcaster: com::sun::star::uno::XInterface
  41 {
  42
  43     /** adds the specified listener to receive the events "approveUpdate"
  44         and "updated".
  45         @param aListener
  46             the listener to add.
  47         @see com::sun::star::form::XUpdateListener
  48      */
  49     void addUpdateListener( [in] com::sun::star::form::XUpdateListener aListener );
  50
  51
  52     /** removes the specified listener.
  53         @param aListener
  54             the listener to remove.
  55         @see com::sun::star::form::XUpdateListener
  56      */
  57     void removeUpdateListener( [in] com::sun::star::form::XUpdateListener aListener );
  58
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */