summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XListBox.idl
blob: 00506ca2a7dc04fd6fcb4b852461bf335962855a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/*************************************************************************
 *
 *  $RCSfile: XListBox.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:21:05 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XListBox_idl__
#define __com_sun_star_awt_XListBox_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_XItemListener_idl__
#include <com/sun/star/awt/XItemListener.idl>
#endif

#ifndef __com_sun_star_awt_XActionListener_idl__
#include <com/sun/star/awt/XActionListener.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

// DocMerge from xml: interface com::sun::star::awt::XListBox
/** gives access to the items and their state and to register for
    item and action events of a listbox.
 */
[ uik(E227A410-33D6-11D1-AABE00A0-249D5590), ident( "XListBox", 1.0 ) ]
interface XListBox: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::addItemListener
    /** registers an item event listener.
     */
    [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::removeItemListener
    /** unregisters an item event listener.
     */
    [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::addActionListener
    /** registers an action event listener.
     */
    [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::removeActionListener
    /** unregisters an action event listener.
     */
    [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::addItem
    /** adds an item at a specified position.
     */
    [oneway] void addItem( [in] string aItem,
             [in] short nPos );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::addItems
    /** adds multiple items at a specified position.
     */
    [oneway] void addItems( [in] sequence<string> aItems,
             [in] short nPos );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::removeItems
    /** removes a number of items at a specified position.
     */
    [oneway] void removeItems( [in] short nPos,
             [in] short nCount );

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::awt::XListBox::getItemCount
    /** @returns
                    the number of items currently in the listbox.
     */
    short getItemCount();

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::awt::XListBox::getItem
    /** @returns
                    the item at the specified position.
     */
    string getItem( [in] short nPos );

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::awt::XListBox::getItems
    /** @returns
                    all items of the list box.
     */
    sequence<string> getItems();

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::awt::XListBox::getSelectedItemPos
    /** @returns
                    the position of the currently selected item.
     */
    short getSelectedItemPos();

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::awt::XListBox::getSelectedItemsPos
    /** @returns
                    the positions of all currently selected items.
     */
    sequence<short> getSelectedItemsPos();

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::awt::XListBox::getSelectedItem
    /** @returns
                    the currently selected item.
     */
    string getSelectedItem();

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::awt::XListBox::getSelectedItems
    /** @returns
                    all currently selected items.
     */
    sequence<string> getSelectedItems();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::selectItemPos
    /** selects/unselects the item at the specified position.
     */
    [oneway] void selectItemPos( [in] short nPos,
             [in] boolean bSelect );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::selectItemsPos
    /** selects/unselects multiple items at the specified positions.
     */
    [oneway] void selectItemsPos( [in] sequence<short> aPositions,
             [in] boolean bSelect );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::selectItem
    /** selects/unselects the specified item.
     */
    [oneway] void selectItem( [in] string aItem,
             [in] boolean bSelect );

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::awt::XListBox::isMutipleMode
    /** @returns
                    <true/> if multiple items can be selected,
                    <false/> if only one item can be selected.
     */
    boolean isMutipleMode();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::setMultipleMode
    /** determines if only a single item or multiple items can be selected.
     */
    [oneway] void setMultipleMode( [in] boolean bMulti );

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::awt::XListBox::getDropDownLineCount
    /** @returns
                    the number of visible lines in drop down mode.
     */
    short getDropDownLineCount();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::setDropDownLineCount
    /** sets the number of visible lines for drop down mode.
     */
    [oneway] void setDropDownLineCount( [in] short nLines );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XListBox::makeVisible
    /** makes the item at the specified position visible by scolling.
     */
    [oneway] void makeVisible( [in] short nEntry );

};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:34:53  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:08  mi
    documentation merged from XML

    Revision 1.3  2000/05/16 12:19:53  mi
    documentation

    Revision 1.2  2000/02/07 11:24:16  mi
    zu #70728# missing documentation marked

    Revision 1.1.1.1  1999/11/11 09:48:40  jsc
    new


=============================================================================*/
#endif