xref: /AOO41X/main/offapi/com/sun/star/awt/XComboBox.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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_XComboBox_idl__
28#define __com_sun_star_awt_XComboBox_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 combo box and makes it possible to
50	register item and action event listeners.
51 */
52published interface XComboBox: 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, [in] short nPos );
83
84	//-------------------------------------------------------------------------
85
86	/** adds multiple items at the specified position.
87	 */
88	[oneway] void addItems( [in] sequence<string> aItems, [in] short nPos );
89
90	//-------------------------------------------------------------------------
91
92	/** removes a number of items at the specified position.
93	 */
94	[oneway] void removeItems( [in] short nPos, [in] short nCount );
95
96	//-------------------------------------------------------------------------
97
98	/** returns the number of items in the combo box.
99	 */
100	short getItemCount();
101
102	//-------------------------------------------------------------------------
103
104	/** returns the item at the specified position.
105	 */
106	string getItem( [in] short nPos );
107
108	//-------------------------------------------------------------------------
109
110	/** returns all items of the combo box.
111	 */
112	sequence<string> getItems();
113
114	//-------------------------------------------------------------------------
115
116	/** returns the number of visible lines in the drop down mode.
117	 */
118	short getDropDownLineCount();
119
120	//-------------------------------------------------------------------------
121
122	/** sets the number of visible lines for drop down mode.
123	 */
124	[oneway] void setDropDownLineCount( [in] short nLines );
125
126};
127
128//=============================================================================
129
130}; }; }; };
131
132#endif
133