offapi/com/sun/star/form/binding/BindableDatabaseTextField.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: BindableDatabaseTextField.idl,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef __com_sun_star_form_binding_BindableDatabaseTextField_idl__
  32 #define __com_sun_star_form_binding_BindableDatabaseTextField_idl__
  33
  34 #ifndef __com_sun_star_form_component_DatabaseTextField_idl__
  35 #include <com/sun/star/form/component/DatabaseTextField.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_binding_BindableDataAwareControlModel_idl__
  39 #include <com/sun/star/form/binding/BindableDataAwareControlModel.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module form {  module binding {
  45
  46 //=============================================================================
  47
  48 /** This service specifies a text input field which is data-aware and thus can be bound to a
  49     database field, and additionally supports binding to arbitrary external values.
  50
  51     <p>If an <type scope="com::sun::star::form::binding">ValueBinding</type> instance is
  52     set at the field, it will exchange it's text with the binding as <em>string</em>, thus only
  53     bindings supporting string exchange will be accepted in
  54     <member scope="com::sun::star::form::binding">XValueBinding::setValueBinding</member>.
  55     </p>
  56
  57     @see com::sun::star::form::binding::XValueBinding::supportsType
  58     @see com::sun::star::awt::UnoControlEditModel::Text
  59  */
  60 service BindableDatabaseTextField
  61 {
  62     service com::sun::star::form::component::DatabaseTextField;
  63
  64     /** specifies the interaction between an internal binding to a database column,
  65         and an external value binding.</p>
  66     */
  67     service com::sun::star::form::binding::BindableDataAwareControlModel;
  68
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; }; };
  74
  75 #endif