offapi/com/sun/star/form/component/DatabaseFormattedField.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: DatabaseFormattedField.idl,v $
  10  * $Revision: 1.8 $
  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_component_DatabaseFormattedField_idl__
  31 #define __com_sun_star_form_component_DatabaseFormattedField_idl__
  32
  33 #ifndef __com_sun_star_form_component_FormattedField_idl__
  34 #include <com/sun/star/form/component/FormattedField.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_DataAwareControlModel_idl__
  38 #include <com/sun/star/form/DataAwareControlModel.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module form {  module component {
  45
  46 //=============================================================================
  47
  48 /** This service specifies a formatted field model which is data-aware, and can be bound to a database field.
  49  */
  50 published service DatabaseFormattedField
  51 {
  52     service com::sun::star::form::component::FormattedField;
  53
  54     service com::sun::star::form::DataAwareControlModel;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** determines if an empty text should be treated as a <NULL/> value.
  59
  60         <p>When the user enters text into a formatted field control, and after this, the control
  61         content is to be committed into the database field the control is bound to,
  62         a decision must be made how to deal with empty strings.<br/>
  63         This is controlled by <member>ConvertEmptyToNull</member>.</p>
  64
  65         <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is
  66         converted into <NULL/>, else it is written as empty string.</p>
  67      */
  68     [property] boolean ConvertEmptyToNull;
  69
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; }; };
  75
  76 #endif