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_ControlActions_idl__ 29#define __com_sun_star_ui_dialog_ControlActions_idl__ 30 31 32module com { module sun { module star { module ui { module dialogs { 33 34//============================================================================= 35/** Control actions for common and extended controls of a FilePicker. 36 37 @see com::sun::star::ui::dialogs::XFilePickerControlAccess 38 @see com::sun::star::ui::dialogs::CommonFilePickerElementIds 39 @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds 40 */ 41 42published constants ControlActions 43{ 44 //--------------------------------------------------------------------- 45 /** Adds an item to the content of the listbox. The given item has to 46 be a string. 47 */ 48 const short ADD_ITEM = 1; 49 50 //--------------------------------------------------------------------- 51 /** Adds a sequence of strings to the content of the listbox. 52 */ 53 const short ADD_ITEMS = 2; 54 55 //--------------------------------------------------------------------- 56 /** Removes an item from a listbox. The given value has to be a 57 position. If the position is invalid an exception will be thrown. 58 The index of the first position is 0. 59 The value should be a sal_Int32. 60 */ 61 const short DELETE_ITEM = 3; 62 63 //--------------------------------------------------------------------- 64 /** Removes all items from the listbox. 65 */ 66 const short DELETE_ITEMS = 4; 67 68 //--------------------------------------------------------------------- 69 /** Selects an item in a listbox. The given value has to be a position. 70 The index of the first position is 0. A value of -1 removes the 71 selection. 72 If the given position is invalid an exception will be thrown. 73 The value should be a sal_Int32. 74 */ 75 const short SET_SELECT_ITEM = 5; 76 77 //--------------------------------------------------------------------- 78 /** Returns all items of the listbox as a sequence of strings. 79 */ 80 const short GET_ITEMS = 6; 81 82 //--------------------------------------------------------------------- 83 /** Returns the currently selected item. The returned item is an empty 84 string if the listbox is empty or no item is selected. 85 */ 86 const short GET_SELECTED_ITEM = 7; 87 88 //--------------------------------------------------------------------- 89 /** Returns the zero based index of the currently selected item. 90 If the listbox is empty or there is no item selected -1 will be 91 returned. The returned value is a sal_Int32. 92 */ 93 94 const short GET_SELECTED_ITEM_INDEX = 8; 95 96 //--------------------------------------------------------------------- 97 /** Sets the help URL of a control. 98 */ 99 const short SET_HELP_URL = 100; 100 101 //--------------------------------------------------------------------- 102 /** Retrieves the help URL of a control. 103 */ 104 const short GET_HELP_URL = 101; 105}; 106 107//============================================================================= 108 109}; }; }; }; }; 110 111#endif 112