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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_ui_dialog_ControlActions_idl__
  30 #define __com_sun_star_ui_dialog_ControlActions_idl__
  31
  32
  33 module com { module sun { module star { module ui { module dialogs {
  34
  35 //=============================================================================
  36 /** Control actions for common and extended controls of a FilePicker.
  37
  38     @see com::sun::star::ui::dialogs::XFilePickerControlAccess
  39     @see com::sun::star::ui::dialogs::CommonFilePickerElementIds
  40     @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
  41  */
  42
  43 published constants ControlActions
  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     /** Returns the zero based index of the currently selected item.
  91         If the listbox is empty or there is no item selected -1 will be
  92         returned. The returned value is a sal_Int32.
  93      */
  94
  95     const short GET_SELECTED_ITEM_INDEX = 8;
  96
  97     //---------------------------------------------------------------------
  98     /** Sets the help URL of a control.
  99      */
 100     const short SET_HELP_URL = 100;
 101
 102     //---------------------------------------------------------------------
 103     /** Retrieves the help URL of a control.
 104      */
 105     const short GET_HELP_URL = 101;
 106 };
 107
 108 //=============================================================================
 109
 110 }; }; }; }; };
 111
 112 #endif
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */