offapi/com/sun/star/form/component/DatabasePatternField.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_form_component_DatabasePatternField_idl__
  28 #define __com_sun_star_form_component_DatabasePatternField_idl__
  29
  30 #ifndef __com_sun_star_form_component_PatternField_idl__
  31 #include <com/sun/star/form/component/PatternField.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_form_DataAwareControlModel_idl__
  35 #include <com/sun/star/form/DataAwareControlModel.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module form {  module component {
  42
  43 //=============================================================================
  44
  45 /** This service specifies a data-aware control model for entering text which matches a specific
  46     pattern.
  47  */
  48 published service DatabasePatternField
  49 {
  50     service com::sun::star::form::component::PatternField;
  51
  52     service com::sun::star::form::DataAwareControlModel;
  53
  54     //-------------------------------------------------------------------------
  55
  56     /** determines if an empty text should be treated as a <NULL/> value.
  57
  58         <p>When the user enters text into a pattern field, and after this, the control
  59         content is to be committed into the database field the control is bound to,
  60         a decision must be made how to deal with empty strings.<br/>
  61         This is controlled by this property.</p>
  62
  63         <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is
  64         converted into <NULL/>, else it is written as empty string.</p>
  65      */
  66     [property] boolean ConvertEmptyToNull;
  67
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; }; };
  73
  74 #endif