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