Sophie

Sophie

distrib > Mandriva > 9.1 > ppc > media > main > by-pkgid > ca81b57b553ae75608ba0fc5e7925e4e > files > 358

libgtkmm1.2-devel-1.2.10-1mdk.ppc.rpm

<html>
<head><title>Gtk-- Reference: Gtk::List</title></head>

<body bgcolor="#F0F0F0" text="#000000" link="#0000FF"
vlink="#000077" alink="#FF0000">
<table align=center border=0 cellspacing=10> <tr>
<td><a href="class_index.html">Class Index</a></td>
<td><a href="cross_index.html">Cross Index</a></td>
<td><a href="name_index.html">Namespace Index</a></td>
</table>
<h1 align=center>Class Gtk::List</h1><p>
<b>  Widget for packing a list of selectable items.</b><br>
Contained in: <a href="Gtk.html">Gtk</a><br>
Derived from:
<a href="Gtk%3A%3AContainer.html">Gtk::Container</a>
<br>
Derived by:
<i>none</i>
<p>
#include &lt;gtk--/list.h&gt;
<p>
<hr noshade>
<table border=0>
<tr><td colspan=3><h3>public function member index:</h3></td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1762"><tt><font color=blue><b>List</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1767"><tt><font color=blue><b>append_items</b></font></tt></a></td><td><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>gint</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1774"><tt><font color=blue><b>child_position</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>child</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1771"><tt><font color=blue><b>clear_items</b></font></tt></a></td><td><tt>(<tt><font color=purple>gint</font></tt> <tt><font color=blue>start</font></tt>, <tt><font color=purple>gint</font></tt> <tt><font color=blue>end</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=navy>GtkList</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3AList.html#1756"><tt><font color=blue><b>gtkobj</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>GtkList</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3AList.html#1757"><tt><font color=blue><b>gtkobj</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1766"><tt><font color=blue><b>insert_items</b></font></tt></a></td><td><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>, <tt><font color=purple>gint</font></tt> <tt><font color=blue>position</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1758"><tt><font color=blue><b>isA</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AObject.html"><tt><font color=navy><b>Object</b></font></tt></a>* <tt><font color=blue>object</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><a href="Gtk%3A%3AList.html#1760">ItemList</a>&</tt> </td><td align=right><a href="Gtk%3A%3AList.html#1776"><tt><font color=blue><b>items</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>const</tt> <a href="Gtk%3A%3AList.html#1760">ItemList</a>&</tt> </td><td align=right><a href="Gtk%3A%3AList.html#1777"><tt><font color=blue><b>items</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1768"><tt><font color=blue><b>prepend_items</b></font></tt></a></td><td><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1769"><tt><font color=blue><b>remove_items</b></font></tt></a></td><td><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1770"><tt><font color=blue><b>remove_items_no_unref</b></font></tt></a></td><td><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1764"><tt><font color=blue><b>select_child</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>&)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1772"><tt><font color=blue><b>select_item</b></font></tt></a></td><td><tt>(<tt><font color=purple>gint</font></tt> <tt><font color=blue>item</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><a href="Gtk%3A%3AList.html#1761">SelectionList</a>&</tt> </td><td align=right><a href="Gtk%3A%3AList.html#1778"><tt><font color=blue><b>selection</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>const</tt> <a href="Gtk%3A%3AList.html#1761">SelectionList</a>&</tt> </td><td align=right><a href="Gtk%3A%3AList.html#1779"><tt><font color=blue><b>selection</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>signal</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1763"><tt><font color=blue><b>selection_changed</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1775"><tt><font color=blue><b>set_selection_mode</b></font></tt></a></td><td><tt>(<tt><font color=navy>GtkSelectionMode</font></tt> <tt><font color=blue>mode</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1765"><tt><font color=blue><b>unselect_child</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>&)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1773"><tt><font color=blue><b>unselect_item</b></font></tt></a></td><td><tt>(<tt><font color=purple>gint</font></tt> <tt><font color=blue>item</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="Gtk%3A%3AList.html#1759"><tt><font color=blue><b>~List</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr><td>&nbsp;</td><tr><td colspan=3><h3>protected function member index:</h3></td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1781"><tt><font color=blue><b>select_child_impl</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>p0</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1780"><tt><font color=blue><b>selection_changed_impl</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AList.html#1782"><tt><font color=blue><b>unselect_child_impl</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>p0</font></tt>)</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
  The <tt><font color=navy><b>Gtk::List</b></font></tt> widget is a container whose children are displayed
  vertically in order, and can be selected. The list has many selection
  modes, which are programmer selective and depend on how many elements
  are able to be selected at the same time.<br>
<p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="1767"><font size=+1><b>Gtk::List::append_items</b></font></a> -   Adds items to the end of the list.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1767"><tt><font color=blue><b>append_items</b></font></tt></a><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>)</tt>;<br><blockquote>  items: The items.</blockquote>
<br><br>
<a name="1774"><font size=+1><b>Gtk::List::child_position</b></font></a> -   Searches the children of list for the index of child.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>gint</font></tt></tt> <a href="Gtk%3A%3AList.html#1774"><tt><font color=blue><b>child_position</b></font></tt></a><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>child</font></tt>)</tt>;<br><blockquote>  child: The child to look for.
<P>
  Returns: The index of the child, -1 if not found.</blockquote>
<br><br>
<a name="1771"><font size=+1><b>Gtk::List::clear_items</b></font></a> -   Removes the items between index start (included) and end (excluded) from the list.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1771"><tt><font color=blue><b>clear_items</b></font></tt></a><tt>(<tt><font color=purple>gint</font></tt> <tt><font color=blue>start</font></tt>, <tt><font color=purple>gint</font></tt> <tt><font color=blue>end</font></tt>)</tt>;<br><blockquote>  If end is negative, or greater than the number of children of list, it's assumed
  to be exactly the number of elements. If start is greater than or equal to end,
  nothing is done.
<P>
  start: The index of the first item to remove.
<P>
  end: The index of the lest item to remove plus one.</blockquote>
<br><br>
<a name="1756"><font size=+1><b>Gtk::List::gtkobj</b></font></a> -   Returns the underlaying gtk+ object.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=navy>GtkList</font></tt>*</tt> <a href="Gtk%3A%3AList.html#1756"><tt><font color=blue><b>gtkobj</b></font></tt></a><tt>()</tt>;<br><br>
<a name="1766"><font size=+1><b>Gtk::List::insert_items</b></font></a> -   Inserts items into the list at the position position.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1766"><tt><font color=blue><b>insert_items</b></font></tt></a><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>, <tt><font color=purple>gint</font></tt> <tt><font color=blue>position</font></tt>)</tt>;<br><blockquote>  items: The items.
  position: The position to insert items, starting at 0.</blockquote>
<br><br>
<a name="1758"><font size=+1><b>Gtk::List::isA</b></font></a> -   Returns true if object is this type.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>static</tt> <tt><font color=purple>bool</font></tt></tt> <a href="Gtk%3A%3AList.html#1758"><tt><font color=blue><b>isA</b></font></tt></a><tt>(<a href="Gtk%3A%3AObject.html"><tt><font color=navy><b>Object</b></font></tt></a>* <tt><font color=blue>object</font></tt>)</tt>;<br><br>
<a name="1768"><font size=+1><b>Gtk::List::prepend_items</b></font></a> -   Inserts items at the beginning of the list.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1768"><tt><font color=blue><b>prepend_items</b></font></tt></a><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>)</tt>;<br><blockquote>  items: The items.</blockquote>
<br><br>
<a name="1769"><font size=+1><b>Gtk::List::remove_items</b></font></a> -   Removes the items from the list.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1769"><tt><font color=blue><b>remove_items</b></font></tt></a><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>)</tt>;<br><blockquote>  items: The items to remove.</blockquote>
<br><br>
<a name="1770"><font size=+1><b>Gtk::List::remove_items_no_unref</b></font></a> -   Removes the items from the list, without unreferencing them.
  It may be useful if you want to move the items from one list to another.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1770"><tt><font color=blue><b>remove_items_no_unref</b></font></tt></a><tt>(<tt><font color=navy>GList</font></tt>* <tt><font color=blue>items</font></tt>)</tt>;<br><blockquote>  items: The items.</blockquote>
<br><br>
<a name="1764"><font size=+1><b>Gtk::List::select_child</b></font></a> -   The child widget has just been selected.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1764"><tt><font color=blue><b>select_child</b></font></tt></a><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>&)</tt>;<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1781"><tt><font color=blue><b>select_child_impl</b></font></tt></a><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>p0</font></tt>)</tt>;<br><br>
<a name="1772"><font size=+1><b>Gtk::List::select_item</b></font></a> -   Selects the child number item of the list.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1772"><tt><font color=blue><b>select_item</b></font></tt></a><tt>(<tt><font color=purple>gint</font></tt> <tt><font color=blue>item</font></tt>)</tt>;<br><blockquote>  Nothing happens if item is out of bounds. The signal {Gtk::List::select-child}
  will be emitted.
<P>
  item: The index of the child to select.</blockquote>
<br><br>
<a name="1763"><font size=+1><b>Gtk::List::selection_changed</b></font></a> -   The selection of the widget has just changed.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>signal</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1763"><tt><font color=blue><b>selection_changed</b></font></tt></a><tt>()</tt>;<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1780"><tt><font color=blue><b>selection_changed_impl</b></font></tt></a><tt>()</tt>;<br><br>
<a name="1775"><font size=+1><b>Gtk::List::set_selection_mode</b></font></a> -   Set the list selection mode.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1775"><tt><font color=blue><b>set_selection_mode</b></font></tt></a><tt>(<tt><font color=navy>GtkSelectionMode</font></tt> <tt><font color=blue>mode</font></tt>)</tt>;<br><blockquote>  The selection mode can be any value in <tt><tt><font color=blue>Gtk::SelectionMode</font></tt></tt>:
<P>
  <tt><font color=green>GTK_SELECTION_SINGLE</font></tt>: Zero or one element may be selected.
<P>
  <tt><font color=green>GTK_SELECTION_BROWSE</font></tt>: Exactly one element is always selected (this
  can be false after you have changed the selection mode).
<P>
  <tt><font color=green>GTK_SELECTION_MULTIPLE</font></tt>: Any number of elements may be selected.
  Clicks toggle the state of an item.
<P>
  <tt><font color=green>GTK_SELECTION_EXTENDED</font></tt>: Any number of elements may be selected.
  Click-drag selects a range of elements; the Ctrl key may be used to enlarge
  the selection, and Shift key to select between the focus and the child pointed
  to.
<P>
  mode: The new selection mode.</blockquote>
<br><br>
<a name="1765"><font size=+1><b>Gtk::List::unselect_child</b></font></a> -   The child widget has just been unselected.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1765"><tt><font color=blue><b>unselect_child</b></font></tt></a><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>&)</tt>;<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1782"><tt><font color=blue><b>unselect_child_impl</b></font></tt></a><tt>(<a href="Gtk%3A%3AWidget.html"><tt><font color=navy><b>Widget</b></font></tt></a>& <tt><font color=blue>p0</font></tt>)</tt>;<br><br>
<a name="1773"><font size=+1><b>Gtk::List::unselect_item</b></font></a> -   Unselects the child number item of the list.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AList.html#1773"><tt><font color=blue><b>unselect_item</b></font></tt></a><tt>(<tt><font color=purple>gint</font></tt> <tt><font color=blue>item</font></tt>)</tt>;<br><blockquote>  Nothing happens if item is out of bounds. The signal {Gtk::List::unselect-child}
  will be emitted.
<P>
  item: The index of the child to unselect.</blockquote>
<br><br>
<hr noshade>
</html>