offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ListboxControlActions.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_dialog_ListboxControlActions_idl__
  32 #define __com_sun_star_ui_dialog_ListboxControlActions_idl__
  33
  34
  35 module com { module sun { module star { module ui { module dialogs {
  36
  37 //=============================================================================
  38 /** These constants are deprecated and should not be used anymore. They're superseeded
  39     by <type>ControlActions</type>.
  40     @deprecated
  41  */
  42
  43 published constants ListboxControlActions
  44 {
  45     //---------------------------------------------------------------------
  46     /** Adds an item to the content of the listbox. The given item has to
  47         be a string.
  48      */
  49     const short ADD_ITEM        = 1;
  50
  51     //---------------------------------------------------------------------
  52     /** Adds a sequence of strings to the content of the listbox.
  53      */
  54     const short ADD_ITEMS           = 2;
  55
  56     //---------------------------------------------------------------------
  57     /** Removes an item from a listbox. The given value has to be a
  58         position. If the position is invalid an exception will be thrown.
  59         The index of the first position is 0.
  60         The value should be a sal_Int32.
  61      */
  62     const short DELETE_ITEM     = 3;
  63
  64     //---------------------------------------------------------------------
  65     /** Removes all items from the listbox.
  66     */
  67     const short DELETE_ITEMS    = 4;
  68
  69     //---------------------------------------------------------------------
  70     /** Selects an item in a listbox. The given value has to be a position.
  71         The index of the first position is 0. A value of -1 removes the
  72         selection.
  73         If the given position is invalid an exception will be thrown.
  74         The value should be a sal_Int32.
  75      */
  76     const short SET_SELECT_ITEM = 5;
  77
  78     //---------------------------------------------------------------------
  79     /** Returns all items of the listbox as a sequence of strings.
  80     */
  81     const short GET_ITEMS       = 6;
  82
  83     //---------------------------------------------------------------------
  84     /** Returns the currently selected item. The returned item is an empty
  85         string if the listbox is empty or no item is selected.
  86      */
  87     const short GET_SELECTED_ITEM = 7;
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; }; };
  93
  94 #endif