offapi/com/sun/star/awt/XComboBox.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: XComboBox.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 #ifndef __com_sun_star_awt_XComboBox_idl__
  31 #define __com_sun_star_awt_XComboBox_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XItemListener_idl__
  38 #include <com/sun/star/awt/XItemListener.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_XActionListener_idl__
  42 #include <com/sun/star/awt/XActionListener.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module awt {
  49
  50 //=============================================================================
  51
  52 /** gives access to the items of a combo box and makes it possible to
  53     register item and action event listeners.
  54  */
  55 published interface XComboBox: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** registers a listener for item events.
  60      */
  61     [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l );
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** unregisters a listener for item events.
  66      */
  67     [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l );
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** registers a listener for action events.
  72      */
  73     [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** unregisters a listener for action events.
  78      */
  79     [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l );
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** adds an item at the specified position.
  84      */
  85     [oneway] void addItem( [in] string aItem, [in] short nPos );
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** adds multiple items at the specified position.
  90      */
  91     [oneway] void addItems( [in] sequence<string> aItems, [in] short nPos );
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** removes a number of items at the specified position.
  96      */
  97     [oneway] void removeItems( [in] short nPos, [in] short nCount );
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** returns the number of items in the combo box.
 102      */
 103     short getItemCount();
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** returns the item at the specified position.
 108      */
 109     string getItem( [in] short nPos );
 110
 111     //-------------------------------------------------------------------------
 112
 113     /** returns all items of the combo box.
 114      */
 115     sequence<string> getItems();
 116
 117     //-------------------------------------------------------------------------
 118
 119     /** returns the number of visible lines in the drop down mode.
 120      */
 121     short getDropDownLineCount();
 122
 123     //-------------------------------------------------------------------------
 124
 125     /** sets the number of visible lines for drop down mode.
 126      */
 127     [oneway] void setDropDownLineCount( [in] short nLines );
 128
 129 };
 130
 131 //=============================================================================
 132
 133 }; }; }; };
 134
 135 #endif