1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_form_XBoundComponent_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_form_XBoundComponent_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_form_XUpdateBroadcaster_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/form/XUpdateBroadcaster.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir//============================================================================= 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir module com { module sun { module star { module form { 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir//============================================================================= 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir/** specifies a (form) component which is bound to a data source. 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir <p>The interface provides the possibility of committing its respective 44*cdf0e10cSrcweir data to a data source it is bound to. A <member>commit</member> will be 45*cdf0e10cSrcweir performed by the environment (usually, a <type>FormController</type>).<br/> 46*cdf0e10cSrcweir For example, suppose you have a data-bound control that is connected 47*cdf0e10cSrcweir to a database field. Each time the control loses its focus, the 48*cdf0e10cSrcweir model (component) of the control is triggered by the environment 49*cdf0e10cSrcweir to store its value in the database field.</p> 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir <p>A commit may fail if an <type>XUpdateListener</type> vetoes the it.</p> 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir @see com::sun::star::form::XUpdateListener 54*cdf0e10cSrcweir */ 55*cdf0e10cSrcweirpublished interface XBoundComponent: com::sun::star::form::XUpdateBroadcaster 56*cdf0e10cSrcweir{ 57*cdf0e10cSrcweir //------------------------------------------------------------------------- 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir /** commits the content of the component into the data source it is bound to. 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir @returns 62*cdf0e10cSrcweir <TRUE/> when the commitment was successful, otherwise <FALSE/>. 63*cdf0e10cSrcweir */ 64*cdf0e10cSrcweir boolean commit(); 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir}; 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir//============================================================================= 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir}; }; }; }; 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir/*============================================================================= 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir=============================================================================*/ 75*cdf0e10cSrcweir#endif 76