Sophie: clanlib0.8-docs-0.8.1-22.mga7 i586

clanlib0.8-docs-0.8.1-22.mga7.i586.rpm


<!-- clanlib header begin -->
<HTML>
<HEAD>
<TITLE>CL_ListBox - ClanLib Game SDK</TITLE>
<STYLE TYPE="text/css"><!--
HTML BODY
{
	font-family: verdana, helvetica, sans-serif;
	font-size: 12px;
}
H1 { font-size: 22px; }
H2 { font-size: 18px; }
H3 { font-size: 16px; }
H4 { font-size: 14px; }
P { font-size: 12px; }
LI { font-size: 12px; }
--></STYLE>
</HEAD>

<body bgcolor=white text=black link=blue vlink=#800080>

<center>
<img src="http://clanlib.org/gfx/clanlib.png">
</center>
<!-- clanlib header end -->

<center>
<p>
<a href="http://clanlib.org/docs.html">Home</a> |
<a href="classes.html">All Classes</a> |
<a href="modules.html">Grouped Classes</a> |
<a href="index.html">Index</a> |
<a href="search.html">Search</a>
</p>
</center>
<h1>Class CL_ListBox</h1>
<p>  Listbox component <a href="#description">More...</a></p>
<p>Derived from:
<a href="CL_Component.html">CL_Component</a>
<br>
Derived by:
<i>none</i>
<br>Group: GUI (Controls)</p>
<p>
#include &lt;ClanLib/gui.h&gt;
<p>
<table border=0 width=100%>
</table>
<p><b>Construction:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_ListBox__CL_ListBox.html">CL_ListBox</a></p></td><td valign=top><p>  Listbox constructor</p></td></tr></table>
<p><b>Attributes:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_ListBox__get_count.html">get_count</a></p></td><td valign=top><p>  Returns the number of items in the list box. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__get_items.html">get_items</a></p></td><td valign=top><p>  Returns items in the list.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__get_selected_items.html">get_selected_items</a></p></td><td valign=top><p>  Returns selected items as strings.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__get_current_text.html">get_current_text</a></p></td><td valign=top><p>  Returns the text of the current item.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__get_item.html">get_item</a></p></td><td valign=top><p>  Returns an item.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__get_text.html">get_text</a></p></td><td valign=top><p>  Returns the text for an item.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__get_current_item.html">get_current_item</a></p></td><td valign=top><p>  Returns the index of the current item of the listbox, or -1 if no item has been selected. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__is_selected.html">is_selected</a></p></td><td valign=top><p>  Returns true if item index is selected. Returns false if it is not selected or if there is an error.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__is_multi_selection.html">is_multi_selection</a></p></td><td valign=top><p>  Returns true if the listbox is in multiselection mode.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__get_item_height.html">get_item_height</a></p></td><td valign=top><p>  Returns the height of one item.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__get_top_item.html">get_top_item</a></p></td><td valign=top><p>  Returns the index of the item at the top of the screen.</p></td></tr></table>
<p><b>Operations:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_ListBox__insert_item.html">insert_item</a></p></td><td valign=top><p>  Inserts a listitem into the list at index. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__remove_item.html">remove_item</a></p></td><td valign=top><p>  Removes and deletes the item at position index.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__change_item.html">change_item</a></p></td><td valign=top><p>  Replaces the item at position index with new item. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__set_current_item.html">set_current_item</a></p></td><td valign=top><p>  Sets the highlighted item to the item index.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__set_selected.html">set_selected</a></p></td><td valign=top><p>  Selects item at index if select is true, or unselects it if select is false.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__clear_selection.html">clear_selection</a></p></td><td valign=top><p>  Deselects current selected item.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__select_all.html">select_all</a></p></td><td valign=top><p>  If select is true, all items get selected, else all get unselected.
  This works only in Multi selection mode.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__invert_selection.html">invert_selection</a></p></td><td valign=top><p>  Inverts the selection.
  Works only in Multi selection mode.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__set_multi_selection.html">set_multi_selection</a></p></td><td valign=top><p>  Sets the listbox to multiselection if enable is true,
  single selection otherwise.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__set_item_height.html">set_item_height</a></p></td><td valign=top><p>  Sets the height of each item.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__set_top_item.html">set_top_item</a></p></td><td valign=top><p>  Scrolls the list box so the item at position index in the list is displayed in the top row of the listbox. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__sort.html">sort</a></p></td><td valign=top><p>  Sorts the items in ascending order, if ascending is true, or descending otherwise. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__clear.html">clear</a></p></td><td valign=top><p>  Deletes all items in the list. </p></td></tr></table>
<p><b>Signals:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_ListBox__sig_highlighted.html">sig_highlighted</a></p></td><td valign=top><p>  This signal is emitted when the user highlights a new current item.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__sig_activated.html">sig_activated</a></p></td><td valign=top><p>  This signal is emitted when the user double clicks, presses space or return on an item.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__sig_selection_changed.html">sig_selection_changed</a></p></td><td valign=top><p>  This signal is emitted when the selection set of a listbox changes.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__sig_item_added.html">sig_item_added</a></p></td><td valign=top><p>  This signal is emitted when a new item is added to the listbox.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__sig_item_removed.html">sig_item_removed</a></p></td><td valign=top><p>  This signal is emitted when an item is removed from the listbox.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_ListBox__sig_clear.html">sig_clear</a></p></td><td valign=top><p>  This signal is emitted when the listbox is cleared.</p></td></tr></table>
<a name="#description"><p><b>Detailed description:</b></p>
  !group=GUI/Controls!
  !header=gui.h!


<!-- clanlib footer begin -->

<center><br><br><font color="#a0a0a0">
Questions or comments, write to the <a href="http://clanlib.org/contact.html">ClanLib mailing list</a>.
</font></center>

</body>
</html>
<!-- clanlib footer end -->