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