offapi/com/sun/star/awt/XListBox.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: XListBox.idl,v $
  10  * $Revision: 1.8 $
  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_awt_XListBox_idl__
  31 #define __com_sun_star_awt_XListBox_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XItemListener_idl__
  38 #include <com/sun/star/awt/XItemListener.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_XActionListener_idl__
  42 #include <com/sun/star/awt/XActionListener.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module awt {
  49
  50 //=============================================================================
  51
  52 /** gives access to the items of a list box and makes it possible to
  53     register item and action event listeners.
  54  */
  55 published interface XListBox: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** registers a listener for item events.
  60      */
  61     [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l );
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** unregisters a listener for item events.
  66      */
  67     [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l );
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** registers a listener for action events.
  72      */
  73     [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** unregisters a listener for action events.
  78      */
  79     [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l );
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** adds an item at the specified position.
  84      */
  85     [oneway] void addItem( [in] string aItem,
  86              [in] short nPos );
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** adds multiple items at the specified position.
  91      */
  92     [oneway] void addItems( [in] sequence<string> aItems,
  93              [in] short nPos );
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** removes a number of items at the specified position.
  98      */
  99     [oneway] void removeItems( [in] short nPos,
 100              [in] short nCount );
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** returns the number of items in the listbox.
 105      */
 106     short getItemCount();
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** returns the item at the specified position.
 111      */
 112     string getItem( [in] short nPos );
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** returns all items of the list box.
 117      */
 118     sequence<string> getItems();
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** returns the position of the currently selected item.
 123      */
 124     short getSelectedItemPos();
 125
 126     //-------------------------------------------------------------------------
 127
 128     /** returns the positions of all currently selected items.
 129      */
 130     sequence<short> getSelectedItemsPos();
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** returns the currently selected item.
 135      */
 136     string getSelectedItem();
 137
 138     //-------------------------------------------------------------------------
 139
 140     /** returns all currently selected items.
 141      */
 142     sequence<string> getSelectedItems();
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** selects/deselects the item at the specified position.
 147      */
 148     [oneway] void selectItemPos( [in] short nPos,
 149              [in] boolean bSelect );
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** selects/deselects multiple items at the specified positions.
 154      */
 155     [oneway] void selectItemsPos( [in] sequence<short> aPositions,
 156              [in] boolean bSelect );
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** selects/deselects the specified item.
 161      */
 162     [oneway] void selectItem( [in] string aItem,
 163              [in] boolean bSelect );
 164
 165     //-------------------------------------------------------------------------
 166
 167     /** returns <true/> if multiple items can be selected,
 168         <false/> if only one item can be selected.
 169      */
 170     boolean isMutipleMode();
 171
 172     //-------------------------------------------------------------------------
 173
 174     /** determines if only a single item or multiple items can be selected.
 175      */
 176     [oneway] void setMultipleMode( [in] boolean bMulti );
 177
 178     //-------------------------------------------------------------------------
 179
 180     /** returns the number of visible lines in drop down mode.
 181      */
 182     short getDropDownLineCount();
 183
 184     //-------------------------------------------------------------------------
 185
 186     /** sets the number of visible lines for drop down mode.
 187      */
 188     [oneway] void setDropDownLineCount( [in] short nLines );
 189
 190     //-------------------------------------------------------------------------
 191
 192     /** makes the item at the specified position visible by scrolling.
 193      */
 194     [oneway] void makeVisible( [in] short nEntry );
 195
 196 };
 197
 198 //=============================================================================
 199
 200 }; }; }; };
 201
 202 #endif