/*************************************************************************
 *
 *  $RCSfile: XUpdateListener.idl,v $
 *
 *  $Revision: 1.5.18.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:43:17 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#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
 */
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 ); 
 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*============================================================================= 
 
	$Log: XUpdateListener.idl,v $
	Revision 1.5.18.2  2003/01/21 17:43:17  mi
	merged src641 odk changes
	
	Revision 1.6  2002/10/03 13:04:36  mi
	#94968# IDL reviews merged
	
	Revision 1.5.16.3  2002/07/26 10:00:16  fs
	IDL review form layer
	
	Revision 1.5.16.2  2002/02/18 15:23:19  oj
	#96946# parameter,return value and exception description
	
	Revision 1.5.16.1  2002/02/18 14:51:48  oj
	#96946# parameter,return value and exception description
	
	Revision 1.5  2001/03/16 16:41:23  jsc
	remove interfaceheader with uik and remove [const] in method definitions
	
	Revision 1.4  2000/12/21 08:35:08  mi
	@see interface/service/... ident -> @see ident - for new docu generator
	
	Revision 1.3  2000/11/08 12:42:53  mi
	moved from api
	
	Revision 1.2  2000/10/09 14:24:55  mi
	#78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)
	
	Revision 1.1.1.1  2000/09/18 23:35:18  hjs
	initial import
	
	Revision 1.4  2000/09/11 11:52:26  mi
	documentation merged from XML
	 
	Revision 1.2  2000/03/31 07:40:22  dg 
	#74028# documentation completed 
	 
	Revision 1.1.1.1  1999/11/11 09:48:42  jsc 
	new 
 
 
=============================================================================*/ 
#endif 
