xref: /aoo41x/main/offapi/com/sun/star/form/XUpdateBroadcaster.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_form_XUpdateBroadcaster_idl__
#define __com_sun_star_form_XUpdateBroadcaster_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_form_XUpdateListener_idl__
#include <com/sun/star/form/XUpdateListener.idl>
#endif


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

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

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

/** is the broadcaster interface for sending "approveUpdate" and "updated" events.

	<p>The component supporting this interface must do approval calls
	(<member>XUpdateListener::approveUpdate</member>) immediately
	before the data is updated, and notification calls
	(<member>XUpdateListener::updated</member>) immediately afterwards.</p>

	@see XUpdateListener
 */
published interface XUpdateBroadcaster: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** adds the specified listener to receive the events "approveUpdate"
		and "updated".
		@param aListener
			the listener to add.
		@see com::sun::star::form::XUpdateListener
	 */
	[oneway] void addUpdateListener( [in] com::sun::star::form::XUpdateListener aListener );

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

	/** removes the specified listener.
		@param aListener
			the listener to remove.
		@see com::sun::star::form::XUpdateListener
	 */
	[oneway] void removeUpdateListener( [in] com::sun::star::form::XUpdateListener aListener );

};

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

}; }; }; };

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

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