offapi/com/sun/star/awt/XListBox.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 #ifndef __com_sun_star_awt_XListBox_idl__
  29 #define __com_sun_star_awt_XListBox_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/awt/XItemListener.idl>
  34
  35 #include <com/sun/star/awt/XActionListener.idl>
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** gives access to the items of a list box and makes it possible to
  45     register item and action event listeners.
  46  */
  47 published interface XListBox: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** registers a listener for item events.
  52      */
  53     [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l );
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** unregisters a listener for item events.
  58      */
  59     [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l );
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** registers a listener for action events.
  64      */
  65     [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l );
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** unregisters a listener for action events.
  70      */
  71     [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l );
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** adds an item at the specified position.
  76      */
  77     [oneway] void addItem( [in] string aItem,
  78              [in] short nPos );
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** adds multiple items at the specified position.
  83      */
  84     [oneway] void addItems( [in] sequence<string> aItems,
  85              [in] short nPos );
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** removes a number of items at the specified position.
  90      */
  91     [oneway] void removeItems( [in] short nPos,
  92              [in] short nCount );
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** returns the number of items in the listbox.
  97      */
  98     short getItemCount();
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** returns the item at the specified position.
 103      */
 104     string getItem( [in] short nPos );
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** returns all items of the list box.
 109      */
 110     sequence<string> getItems();
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** returns the position of the currently selected item.
 115      */
 116     short getSelectedItemPos();
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** returns the positions of all currently selected items.
 121      */
 122     sequence<short> getSelectedItemsPos();
 123
 124     //-------------------------------------------------------------------------
 125
 126     /** returns the currently selected item.
 127      */
 128     string getSelectedItem();
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** returns all currently selected items.
 133      */
 134     sequence<string> getSelectedItems();
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** selects/deselects the item at the specified position.
 139      */
 140     [oneway] void selectItemPos( [in] short nPos,
 141              [in] boolean bSelect );
 142
 143     //-------------------------------------------------------------------------
 144
 145     /** selects/deselects multiple items at the specified positions.
 146      */
 147     [oneway] void selectItemsPos( [in] sequence<short> aPositions,
 148              [in] boolean bSelect );
 149
 150     //-------------------------------------------------------------------------
 151
 152     /** selects/deselects the specified item.
 153      */
 154     [oneway] void selectItem( [in] string aItem,
 155              [in] boolean bSelect );
 156
 157     //-------------------------------------------------------------------------
 158
 159     /** returns <true/> if multiple items can be selected,
 160         <false/> if only one item can be selected.
 161      */
 162     boolean isMutipleMode();
 163
 164     //-------------------------------------------------------------------------
 165
 166     /** determines if only a single item or multiple items can be selected.
 167      */
 168     [oneway] void setMultipleMode( [in] boolean bMulti );
 169
 170     //-------------------------------------------------------------------------
 171
 172     /** returns the number of visible lines in drop down mode.
 173      */
 174     short getDropDownLineCount();
 175
 176     //-------------------------------------------------------------------------
 177
 178     /** sets the number of visible lines for drop down mode.
 179      */
 180     [oneway] void setDropDownLineCount( [in] short nLines );
 181
 182     //-------------------------------------------------------------------------
 183
 184     /** makes the item at the specified position visible by scrolling.
 185      */
 186     [oneway] void makeVisible( [in] short nEntry );
 187
 188 };
 189
 190 //=============================================================================
 191
 192 }; }; }; };
 193
 194 #endif
 195
 196 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */