/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XUpdateListener.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 00:30:26 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_form_XUpdateListener_idl__
#define __com_sun_star_form_XUpdateListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module form {

//=============================================================================

/** used to listen on objects which allow updating their data.
    <p>In addition to just get notified when an data update happened, the listener
    has a chance to veto updates <em>before</em> they happen.</p>

    @see XUpdateBroadcaster
 */
published interface XUpdateListener: com::sun::star::lang::XEventListener
{
    //-------------------------------------------------------------------------

    /** is invoked to check the current data.

        <p>For a given update process, if one of the <type>XUpdateListener</type>s
        vetos the change, the update is canceled, and no further notification happens.</p>

        @param aEvent
            An event dedscriptor specifying the broadcaster of the change.

        @returns
            <TRUE/> when the update was approved, otherwise <FALSE/>.
     */
    boolean approveUpdate( [in] com::sun::star::lang::EventObject aEvent );

    //-------------------------------------------------------------------------

    /** is invoked when an object has finished processing the updates and
        the data has been successfully written.

        @param aEvent
            A event dedscriptor specifying the broadcaster of the change.
     */
    void updated( [in] com::sun::star::lang::EventObject aEvent );

};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif
