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