offapi/com/sun/star/form/component/DatabaseComboBox.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: DatabaseComboBox.idl,v $
  10  * $Revision: 1.10 $
  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_DatabaseComboBox_idl__
  31 #define __com_sun_star_form_component_DatabaseComboBox_idl__
  32
  33 #ifndef __com_sun_star_form_component_ComboBox_idl__
  34 #include <com/sun/star/form/component/ComboBox.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_DataAwareControlModel_idl__
  38 #include <com/sun/star/form/DataAwareControlModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_form_ListSourceType_idl__
  42 #include <com/sun/star/form/ListSourceType.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module form {  module component {
  49
  50 //=============================================================================
  51
  52 /** This service specifies a combo box which is data-aware, and can be bound to a database field.
  53
  54     <p>Like most other data aware controls, such a combo box will display the actual content
  55     of the field it is bound to. In addition, as a combo box contains a list where the user
  56     can choose items to fill into the control, this list can be filled with different data from
  57     a database, too.</p>
  58  */
  59 published service DatabaseComboBox
  60 {
  61     service com::sun::star::form::component::ComboBox;
  62
  63     service com::sun::star::form::DataAwareControlModel;
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** determines if an empty text should be treated as a <NULL/> value.
  68
  69         <p>When the user enters text into a combo box, and after this, the control
  70         content is to be committed into the database field the control is bound to,
  71         a decision must be made how to deal with empty strings.<br/>
  72         This is controlled by <member>ConvertEmptyToNull</member>.</p>
  73
  74         <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is
  75         converted into <NULL/>, else it is written as empty string.</p>
  76      */
  77     [property] boolean ConvertEmptyToNull;
  78
  79     /** describes the source of items in the combo box' list.
  80
  81         <p>The concrete meaning of this property depends on the value of <member>ListSourceType</member></p>
  82      */
  83     [property] string ListSource;
  84     //-------------------------------------------------------------------------
  85
  86     /** specifies the kind of list source.
  87
  88         <p>Note: A value of <member scope="com::sun::star::form">ListSourceType::VALUELIST</member>
  89         is not valid for a combo box. It won't be rejected when setting it, but controls will usually ignore it
  90         and leave the list empty.</p>
  91      */
  92     [property] com::sun::star::form::ListSourceType ListSourceType;
  93 };
  94
  95 //=============================================================================
  96
  97 }; }; }; }; };
  98
  99 #endif