<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GcrCollection: Gcr Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
<link rel="up" href="collections.html" title="Part II. Collections">
<link rel="prev" href="collections.html" title="Part II. Collections">
<link rel="next" href="GcrComparable.html" title="GcrComparable">
<meta name="generator" content="GTK-Doc V1.27.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GcrCollection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GcrCollection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#GcrCollection.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#GcrCollection.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GcrCollection.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="collections.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="collections.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GcrComparable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GcrCollection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GcrCollection.top_of_page"></a>GcrCollection</span></h2>
<p>GcrCollection — A collection of objects.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GcrCollection.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="GcrCollection.html#gcr-collection-get-length" title="gcr_collection_get_length ()">gcr_collection_get_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="GcrCollection.html#gcr-collection-get-objects" title="gcr_collection_get_objects ()">gcr_collection_get_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GcrCollection.html#gcr-collection-contains" title="gcr_collection_contains ()">gcr_collection_contains</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GcrCollection.html#gcr-collection-emit-added" title="gcr_collection_emit_added ()">gcr_collection_emit_added</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GcrCollection.html#gcr-collection-emit-removed" title="gcr_collection_emit_removed ()">gcr_collection_emit_removed</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrCollection.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GcrCollection.html#GcrCollection-added" title="The “added” signal">added</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GcrCollection.html#GcrCollection-removed" title="The “removed” signal">removed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrCollection.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GcrCollection.html#GcrCollection-struct" title="GcrCollection">GcrCollection</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrCollection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/home/dueno/jhbuild/install/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> GcrCollection
</pre>
</div>
<div class="refsect1">
<a name="GcrCollection.prerequisites"></a><h2>Prerequisites</h2>
<p>
GcrCollection requires
GObject.</p>
</div>
<div class="refsect1">
<a name="GcrCollection.implementations"></a><h2>Known Implementations</h2>
<p>
GcrCollection is implemented by
GcrFilterCollection, <a class="link" href="GcrSimpleCollection.html" title="GcrSimpleCollection">GcrSimpleCollection</a> and GcrUnionCollection.</p>
</div>
<div class="refsect1">
<a name="GcrCollection.description"></a><h2>Description</h2>
<p>A <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> is used to group a set of objects. This is an abstract
interface which can be used to determine which objects show up in a selector
or other user interface element.</p>
<p>Use <a class="link" href="GcrSimpleCollection.html#gcr-simple-collection-new" title="gcr_simple_collection_new ()"><code class="function">gcr_simple_collection_new()</code></a> to create a concrete implementation of this
interface which you can add objects to.</p>
</div>
<div class="refsect1">
<a name="GcrCollection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gcr-collection-get-length"></a><h3>gcr_collection_get_length ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gcr_collection_get_length (<em class="parameter"><code><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *self</code></em>);</pre>
<p>Get the number of objects in this collection.</p>
<div class="refsect3">
<a name="gcr-collection-get-length.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The collection</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-get-length.returns"></a><h4>Returns</h4>
<p> The number of objects.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-get-objects"></a><h3>gcr_collection_get_objects ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
gcr_collection_get_objects (<em class="parameter"><code><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *self</code></em>);</pre>
<p>Get a list of the objects in this collection.</p>
<div class="refsect3">
<a name="gcr-collection-get-objects.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The collection</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-get-objects.returns"></a><h4>Returns</h4>
<p>a list of the objects
in this collection, which should be freed with <code class="function">g_list_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject.Object]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-contains"></a><h3>gcr_collection_contains ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gcr_collection_contains (<em class="parameter"><code><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>);</pre>
<p>Check whether the collection contains an object or not.</p>
<div class="refsect3">
<a name="gcr-collection-contains.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the collection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>object to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-contains.returns"></a><h4>Returns</h4>
<p> whether the collection contains this object</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-emit-added"></a><h3>gcr_collection_emit_added ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_collection_emit_added (<em class="parameter"><code><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>);</pre>
<p>Emit the <a class="link" href="GcrCollection.html#GcrCollection-added" title="The “added” signal"><span class="type">“added”</span></a> signal for the given object. This function
is used by implementors of this interface.</p>
<div class="refsect3">
<a name="gcr-collection-emit-added.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The collection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>The object that was added</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-emit-removed"></a><h3>gcr_collection_emit_removed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_collection_emit_removed (<em class="parameter"><code><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>);</pre>
<p>Emit the <a class="link" href="GcrCollection.html#GcrCollection-removed" title="The “removed” signal"><span class="type">“removed”</span></a> signal for the given object. This function
is used by implementors of this interface.</p>
<div class="refsect3">
<a name="gcr-collection-emit-removed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The collection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>The object that was removed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GcrCollection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GcrCollection-struct"></a><h3>GcrCollection</h3>
<pre class="programlisting">typedef struct _GcrCollection GcrCollection;</pre>
<p>A <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> is used to group a set of objects.</p>
</div>
</div>
<div class="refsect1">
<a name="GcrCollection.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GcrCollection-added"></a><h3>The <code class="literal">“added”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *self,
<span class="type">GObject</span> *object,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted when an object is added to the collection.</p>
<div class="refsect3">
<a name="GcrCollection-added.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the collection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>object that was added. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GObject.Object]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrCollection-removed"></a><h3>The <code class="literal">“removed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *self,
<span class="type">GObject</span> *object,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted when an object is removed from the collection.</p>
<div class="refsect3">
<a name="GcrCollection-removed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the collection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>object that was removed. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GObject.Object]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27.1</div>
</body>
</html>