1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24#ifndef __com_sun_star_ui_dialog_ControlActions_idl__ 25#define __com_sun_star_ui_dialog_ControlActions_idl__ 26 27 28module com { module sun { module star { module ui { module dialogs { 29 30//============================================================================= 31/** Control actions for common and extended controls of a FilePicker. 32 33 @see com::sun::star::ui::dialogs::XFilePickerControlAccess 34 @see com::sun::star::ui::dialogs::CommonFilePickerElementIds 35 @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds 36 */ 37 38published constants ControlActions 39{ 40 //--------------------------------------------------------------------- 41 /** Adds an item to the content of the listbox. The given item has to 42 be a string. 43 */ 44 const short ADD_ITEM = 1; 45 46 //--------------------------------------------------------------------- 47 /** Adds a sequence of strings to the content of the listbox. 48 */ 49 const short ADD_ITEMS = 2; 50 51 //--------------------------------------------------------------------- 52 /** Removes an item from a listbox. The given value has to be a 53 position. If the position is invalid an exception will be thrown. 54 The index of the first position is 0. 55 The value should be a sal_Int32. 56 */ 57 const short DELETE_ITEM = 3; 58 59 //--------------------------------------------------------------------- 60 /** Removes all items from the listbox. 61 */ 62 const short DELETE_ITEMS = 4; 63 64 //--------------------------------------------------------------------- 65 /** Selects an item in a listbox. The given value has to be a position. 66 The index of the first position is 0. A value of -1 removes the 67 selection. 68 If the given position is invalid an exception will be thrown. 69 The value should be a sal_Int32. 70 */ 71 const short SET_SELECT_ITEM = 5; 72 73 //--------------------------------------------------------------------- 74 /** Returns all items of the listbox as a sequence of strings. 75 */ 76 const short GET_ITEMS = 6; 77 78 //--------------------------------------------------------------------- 79 /** Returns the currently selected item. The returned item is an empty 80 string if the listbox is empty or no item is selected. 81 */ 82 const short GET_SELECTED_ITEM = 7; 83 84 //--------------------------------------------------------------------- 85 /** Returns the zero based index of the currently selected item. 86 If the listbox is empty or there is no item selected -1 will be 87 returned. The returned value is a sal_Int32. 88 */ 89 90 const short GET_SELECTED_ITEM_INDEX = 8; 91 92 //--------------------------------------------------------------------- 93 /** Sets the help URL of a control. 94 */ 95 const short SET_HELP_URL = 100; 96 97 //--------------------------------------------------------------------- 98 /** Retrieves the help URL of a control. 99 */ 100 const short GET_HELP_URL = 101; 101}; 102 103//============================================================================= 104 105}; }; }; }; }; 106 107#endif 108