offapi/com/sun/star/form/binding/BindableDatabaseListBox.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 /** This service specifies a list box model which is data-aware and thus can be bound to a
  24     database field, and additionally supports binding to arbitrary external values.
  25
  26     <p>There are six possible ways that a BindableDatabaseListBox exchanges
  27     values with an external binding. If a new binding
  28     is set at a BindableDatabaseListBox, the types from the following list are
  29     tried in descending order: The first type supported by the binding is used for data exchange.
  30     <ol>
  31         <li><em>sequences of `any`s</em>:
  32             The elements in the sequence will represent
  33             the values the selected entries of the list box
  34             (taken from ValueList or read from BoundColumn).
  35             In other words, the SelectedValues property.</li>
  36         <li><em>`any` value</em>:
  37             The value will represent the value of the selected entry
  38             (taken from ValueList or read from BoundColumn).
  39             If more than one entry is selected,
  40             `NULL` will be transferred.
  41             In other words, the SelectedValue property.</li>
  42         <li><em>sequences of long integers</em>: When used, the integers in the sequence will represent
  43             the indexes of the selected entries of the list box.</li>
  44         <li><em>long integer value</em>: When used, the value will represent the index of the selected entry.
  45             If no entry is selected, -1 will be transferred. If more than one entry is selected, `NULL`
  46             will be transferred.</li>
  47         <li><em>sequences of strings</em>: When used, the strings in the sequence present the texts
  48             of the selected entries of the list box.</li>
  49         <li><em>string values</em>: When used. the value will represent the text of the selected entry.
  50             If no entry is selected, an empty string will be transferred. If more than one entry is selected,
  51             `NULL` will be transferred.</li>
  52     </ol></p>
  53
  54     @see com::sun::star::form::binding::XValueBinding::supportsType
  55  */
  56 service BindableDatabaseListBox
  57 {
  58     service com::sun::star::form::component::DatabaseListBox;
  59
  60     /** specifies the interaction between an internal binding to a database column,
  61         and an external value binding.</p>
  62     */
  63     service com::sun::star::form::binding::BindableDataAwareControlModel;
  64
  65 };
  66
  67
  68 }; }; }; }; };
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */