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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module ui { module dialogs {
  22
  23 /** These constants are deprecated and should not be used anymore. They're superseded
  24     by ControlActions.
  25     @deprecated
  26  */
  27
  28 published constants ListboxControlActions
  29 {
  30     /** Adds an item to the content of the listbox. The given item has to
  31         be a string.
  32      */
  33     const short ADD_ITEM        = 1;
  34
  35     /** Adds a sequence of strings to the content of the listbox.
  36      */
  37     const short ADD_ITEMS       = 2;
  38
  39     /** Removes an item from a listbox. The given value has to be a
  40         position. If the position is invalid an exception will be thrown.
  41         The index of the first position is 0.
  42         The value should be a sal_Int32.
  43      */
  44     const short DELETE_ITEM     = 3;
  45
  46     /** Removes all items from the listbox.
  47     */
  48     const short DELETE_ITEMS    = 4;
  49
  50     /** Selects an item in a listbox. The given value has to be a position.
  51         The index of the first position is 0. A value of -1 removes the
  52         selection.
  53         If the given position is invalid an exception will be thrown.
  54         The value should be a sal_Int32.
  55      */
  56     const short SET_SELECT_ITEM = 5;
  57
  58     /** Returns all items of the listbox as a sequence of strings.
  59     */
  60     const short GET_ITEMS       = 6;
  61
  62     /** Returns the currently selected item. The returned item is an empty
  63         string if the listbox is empty or no item is selected.
  64      */
  65     const short GET_SELECTED_ITEM = 7;
  66 };
  67
  68
  69 }; }; }; }; };
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */