233 lines
7.8 KiB
Text
233 lines
7.8 KiB
Text
/*************************************************************************
|
|
*
|
|
* $RCSfile: XListBox.idl,v $
|
|
*
|
|
* $Revision: 1.6 $
|
|
*
|
|
* last change: $Author: obo $ $Date: 2004-06-03 17:38:25 $
|
|
*
|
|
* The Contents of this file are made available subject to the terms of
|
|
* either of the following licenses
|
|
*
|
|
* - GNU Lesser General Public License Version 2.1
|
|
* - Sun Industry Standards Source License Version 1.1
|
|
*
|
|
* Sun Microsystems Inc., October, 2000
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2000 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
*
|
|
* Sun Industry Standards Source License Version 1.1
|
|
* =================================================
|
|
* The contents of this file are subject to the Sun Industry Standards
|
|
* Source License Version 1.1 (the "License"); You may not use this file
|
|
* except in compliance with the License. You may obtain a copy of the
|
|
* License at http://www.openoffice.org/license.html.
|
|
*
|
|
* Software provided under this License is provided on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
|
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
|
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
|
* See the License for the specific provisions governing your rights and
|
|
* obligations concerning the Software.
|
|
*
|
|
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
|
*
|
|
* Copyright: 2000 by Sun Microsystems, Inc.
|
|
*
|
|
* All Rights Reserved.
|
|
*
|
|
* Contributor(s): _______________________________________
|
|
*
|
|
*
|
|
************************************************************************/
|
|
#ifndef __com_sun_star_awt_XListBox_idl__
|
|
#define __com_sun_star_awt_XListBox_idl__
|
|
|
|
#ifndef __com_sun_star_uno_XInterface_idl__
|
|
#include <com/sun/star/uno/XInterface.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_awt_XItemListener_idl__
|
|
#include <com/sun/star/awt/XItemListener.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_awt_XActionListener_idl__
|
|
#include <com/sun/star/awt/XActionListener.idl>
|
|
#endif
|
|
|
|
|
|
//=============================================================================
|
|
|
|
module com { module sun { module star { module awt {
|
|
|
|
//=============================================================================
|
|
|
|
/** gives access to the items of a list box and makes it possible to
|
|
register item and action event listeners.
|
|
*/
|
|
published interface XListBox: com::sun::star::uno::XInterface
|
|
{
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** registers a listener for item events.
|
|
*/
|
|
[oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** unregisters a listener for item events.
|
|
*/
|
|
[oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** registers a listener for action events.
|
|
*/
|
|
[oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** unregisters a listener for action events.
|
|
*/
|
|
[oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** adds an item at the specified position.
|
|
*/
|
|
[oneway] void addItem( [in] string aItem,
|
|
[in] short nPos );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** adds multiple items at the specified position.
|
|
*/
|
|
[oneway] void addItems( [in] sequence<string> aItems,
|
|
[in] short nPos );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** removes a number of items at the specified position.
|
|
*/
|
|
[oneway] void removeItems( [in] short nPos,
|
|
[in] short nCount );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** returns the number of items in the listbox.
|
|
*/
|
|
short getItemCount();
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** returns the item at the specified position.
|
|
*/
|
|
string getItem( [in] short nPos );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** returns all items of the list box.
|
|
*/
|
|
sequence<string> getItems();
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** returns the position of the currently selected item.
|
|
*/
|
|
short getSelectedItemPos();
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** returns the positions of all currently selected items.
|
|
*/
|
|
sequence<short> getSelectedItemsPos();
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** returns the currently selected item.
|
|
*/
|
|
string getSelectedItem();
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** returns all currently selected items.
|
|
*/
|
|
sequence<string> getSelectedItems();
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** selects/deselects the item at the specified position.
|
|
*/
|
|
[oneway] void selectItemPos( [in] short nPos,
|
|
[in] boolean bSelect );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** selects/deselects multiple items at the specified positions.
|
|
*/
|
|
[oneway] void selectItemsPos( [in] sequence<short> aPositions,
|
|
[in] boolean bSelect );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** selects/deselects the specified item.
|
|
*/
|
|
[oneway] void selectItem( [in] string aItem,
|
|
[in] boolean bSelect );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** returns <true/> if multiple items can be selected,
|
|
<false/> if only one item can be selected.
|
|
*/
|
|
boolean isMutipleMode();
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** determines if only a single item or multiple items can be selected.
|
|
*/
|
|
[oneway] void setMultipleMode( [in] boolean bMulti );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** returns the number of visible lines in drop down mode.
|
|
*/
|
|
short getDropDownLineCount();
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** sets the number of visible lines for drop down mode.
|
|
*/
|
|
[oneway] void setDropDownLineCount( [in] short nLines );
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
/** makes the item at the specified position visible by scrolling.
|
|
*/
|
|
[oneway] void makeVisible( [in] short nEntry );
|
|
|
|
};
|
|
|
|
//=============================================================================
|
|
|
|
}; }; }; };
|
|
|
|
#endif
|