AOO410/main/offapi/com/sun/star/form/XSubmitListener.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef __com_sun_star_form_XSubmitListener_idl__ 
#define __com_sun_star_form_XSubmitListener_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 {  
 
//============================================================================= 
 
/** receives notifications about data beeing submitted.
	
	<p>The submission may be cancelled, so the listener has the possibility
	of verifying the data before submission.</p>

	@see XSubmit

    @deprecated
        This interface is superseded by the <type scope="com::sun::star::form::submission">XSubmissionVetoListener</type>
        interface. New implementations should use the latter, if possible.
 */
published interface XSubmitListener: com::sun::star::lang::XEventListener
{ 
	//------------------------------------------------------------------------- 
	 
	/** is invoked when a component is about to submit it's data.

		@param aEvent
			the event happend

		@returns
			<TRUE/> when submitting was approved, otherwise <FALSE/>.
	 */
	boolean approveSubmit( [in] com::sun::star::lang::EventObject rEvent ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
=============================================================================*/ 
#endif