summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XListBox.idl
blob: 32b458d62a2f94589d0ca2b2bab2b41b068596a7 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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 {

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

/** gives access to the items of a list box and makes it possible to
    register item and action event listeners.
 */
published interface XListBox: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** registers a listener for item events.
     */
    [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l );

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

    /** unregisters a listener for item events.
     */
    [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l );

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

    /** registers a listener for action events.
     */
    [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l );

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

    /** unregisters a listener for action events.
     */
    [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l );

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

    /** adds an item at the specified position.
     */
    [oneway] void addItem( [in] string aItem,
             [in] short nPos );

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

    /** adds multiple items at the specified position.
     */
    [oneway] void addItems( [in] sequence<string> aItems,
             [in] short nPos );

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

    /** removes a number of items at the specified position.
     */
    [oneway] void removeItems( [in] short nPos,
             [in] short nCount );

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

    /** returns the number of items in the listbox.
     */
    short getItemCount();

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

    /** returns the item at the specified position.
     */
    string getItem( [in] short nPos );

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

    /** returns all items of the list box.
     */
    sequence<string> getItems();

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

    /** returns the position of the currently selected item.
     */
    short getSelectedItemPos();

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

    /** returns the positions of all currently selected items.
     */
    sequence<short> getSelectedItemsPos();

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

    /** returns the currently selected item.
     */
    string getSelectedItem();

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

    /** returns all currently selected items.
     */
    sequence<string> getSelectedItems();

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

    /** selects/deselects the item at the specified position.
     */
    [oneway] void selectItemPos( [in] short nPos,
             [in] boolean bSelect );

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

    /** selects/deselects multiple items at the specified positions.
     */
    [oneway] void selectItemsPos( [in] sequence<short> aPositions,
             [in] boolean bSelect );

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

    /** selects/deselects the specified item.
     */
    [oneway] void selectItem( [in] string aItem,
             [in] boolean bSelect );

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

    /** returns <true/> if multiple items can be selected,
        <false/> if only one item can be selected.
     */
    boolean isMutipleMode();

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

    /** determines if only a single item or multiple items can be selected.
     */
    [oneway] void setMultipleMode( [in] boolean bMulti );

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

    /** returns the number of visible lines in drop down mode.
     */
    short getDropDownLineCount();

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

    /** sets the number of visible lines for drop down mode.
     */
    [oneway] void setDropDownLineCount( [in] short nLines );

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

    /** makes the item at the specified position visible by scrolling.
     */
    [oneway] void makeVisible( [in] short nEntry );

};

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

}; }; }; };

#endif