LibreOffice
LibreOffice 7.2 SDK API Reference
XListBox.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef __com_sun_star_awt_XListBox_idl__
20 #define __com_sun_star_awt_XListBox_idl__
21 
23 
25 
27 
28 
29 
30  module com { module sun { module star { module awt {
31 
32 
37 {
38 
42 
43 
47 
48 
52 
53 
57 
58 
61  void addItem( [in] string aItem,
62  [in] short nPos );
63 
64 
67  void addItems( [in] sequence<string> aItems,
68  [in] short nPos );
69 
70 
73  void removeItems( [in] short nPos,
74  [in] short nCount );
75 
76 
79  short getItemCount();
80 
81 
84  string getItem( [in] short nPos );
85 
86 
89  sequence<string> getItems();
90 
91 
97 
98 
101  sequence<short> getSelectedItemsPos();
102 
103 
108  string getSelectedItem();
109 
110 
113  sequence<string> getSelectedItems();
114 
115 
118  void selectItemPos( [in] short nPos,
119  [in] boolean bSelect );
120 
121 
124  void selectItemsPos( [in] sequence<short> aPositions,
125  [in] boolean bSelect );
126 
127 
130  void selectItem( [in] string aItem,
131  [in] boolean bSelect );
132 
133 
137  boolean isMutipleMode();
138 
139 
142  void setMultipleMode( [in] boolean bMulti );
143 
144 
148 
149 
152  void setDropDownLineCount( [in] short nLines );
153 
154 
157  void makeVisible( [in] short nEntry );
158 
159 };
160 
161 
162 }; }; }; };
163 
164 #endif
165 
166 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
makes it possible to receive action events.
Definition: XActionListener.idl:34
makes it possible to receive events from a component when the state of an item changes.
Definition: XItemListener.idl:35
gives access to the items of a list box and makes it possible to register item and action event liste...
Definition: XListBox.idl:37
short getItemCount()
returns the number of items in the listbox.
sequence< string > getSelectedItems()
returns all currently selected items.
string getItem([in] short nPos)
returns the item at the specified position.
short getDropDownLineCount()
returns the number of visible lines in drop down mode.
void selectItemsPos([in] sequence< short > aPositions, [in] boolean bSelect)
selects/deselects multiple items at the specified positions.
void removeItems([in] short nPos, [in] short nCount)
removes a number of items at the specified position.
void removeActionListener([in] com::sun::star::awt::XActionListener l)
unregisters a listener for action events.
string getSelectedItem()
returns the currently selected item.
void addItems([in] sequence< string > aItems, [in] short nPos)
adds multiple items at the specified position.
boolean isMutipleMode()
returns TRUE if multiple items can be selected, FALSE if only one item can be selected.
void addItemListener([in] com::sun::star::awt::XItemListener l)
registers a listener for item events.
sequence< string > getItems()
returns all items of the list box.
void makeVisible([in] short nEntry)
makes the item at the specified position visible by scrolling.
void addActionListener([in] com::sun::star::awt::XActionListener l)
registers a listener for action events.
short getSelectedItemPos()
returns the position of the currently selected item.
void setDropDownLineCount([in] short nLines)
sets the number of visible lines for drop down mode.
void removeItemListener([in] com::sun::star::awt::XItemListener l)
unregisters a listener for item events.
void setMultipleMode([in] boolean bMulti)
determines if only a single item or multiple items can be selected.
void selectItemPos([in] short nPos, [in] boolean bSelect)
selects/deselects the item at the specified position.
void selectItem([in] string aItem, [in] boolean bSelect)
selects/deselects the specified item.
void addItem([in] string aItem, [in] short nPos)
adds an item at the specified position.
sequence< short > getSelectedItemsPos()
returns the positions of all currently selected items.
base interface of all UNO interfaces
Definition: XInterface.idl:48
Definition: Ambiguous.idl:22