offapi/com/sun/star/form/binding/BindableDatabaseComboBox.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
  20
  21 module com {  module sun {  module star {  module form {  module binding {
  22
  23
  24 /** This service specifies a model of a combo box (a list box combined with a text
  25     input field) which is data-aware and thus can be bound to a database field,
  26     and additionally supports binding to arbitrary external values.
  27
  28     <p>If a com::sun::star::form::binding::ValueBinding instance is
  29     set at the field, it will exchange it's text with the binding as <em>string</em>, thus only
  30     bindings supporting string exchange will be accepted in
  31     com::sun::star::form::binding::XValueBinding::setValueBinding().
  32     </p>
  33
  34     @see com::sun::star::form::binding::XValueBinding::supportsType
  35     @see com::sun::star::awt::UnoControlComboBoxModel::Text
  36  */
  37 service BindableDatabaseComboBox
  38 {
  39     service com::sun::star::form::component::DatabaseComboBox;
  40
  41     /** specifies the interaction between an internal binding to a database column,
  42         and an external value binding.</p>
  43     */
  44     service com::sun::star::form::binding::BindableDataAwareControlModel;
  45
  46 };
  47
  48
  49 }; }; }; }; };
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */