Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GcrSimpleCollection: 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="GcrComparable.html" title="GcrComparable">
<link rel="next" href="GcrCollectionModel.html" title="GcrCollectionModel">
<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="#GcrSimpleCollection.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GcrSimpleCollection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GcrSimpleCollection.implemented-interfaces" class="shortcut">Implemented Interfaces</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="GcrComparable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GcrCollectionModel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GcrSimpleCollection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GcrSimpleCollection.top_of_page"></a>GcrSimpleCollection</span></h2>
<p>GcrSimpleCollection — A simple implementation of GcrCollection</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GcrSimpleCollection.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">
<a class="link" href="GcrCollection.html" title="GcrCollection"><span class="returnvalue">GcrCollection</span></a> *
</td>
<td class="function_name">
<a class="link" href="GcrSimpleCollection.html#gcr-simple-collection-new" title="gcr_simple_collection_new ()">gcr_simple_collection_new</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="GcrSimpleCollection.html#gcr-simple-collection-add" title="gcr_simple_collection_add ()">gcr_simple_collection_add</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="GcrSimpleCollection.html#gcr-simple-collection-remove" title="gcr_simple_collection_remove ()">gcr_simple_collection_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrSimpleCollection.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">struct</td>
<td class="function_name"><a class="link" href="GcrSimpleCollection.html#GcrSimpleCollection-struct" title="struct GcrSimpleCollection">GcrSimpleCollection</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GcrSimpleCollection.html#GcrSimpleCollectionClass" title="struct GcrSimpleCollectionClass">GcrSimpleCollectionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrSimpleCollection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GcrSimpleCollection
</pre>
</div>
<div class="refsect1">
<a name="GcrSimpleCollection.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GcrSimpleCollection implements
 <a class="link" href="GcrCollection.html" title="GcrCollection">GcrCollection</a>.</p>
</div>
<div class="refsect1">
<a name="GcrSimpleCollection.description"></a><h2>Description</h2>
<p>A simple implementation of <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a>, which you can add and remove
objects from. Use <a class="link" href="GcrSimpleCollection.html#gcr-simple-collection-add" title="gcr_simple_collection_add ()"><code class="function">gcr_simple_collection_add()</code></a> to do this
<a class="link" href="GcrSimpleCollection.html#gcr-simple-collection-remove" title="gcr_simple_collection_remove ()"><code class="function">gcr_simple_collection_remove()</code></a>.</p>
</div>
<div class="refsect1">
<a name="GcrSimpleCollection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gcr-simple-collection-new"></a><h3>gcr_simple_collection_new ()</h3>
<pre class="programlisting"><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="returnvalue">GcrCollection</span></a> *
gcr_simple_collection_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new <a class="link" href="GcrSimpleCollection.html" title="GcrSimpleCollection"><span class="type">GcrSimpleCollection</span></a>.</p>
<div class="refsect3">
<a name="gcr-simple-collection-new.returns"></a><h4>Returns</h4>
<p>a newly allocated
collection, which should be freed with <code class="function">g_object_unref()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gcr.SimpleCollection]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-simple-collection-add"></a><h3>gcr_simple_collection_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_simple_collection_add (<em class="parameter"><code><a class="link" href="GcrSimpleCollection.html" title="GcrSimpleCollection"><span class="type">GcrSimpleCollection</span></a> *self</code></em>,
                           <em class="parameter"><code><span class="type">GObject</span> *object</code></em>);</pre>
<p>Add an object to this collection</p>
<div class="refsect3">
<a name="gcr-simple-collection-add.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 to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-simple-collection-remove"></a><h3>gcr_simple_collection_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_simple_collection_remove (<em class="parameter"><code><a class="link" href="GcrSimpleCollection.html" title="GcrSimpleCollection"><span class="type">GcrSimpleCollection</span></a> *self</code></em>,
                              <em class="parameter"><code><span class="type">GObject</span> *object</code></em>);</pre>
<p>Remove an object from the collection.</p>
<div class="refsect3">
<a name="gcr-simple-collection-remove.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 to remove from the collection</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GcrSimpleCollection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GcrSimpleCollection-struct"></a><h3>struct GcrSimpleCollection</h3>
<pre class="programlisting">struct GcrSimpleCollection;</pre>
<p>A simple implementation of <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrSimpleCollectionClass"></a><h3>struct GcrSimpleCollectionClass</h3>
<pre class="programlisting">struct GcrSimpleCollectionClass {
	GObjectClass parent_class;
};
</pre>
<p>The class for <a class="link" href="GcrSimpleCollection.html" title="GcrSimpleCollection"><span class="type">GcrSimpleCollection</span></a>.</p>
<div class="refsect3">
<a name="GcrSimpleCollectionClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27.1</div>
</body>
</html>