offapi/com/sun/star/form/component/ListBox.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: ListBox.idl,v $
  10  * $Revision: 1.11 $
  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 #ifndef __com_sun_star_form_component_ListBox_idl__
  31 #define __com_sun_star_form_component_ListBox_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControlListBoxModel_idl__
  34 #include <com/sun/star/awt/UnoControlListBoxModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_form_FormControlModel_idl__
  38 #include <com/sun/star/form/FormControlModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_form_XReset_idl__
  42 #include <com/sun/star/form/XReset.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module form {  module component {
  49
  50 //=============================================================================
  51
  52 /** specifies a model for a control which allows to choose in a list of alternative values.
  53  */
  54 published service ListBox
  55 {
  56     service com::sun::star::awt::UnoControlListBoxModel;
  57
  58     service com::sun::star::form::FormControlModel;
  59
  60     /** can be used to reset the control to it's default state.
  61
  62         @see ListBox::DefaultSelection
  63     */
  64     interface com::sun::star::form::XReset;
  65
  66     /** contains the indexes of entries of the listbox, which should selected
  67         by default.
  68
  69         <p>This selection is used initially or for a reset.</p>
  70
  71         @see com::sun::star::awt::UnoControlListBoxModel::SelectedItems
  72         @see com::sun::star::form::XReset
  73      */
  74     [property] sequence<short> DefaultSelection;
  75
  76
  77     /** contains the listbox entries.
  78      */
  79     [property] sequence<string> ListSource;
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; }; };
  86
  87 #endif