offapi/com/sun/star/form/component/DatabaseComboBox.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_DatabaseComboBox_idl__
  20 #define __com_sun_star_form_component_DatabaseComboBox_idl__
  21
  22 #include <com/sun/star/form/component/ComboBox.idl>
  23
  24 #include <com/sun/star/form/DataAwareControlModel.idl>
  25
  26 #include <com/sun/star/form/ListSourceType.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module form {  module component {
  31
  32
  33 /** This service specifies a combo box which is data-aware, and can be bound to a database field.
  34
  35     <p>Like most other data aware controls, such a combo box will display the actual content
  36     of the field it is bound to. In addition, as a combo box contains a list where the user
  37     can choose items to fill into the control, this list can be filled with different data from
  38     a database, too.</p>
  39  */
  40 published service DatabaseComboBox
  41 {
  42     service com::sun::star::form::component::ComboBox;
  43
  44     service com::sun::star::form::DataAwareControlModel;
  45
  46
  47     /** determines if an empty text should be treated as a `NULL` value.
  48
  49         <p>When the user enters text into a combo box, and after this, the control
  50         content is to be committed into the database field the control is bound to,
  51         a decision must be made how to deal with empty strings.<br/>
  52         This is controlled by #ConvertEmptyToNull.</p>
  53
  54         <p>If the property is set to `TRUE`, and an empty text is to be committed, this is
  55         converted into `NULL`, else it is written as empty string.</p>
  56      */
  57     [property] boolean ConvertEmptyToNull;
  58
  59     /** describes the source of items in the combo box's list.
  60
  61         <p>The concrete meaning of this property depends on the value of #ListSourceType</p>
  62      */
  63     [property] string ListSource;
  64
  65     /** specifies the kind of list source.
  66
  67         <p>Note: A value of com::sun::star::form::ListSourceType::VALUELIST
  68         is not valid for a combo box. It won't be rejected when setting it, but controls will usually ignore it
  69         and leave the list empty.</p>
  70      */
  71     [property] com::sun::star::form::ListSourceType ListSourceType;
  72 };
  73
  74
  75 }; }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */