offapi/com/sun/star/form/binding/BindableDatabaseListBox.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: BindableDatabaseListBox.idl,v $
  10  * $Revision: 1.5 $
  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
  31 #ifndef __com_sun_star_form_binding_BindableDatabaseListBox_idl__
  32 #define __com_sun_star_form_binding_BindableDatabaseListBox_idl__
  33
  34 #ifndef __com_sun_star_form_component_DatabaseListBox_idl__
  35 #include <com/sun/star/form/component/DatabaseListBox.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_binding_BindableDataAwareControlModel_idl__
  39 #include <com/sun/star/form/binding/BindableDataAwareControlModel.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module form {  module binding {
  45
  46 //=============================================================================
  47
  48 /** This service specifies a list box model which is data-aware and thus can be bound to a
  49     database field, and additionally supports binding to arbitrary external values.
  50
  51     <p>There are four possible ways how a <type>BindableDatabaseListBox</type> exchanges
  52     values with an external binding, the following lists explains all of them. If a new binding
  53     is set at a <type>BindableDatabaseListBox</type>, the types from the following list are
  54     tried in descending order: The first type supported by the binding is used for data exchange.
  55     <ol><li><em>sequences of integers</em>: When used, the integers in the sequence will represent
  56             the indexes of the selected entries of the list box.</li>
  57         <li><em>integer values</em>: When used, the value will represent the index of the selected entry.
  58             If no entry is selected, -1 will be transfered. If more than one entry is selected, <NULL/>
  59             will be transfered.</li>
  60         <li><em>sequences of strings</em>: When used, the strings in the sequence present the texts
  61             of the selected entries of the list box.</li>
  62         <li><em>string values</em>: When used. the value will represent the text of the selected entry.
  63             If no entry is selected, an empty string will be transfered. If more than one entry is selected,
  64             <NULL/> will be transfered.</li>
  65     </ol></p>
  66
  67     @see com::sun::star::form::binding::XValueBinding::supportsType
  68  */
  69 service BindableDatabaseListBox
  70 {
  71     service com::sun::star::form::component::DatabaseListBox;
  72
  73     /** specifies the interaction between an internal binding to a database column,
  74         and an external value binding.</p>
  75     */
  76     service com::sun::star::form::binding::BindableDataAwareControlModel;
  77
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; }; };
  83
  84 #endif