1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_awt_XListBox_idl__ 28#define __com_sun_star_awt_XListBox_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_awt_XItemListener_idl__ 35#include <com/sun/star/awt/XItemListener.idl> 36#endif 37 38#ifndef __com_sun_star_awt_XActionListener_idl__ 39#include <com/sun/star/awt/XActionListener.idl> 40#endif 41 42 43//============================================================================= 44 45 module com { module sun { module star { module awt { 46 47//============================================================================= 48 49/** gives access to the items of a list box and makes it possible to 50 register item and action event listeners. 51 */ 52published interface XListBox: com::sun::star::uno::XInterface 53{ 54 //------------------------------------------------------------------------- 55 56 /** registers a listener for item events. 57 */ 58 [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l ); 59 60 //------------------------------------------------------------------------- 61 62 /** unregisters a listener for item events. 63 */ 64 [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l ); 65 66 //------------------------------------------------------------------------- 67 68 /** registers a listener for action events. 69 */ 70 [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l ); 71 72 //------------------------------------------------------------------------- 73 74 /** unregisters a listener for action events. 75 */ 76 [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l ); 77 78 //------------------------------------------------------------------------- 79 80 /** adds an item at the specified position. 81 */ 82 [oneway] void addItem( [in] string aItem, 83 [in] short nPos ); 84 85 //------------------------------------------------------------------------- 86 87 /** adds multiple items at the specified position. 88 */ 89 [oneway] void addItems( [in] sequence<string> aItems, 90 [in] short nPos ); 91 92 //------------------------------------------------------------------------- 93 94 /** removes a number of items at the specified position. 95 */ 96 [oneway] void removeItems( [in] short nPos, 97 [in] short nCount ); 98 99 //------------------------------------------------------------------------- 100 101 /** returns the number of items in the listbox. 102 */ 103 short getItemCount(); 104 105 //------------------------------------------------------------------------- 106 107 /** returns the item at the specified position. 108 */ 109 string getItem( [in] short nPos ); 110 111 //------------------------------------------------------------------------- 112 113 /** returns all items of the list box. 114 */ 115 sequence<string> getItems(); 116 117 //------------------------------------------------------------------------- 118 119 /** returns the position of the currently selected item. 120 */ 121 short getSelectedItemPos(); 122 123 //------------------------------------------------------------------------- 124 125 /** returns the positions of all currently selected items. 126 */ 127 sequence<short> getSelectedItemsPos(); 128 129 //------------------------------------------------------------------------- 130 131 /** returns the currently selected item. 132 */ 133 string getSelectedItem(); 134 135 //------------------------------------------------------------------------- 136 137 /** returns all currently selected items. 138 */ 139 sequence<string> getSelectedItems(); 140 141 //------------------------------------------------------------------------- 142 143 /** selects/deselects the item at the specified position. 144 */ 145 [oneway] void selectItemPos( [in] short nPos, 146 [in] boolean bSelect ); 147 148 //------------------------------------------------------------------------- 149 150 /** selects/deselects multiple items at the specified positions. 151 */ 152 [oneway] void selectItemsPos( [in] sequence<short> aPositions, 153 [in] boolean bSelect ); 154 155 //------------------------------------------------------------------------- 156 157 /** selects/deselects the specified item. 158 */ 159 [oneway] void selectItem( [in] string aItem, 160 [in] boolean bSelect ); 161 162 //------------------------------------------------------------------------- 163 164 /** returns <true/> if multiple items can be selected, 165 <false/> if only one item can be selected. 166 */ 167 boolean isMutipleMode(); 168 169 //------------------------------------------------------------------------- 170 171 /** determines if only a single item or multiple items can be selected. 172 */ 173 [oneway] void setMultipleMode( [in] boolean bMulti ); 174 175 //------------------------------------------------------------------------- 176 177 /** returns the number of visible lines in drop down mode. 178 */ 179 short getDropDownLineCount(); 180 181 //------------------------------------------------------------------------- 182 183 /** sets the number of visible lines for drop down mode. 184 */ 185 [oneway] void setDropDownLineCount( [in] short nLines ); 186 187 //------------------------------------------------------------------------- 188 189 /** makes the item at the specified position visible by scrolling. 190 */ 191 [oneway] void makeVisible( [in] short nEntry ); 192 193}; 194 195//============================================================================= 196 197}; }; }; }; 198 199#endif 200