offapi/com/sun/star/awt/XComboBox.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 #ifndef __com_sun_star_awt_XComboBox_idl__
  20 #define __com_sun_star_awt_XComboBox_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/XItemListener.idl>
  25
  26 #include <com/sun/star/awt/XActionListener.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module awt {
  31
  32
  33 /** gives access to the items of a combo box and makes it possible to
  34     register item and action event listeners.
  35  */
  36 published interface XComboBox: com::sun::star::uno::XInterface
  37 {
  38
  39     /** registers a listener for item events.
  40      */
  41     void addItemListener( [in] com::sun::star::awt::XItemListener l );
  42
  43
  44     /** unregisters a listener for item events.
  45      */
  46     void removeItemListener( [in] com::sun::star::awt::XItemListener l );
  47
  48
  49     /** registers a listener for action events.
  50      */
  51     void addActionListener( [in] com::sun::star::awt::XActionListener l );
  52
  53
  54     /** unregisters a listener for action events.
  55      */
  56     void removeActionListener( [in] com::sun::star::awt::XActionListener l );
  57
  58
  59     /** adds an item at the specified position.
  60      */
  61     void addItem( [in] string aItem, [in] short nPos );
  62
  63
  64     /** adds multiple items at the specified position.
  65      */
  66     void addItems( [in] sequence<string> aItems, [in] short nPos );
  67
  68
  69     /** removes a number of items at the specified position.
  70      */
  71     void removeItems( [in] short nPos, [in] short nCount );
  72
  73
  74     /** returns the number of items in the combo box.
  75      */
  76     short getItemCount();
  77
  78
  79     /** returns the item at the specified position.
  80      */
  81     string getItem( [in] short nPos );
  82
  83
  84     /** returns all items of the combo box.
  85      */
  86     sequence<string> getItems();
  87
  88
  89     /** returns the number of visible lines in the drop down mode.
  90      */
  91     short getDropDownLineCount();
  92
  93
  94     /** sets the number of visible lines for drop down mode.
  95      */
  96     void setDropDownLineCount( [in] short nLines );
  97
  98 };
  99
 100
 101 }; }; }; };
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */