offapi/com/sun/star/form/XUpdateBroadcaster.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XUpdateBroadcaster.idl,v $
  10  * $Revision: 1.9 $
  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_form_XUpdateBroadcaster_idl__
  31 #define __com_sun_star_form_XUpdateBroadcaster_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_XUpdateListener_idl__
  38 #include <com/sun/star/form/XUpdateListener.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module form {
  45
  46 //=============================================================================
  47
  48 /** is the broadcaster interface for sending "approveUpdate" and "updated" events.
  49
  50     <p>The component supporting this interface must do approval calls
  51     (<member>XUpdateListener::approveUpdate</member>) immediately
  52     before the data is updated, and notification calls
  53     (<member>XUpdateListener::updated</member>) immediately afterwards.</p>
  54
  55     @see XUpdateListener
  56  */
  57 published interface XUpdateBroadcaster: com::sun::star::uno::XInterface
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** adds the specified listener to receive the events "approveUpdate"
  62         and "updated".
  63         @param aListener
  64             the listener to add.
  65         @see com::sun::star::form::XUpdateListener
  66      */
  67     [oneway] void addUpdateListener( [in] com::sun::star::form::XUpdateListener aListener );
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** removes the specified listener.
  72         @param aListener
  73             the listener to remove.
  74         @see com::sun::star::form::XUpdateListener
  75      */
  76     [oneway] void removeUpdateListener( [in] com::sun::star::form::XUpdateListener aListener );
  77
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; };
  83
  84 /*=============================================================================
  85
  86 =============================================================================*/
  87 #endif