offapi/com/sun/star/form/component/ListBox.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
  22  module com {  module sun {  module star {  module form {  module component {
  23
  24
  25 /** specifies a model for a control which allows to choose in a list of alternative values.
  26  */
  27 published service ListBox
  28 {
  29     service com::sun::star::awt::UnoControlListBoxModel;
  30
  31     service com::sun::star::form::FormControlModel;
  32
  33     /** can be used to reset the control to its default state.
  34
  35         @see ListBox::DefaultSelection
  36     */
  37     interface com::sun::star::form::XReset;
  38
  39     /** contains the indexes of entries of the listbox, which should selected
  40         by default.
  41
  42         <p>This selection is used initially or for a reset.</p>
  43
  44         @see com::sun::star::awt::UnoControlListBoxModel::SelectedItems
  45         @see com::sun::star::form::XReset
  46      */
  47     [property] sequence<short> DefaultSelection;
  48
  49
  50     /** contains the values associated to the strings to be displayed
  51         (which are specified by com::sun::star::awt::UnoControlListBoxModel::StringItemList)
  52      */
  53     [property] sequence<string> ListSource;
  54
  55 };
  56
  57
  58 }; }; }; }; };
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */