1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_form_XSubmitListener_idl__
24#define __com_sun_star_form_XSubmitListener_idl__
25
26#ifndef __com_sun_star_lang_XEventListener_idl__
27#include <com/sun/star/lang/XEventListener.idl>
28#endif
29
30#ifndef __com_sun_star_lang_EventObject_idl__
31#include <com/sun/star/lang/EventObject.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module form {
38
39//=============================================================================
40
41/** receives notifications about data beeing submitted.
42
43	<p>The submission may be cancelled, so the listener has the possibility
44	of verifying the data before submission.</p>
45
46	@see XSubmit
47
48    @deprecated
49        This interface is superseded by the <type scope="com::sun::star::form::submission">XSubmissionVetoListener</type>
50        interface. New implementations should use the latter, if possible.
51 */
52published interface XSubmitListener: com::sun::star::lang::XEventListener
53{
54	//-------------------------------------------------------------------------
55
56	/** is invoked when a component is about to submit it's data.
57
58		@param aEvent
59			the event happend
60
61		@returns
62			<TRUE/> when submitting was approved, otherwise <FALSE/>.
63	 */
64	boolean approveSubmit( [in] com::sun::star::lang::EventObject rEvent );
65
66};
67
68//=============================================================================
69
70}; }; }; };
71
72/*=============================================================================
73
74=============================================================================*/
75#endif
76