/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DatabaseComboBox.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 00:37:45 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_form_component_DatabaseComboBox_idl__
#define __com_sun_star_form_component_DatabaseComboBox_idl__

#ifndef __com_sun_star_form_component_ComboBox_idl__
#include <com/sun/star/form/component/ComboBox.idl>
#endif

#ifndef __com_sun_star_form_DataAwareControlModel_idl__
#include <com/sun/star/form/DataAwareControlModel.idl>
#endif

#ifndef __com_sun_star_form_ListSourceType_idl__
#include <com/sun/star/form/ListSourceType.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module form {  module component {

//=============================================================================

/** This service specifies a combo box which is data-aware, and can be bound to a database field.

    <p>Like most other data aware controls, such a combo box will display the actual content
    of the field it is bound to. In addition, as a combo box contains a list where the user
    can choose items to fill into the control, this list can be filled with different data from
    a database, too.</p>
 */
published service DatabaseComboBox
{
    service com::sun::star::form::component::ComboBox;

    service com::sun::star::form::DataAwareControlModel;

    //-------------------------------------------------------------------------

    /** determines if an empty text should be treated as a <NULL/> value.

        <p>When the user enters text into a combo box, and after this, the control
        content is to be committed into the database field the control is bound to,
        a decision must be made how to deal with empty strings.<br/>
        This is controlled by <member>ConvertEmptyToNull</member>.</p>

        <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is
        converted into <NULL/>, else it is written as empty string.</p>
     */
    [property] boolean ConvertEmptyToNull;

    /** describes the source of items in the combo box' list.

        <p>The concrete meaning of this property depends on the value of <member>ListSourceType</member></p>
     */
    [property] string ListSource;
    //-------------------------------------------------------------------------

    /** specifies the kind of list source.

        <p>Note: A value of <member scope="com::sun::star::form">ListSourceType::VALUELIST</member>
        is not valid for a combo box. It won't be rejected when setting it, but controls will usually ignore it
        and leave the list empty.</p>
     */
    [property] com::sun::star::form::ListSourceType ListSourceType;
};

//=============================================================================

}; }; }; }; };

#endif
