summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/awt/XListBox.idl
blob: d11d8a08e895786f50189d99423fad24fc0fece3 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_awt_XListBox_idl__
#define __com_sun_star_awt_XListBox_idl__

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

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

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



 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.
     */
    void addItemListener( [in] com::sun::star::awt::XItemListener l );


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


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


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


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


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


    /** removes a number of items at the specified position.
     */
    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.
        When multiple items are selected, the position of the first one is returned.
        When nothing is selected, -1 is returned.
     */
    short getSelectedItemPos();


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


    /** returns the currently selected item.
        When multiple items are selected, the first one is returned.
        When nothing is selected, an empty string is returned.
     */
    string getSelectedItem();


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


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


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


    /** selects/deselects the specified item.
     */
    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.
     */
    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.
     */
    void setDropDownLineCount( [in] short nLines );


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

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */