offapi/com/sun/star/form/XBoundComponent.idl

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