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_XBoundComponent_idl__
24#define __com_sun_star_form_XBoundComponent_idl__
25
26#ifndef __com_sun_star_form_XUpdateBroadcaster_idl__
27#include <com/sun/star/form/XUpdateBroadcaster.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module form {
34
35//=============================================================================
36
37/**	specifies a (form) component which is bound to a data source.
38
39	<p>The interface provides the possibility of committing its respective
40	data to a data source it is bound to. A <member>commit</member> will be
41	performed by the environment (usually, a <type>FormController</type>).<br/>
42	For example, suppose you have a data-bound control that is connected
43	to a database field. Each time the control loses its focus, the
44	model (component) of the control is triggered by the environment
45	to store its value in the database field.</p>
46
47	<p>A commit may fail if an <type>XUpdateListener</type> vetoes the it.</p>
48
49	@see com::sun::star::form::XUpdateListener
50 */
51published interface XBoundComponent: com::sun::star::form::XUpdateBroadcaster
52{
53	//-------------------------------------------------------------------------
54
55	/** commits the content of the component into the data source it is bound to.
56
57		@returns
58			<TRUE/> when the commitment was successful, otherwise <FALSE/>.
59	 */
60	boolean commit();
61
62};
63
64//=============================================================================
65
66}; }; }; };
67
68/*=============================================================================
69
70=============================================================================*/
71#endif
72