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_XUpdateListener_idl__
24#define __com_sun_star_form_XUpdateListener_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 module com { module sun { module star { module form {
37
38//=============================================================================
39
40/** used to listen on objects which allow updating their data.
41	<p>In addition to just get notified when an data update happened, the listener
42	has a chance to veto updates <em>before</em> they happen.</p>
43
44	@see XUpdateBroadcaster
45 */
46published interface XUpdateListener: com::sun::star::lang::XEventListener
47{
48	//-------------------------------------------------------------------------
49
50	/** is invoked to check the current data.
51
52		<p>For a given update process, if one of the <type>XUpdateListener</type>s
53		vetos the change, the update is canceled, and no further notification happens.</p>
54
55		@param aEvent
56			An event descriptor specifying the broadcaster of the change.
57
58		@returns
59			<TRUE/> when the update was approved, otherwise <FALSE/>.
60	 */
61	boolean approveUpdate( [in] com::sun::star::lang::EventObject aEvent );
62
63	//-------------------------------------------------------------------------
64
65	/** is invoked when an object has finished processing the updates and
66		the data has been successfully written.
67
68		@param aEvent
69			A event descriptor specifying the broadcaster of the change.
70	 */
71	void updated( [in] com::sun::star::lang::EventObject aEvent );
72
73};
74
75//=============================================================================
76
77}; }; }; };
78
79/*=============================================================================
80
81=============================================================================*/
82
83#endif
84