Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: awt ::

interface XListBox

Base Interface
com::sun::star::uno::XInterface

Description
gives access to the items and their state and to register for item and action events of a listbox.


Known Services which Export this Interface

com::sun::star::awt::UnoControlListBox specifies a list box control.

Methods' Summary

addItemListener registers an item event listener.
removeItemListener unregisters an item event listener.
addActionListener registers an action event listener.
removeActionListener unregisters an action event listener.
addItem adds an item at a specified position.
addItems adds multiple items at a specified position.
removeItems removes a number of items at a specified position.
getItemCount
getItem
getItems
getSelectedItemPos
getSelectedItemsPos
getSelectedItem
getSelectedItems
selectItemPos selects/unselects the item at the specified position.
selectItemsPos selects/unselects multiple items at the specified positions.
selectItem selects/unselects the specified item.
isMutipleMode
setMultipleMode determines if only a single item or multiple items can be selected.
getDropDownLineCount
setDropDownLineCount sets the number of visible lines for drop down mode.
makeVisible makes the item at the specified position visible by scolling.

Methods' Details

addItemListener
 
[ oneway ] void
addItemListener(
[ in ] com::sun::star::awt::XItemListener l );

Description
registers an item event listener.
removeItemListener
 
[ oneway ] void
removeItemListener(
[ in ] com::sun::star::awt::XItemListener l );

Description
unregisters an item event listener.
addActionListener
 
[ oneway ] void
addActionListener(
[ in ] com::sun::star::awt::XActionListener l );

Description
registers an action event listener.
removeActionListener
 
[ oneway ] void
removeActionListener(
[ in ] com::sun::star::awt::XActionListener l );

Description
unregisters an action event listener.
addItem
 
[ oneway ] void
addItem(
[ in ] string aItem,
[ in ] short nPos );

Description
adds an item at a specified position.
addItems
 
[ oneway ] void
addItems(
[ in ] sequence< string > aItems,
[ in ] short nPos );

Description
adds multiple items at a specified position.
removeItems
 
[ oneway ] void
removeItems(
[ in ] short nPos,
[ in ] short nCount );

Description
removes a number of items at a specified position.
getItemCount
 
short
getItemCount();
Returns
the number of items currently in the listbox.
getItem
 
string
getItem(
[ in ] short nPos );

Returns
the item at the specified position.
getItems
 
sequence< string >
getItems();
Returns
all items of the list box.
getSelectedItemPos
 
short
getSelectedItemPos();
Returns
the position of the currently selected item.
getSelectedItemsPos
 
sequence< short >
getSelectedItemsPos();
Returns
the positions of all currently selected items.
getSelectedItem
 
string
getSelectedItem();
Returns
the currently selected item.
getSelectedItems
 
sequence< string >
getSelectedItems();
Returns
all currently selected items.
selectItemPos
 
[ oneway ] void
selectItemPos(
[ in ] short nPos,
[ in ] boolean bSelect );

Description
selects/unselects the item at the specified position.
selectItemsPos
 
[ oneway ] void
selectItemsPos(
[ in ] sequence< short > aPositions,
[ in ] boolean bSelect );

Description
selects/unselects multiple items at the specified positions.
selectItem
 
[ oneway ] void
selectItem(
[ in ] string aItem,
[ in ] boolean bSelect );

Description
selects/unselects the specified item.
isMutipleMode
 
boolean
isMutipleMode();
Returns
true if multiple items can be selected, false if only one item can be selected.
setMultipleMode
 
[ oneway ] void
setMultipleMode(
[ in ] boolean bMulti );

Description
determines if only a single item or multiple items can be selected.
getDropDownLineCount
 
short
getDropDownLineCount();
Returns
the number of visible lines in drop down mode.
setDropDownLineCount
 
[ oneway ] void
setDropDownLineCount(
[ in ] short nLines );

Description
sets the number of visible lines for drop down mode.
makeVisible
 
[ oneway ] void
makeVisible(
[ in ] short nEntry );

Description
makes the item at the specified position visible by scolling.

Top of Page