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