Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 1217

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XListBox</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XListBox-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">awt</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XListBox</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>gives access to the items of a list box and makes it possible to
 register item and action event listeners.
 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addItemListener">addItemListener</a></td>
<td class="imsum_right">registers a listener for item events.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeItemListener">removeItemListener</a></td>
<td class="imsum_right">unregisters a listener for item events.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addActionListener">addActionListener</a></td>
<td class="imsum_right">registers a listener for action events. 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeActionListener">removeActionListener</a></td>
<td class="imsum_right">unregisters a listener for action events.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addItem">addItem</a></td>
<td class="imsum_right">adds an item at the specified position.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addItems">addItems</a></td>
<td class="imsum_right">adds multiple items at the specified position.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeItems">removeItems</a></td>
<td class="imsum_right">removes a number of items at the specified position.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getItemCount">getItemCount</a></td>
<td class="imsum_right">returns the number of items in the listbox.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getItem">getItem</a></td>
<td class="imsum_right">returns the item at the specified position.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getItems">getItems</a></td>
<td class="imsum_right">returns all items of the list box.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSelectedItemPos">getSelectedItemPos</a></td>
<td class="imsum_right">returns the position of the currently selected item.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSelectedItemsPos">getSelectedItemsPos</a></td>
<td class="imsum_right">returns the positions of all currently selected items.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSelectedItem">getSelectedItem</a></td>
<td class="imsum_right">returns the currently selected item.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSelectedItems">getSelectedItems</a></td>
<td class="imsum_right">returns all currently selected items.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#selectItemPos">selectItemPos</a></td>
<td class="imsum_right">selects/deselects the item at the specified position.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#selectItemsPos">selectItemsPos</a></td>
<td class="imsum_right">selects/deselects multiple items at the specified positions.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#selectItem">selectItem</a></td>
<td class="imsum_right">selects/deselects the specified item.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isMutipleMode">isMutipleMode</a></td>
<td class="imsum_right">returns <b>true</b> if multiple items can be selected, 
 <b>false</b> if only one item can be selected.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setMultipleMode">setMultipleMode</a></td>
<td class="imsum_right">determines if only a single item or multiple items can be selected.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDropDownLineCount">getDropDownLineCount</a></td>
<td class="imsum_right">returns the number of visible lines in drop down mode.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setDropDownLineCount">setDropDownLineCount</a></td>
<td class="imsum_right">sets the number of visible lines for drop down mode.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#makeVisible">makeVisible</a></td>
<td class="imsum_right">makes the item at the specified position visible by scrolling.
 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="addItemListener" class="membertitle">addItemListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>addItemListener</b>(</td>
<td valign="top">[in] <a href="XItemListener.html">XItemListener</a></td>
<td valign="bottom">&nbsp;l );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>registers a listener for item events.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeItemListener" class="membertitle">removeItemListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>removeItemListener</b>(</td>
<td valign="top">[in] <a href="XItemListener.html">XItemListener</a></td>
<td valign="bottom">&nbsp;l );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>unregisters a listener for item events.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addActionListener" class="membertitle">addActionListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>addActionListener</b>(</td>
<td valign="top">[in] <a href="XActionListener.html">XActionListener</a></td>
<td valign="bottom">&nbsp;l );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>registers a listener for action events. 
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeActionListener" class="membertitle">removeActionListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>removeActionListener</b>(</td>
<td valign="top">[in] <a href="XActionListener.html">XActionListener</a></td>
<td valign="bottom">&nbsp;l );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>unregisters a listener for action events.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addItem" class="membertitle">addItem</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>addItem</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aItem,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nPos );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adds an item at the specified position.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addItems" class="membertitle">addItems</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>addItems</b>(</td>
<td valign="top">[in] sequence&lt; string &gt;</td>
<td valign="bottom">&nbsp;aItems,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nPos );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adds multiple items at the specified position.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeItems" class="membertitle">removeItems</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>removeItems</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nPos,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nCount );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>removes a number of items at the specified position.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getItemCount" class="membertitle">getItemCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">short</td>
</tr>
<tr>
<td valign="top"><b>getItemCount</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the number of items in the listbox.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getItem" class="membertitle">getItem</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getItem</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nPos );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the item at the specified position.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getItems" class="membertitle">getItems</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; string &gt;</td>
</tr>
<tr>
<td valign="top"><b>getItems</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns all items of the list box.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSelectedItemPos" class="membertitle">getSelectedItemPos</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">short</td>
</tr>
<tr>
<td valign="top"><b>getSelectedItemPos</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the position of the currently selected item.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSelectedItemsPos" class="membertitle">getSelectedItemsPos</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; short &gt;</td>
</tr>
<tr>
<td valign="top"><b>getSelectedItemsPos</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the positions of all currently selected items.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSelectedItem" class="membertitle">getSelectedItem</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getSelectedItem</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the currently selected item.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSelectedItems" class="membertitle">getSelectedItems</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; string &gt;</td>
</tr>
<tr>
<td valign="top"><b>getSelectedItems</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns all currently selected items.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="selectItemPos" class="membertitle">selectItemPos</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>selectItemPos</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nPos,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bSelect );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>selects/deselects the item at the specified position.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="selectItemsPos" class="membertitle">selectItemsPos</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>selectItemsPos</b>(</td>
<td valign="top">[in] sequence&lt; short &gt;</td>
<td valign="bottom">&nbsp;aPositions,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bSelect );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>selects/deselects multiple items at the specified positions.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="selectItem" class="membertitle">selectItem</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>selectItem</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aItem,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bSelect );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>selects/deselects the specified item.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isMutipleMode" class="membertitle">isMutipleMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isMutipleMode</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns <b>true</b> if multiple items can be selected, 
 <b>false</b> if only one item can be selected.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setMultipleMode" class="membertitle">setMultipleMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>setMultipleMode</b>(</td>
<td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bMulti );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines if only a single item or multiple items can be selected.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDropDownLineCount" class="membertitle">getDropDownLineCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">short</td>
</tr>
<tr>
<td valign="top"><b>getDropDownLineCount</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the number of visible lines in drop down mode.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setDropDownLineCount" class="membertitle">setDropDownLineCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>setDropDownLineCount</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nLines );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>sets the number of visible lines for drop down mode.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="makeVisible" class="membertitle">makeVisible</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>makeVisible</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nEntry );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>makes the item at the specified position visible by scrolling.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>