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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_form_component_DatabasePatternField_idl__
  20 #define __com_sun_star_form_component_DatabasePatternField_idl__
  21
  22 #include <com/sun/star/form/component/PatternField.idl>
  23
  24 #include <com/sun/star/form/DataAwareControlModel.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module form {  module component {
  29
  30
  31 /** This service specifies a data-aware control model for entering text which matches a specific
  32     pattern.
  33  */
  34 published service DatabasePatternField
  35 {
  36     service com::sun::star::form::component::PatternField;
  37
  38     service com::sun::star::form::DataAwareControlModel;
  39
  40
  41     /** determines if an empty text should be treated as a `NULL` value.
  42
  43         <p>When the user enters text into a pattern field, and after this, the control
  44         content is to be committed into the database field the control is bound to,
  45         a decision must be made how to deal with empty strings.<br/>
  46         This is controlled by this property.</p>
  47
  48         <p>If the property is set to `TRUE`, and an empty text is to be committed, this is
  49         converted into `NULL`, else it is written as empty string.</p>
  50      */
  51     [property] boolean ConvertEmptyToNull;
  52
  53 };
  54
  55
  56 }; }; }; }; };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */