xref: /AOO41X/main/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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
28#ifndef __com_sun_star_ui_dialog_ListboxControlActions_idl__
29#define __com_sun_star_ui_dialog_ListboxControlActions_idl__
30
31
32module com { module sun { module star { module ui { module dialogs {
33
34//=============================================================================
35/** These constants are deprecated and should not be used anymore. They're superseeded
36	by <type>ControlActions</type>.
37	@deprecated
38 */
39
40published constants ListboxControlActions
41{
42	//---------------------------------------------------------------------
43	/** Adds an item to the content of the listbox. The given item has to
44		be a string.
45	 */
46	const short ADD_ITEM        = 1;
47
48	//---------------------------------------------------------------------
49	/** Adds a sequence of strings to the content of the listbox.
50	 */
51	const short ADD_ITEMS	    = 2;
52
53	//---------------------------------------------------------------------
54	/** Removes an item from a listbox. The given value has to be a
55		position. If the position is invalid an exception will be thrown.
56		The index of the first position is 0.
57		The value should be a sal_Int32.
58	 */
59	const short DELETE_ITEM     = 3;
60
61	//---------------------------------------------------------------------
62	/** Removes all items from the listbox.
63	*/
64	const short DELETE_ITEMS    = 4;
65
66	//---------------------------------------------------------------------
67	/** Selects an item in a listbox. The given value has to be a position.
68		The index of the first position is 0. A value of -1 removes the
69		selection.
70		If the given position is invalid an exception will be thrown.
71		The value should be a sal_Int32.
72	 */
73	const short SET_SELECT_ITEM = 5;
74
75	//---------------------------------------------------------------------
76	/** Returns all items of the listbox as a sequence of strings.
77	*/
78	const short GET_ITEMS       = 6;
79
80	//---------------------------------------------------------------------
81	/** Returns the currently selected item. The returned item is an empty
82		string if the listbox is empty or no item is selected.
83	 */
84	const short GET_SELECTED_ITEM = 7;
85};
86
87//=============================================================================
88
89}; }; }; }; };
90
91#endif
92