/usr/share/doc/liblqr-1-0-dev/html/ref-lqr-carver-list-foreach.html is in liblqr-1-0-dev 0.4.1-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>lqr_carver_list_foreach</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="The Liquid Rescale library Manual"><link rel="up" href="ref-carve.html" title="Carver objects"><link rel="prev" href="ref-lqr-carver-list-next.html" title="lqr_carver_list_next"><link rel="next" href="ref-vmaps.html" title="Visibiliy maps"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><code class="function">lqr_carver_list_foreach</code></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ref-lqr-carver-list-next.html">Prev</a> </td><th width="60%" align="center">Carver objects</th><td width="20%" align="right"> <a accesskey="n" href="ref-vmaps.html">Next</a></td></tr></table><hr></div><div class="refentry" title="lqr_carver_list_foreach"><a name="ref-lqr-carver-list-foreach"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>lqr_carver_list_foreach — perform operations on all <code class="classname">LqrCarver</code> objects in an <code class="classname">LqrCarverList</code> object</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include <lqr.h></pre><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">LqrRetVal <b class="fsfunc">lqr_carver_list_foreach</b>(</code></td><td>LqrCarverList* <var class="pdparam">list</var>, </td></tr><tr><td> </td><td>LqrCarverFunc <var class="pdparam">func</var>, </td></tr><tr><td> </td><td>LqrDataTok <var class="pdparam">data</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">LqrRetVal <b class="fsfunc">lqr_carver_list_foreach_recursive</b>(</code></td><td>LqrCarverList* <var class="pdparam">list</var>, </td></tr><tr><td> </td><td>LqrCarverFunc <var class="pdparam">func</var>, </td></tr><tr><td> </td><td>LqrDataTok <var class="pdparam">data</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Description"><a name="idp33343216"></a><h2>Description</h2><p>
The function <code class="function">lqr_carver_list_foreach</code> can be used to apply the function
<em class="parameter"><code>func</code></em> to all the <code class="classname">LqrCarver</code> objects listed in <em class="parameter"><code>list</code></em>.
The parameter <em class="parameter"><code>data</code></em> is used to pass arguments to the function.
</p><p>
The <em class="parameter"><code>list</code></em> value should be obtained through the function
<a class="xref" href="ref-lqr-carver-list-start.html" title="lqr_carver_list_start"><span class="refentrytitle"><code class="function">lqr_carver_list_start</code></span>(3)</a>. The order in the list will then follow the one
in which carver objects were attached.
</p><p>
The function <em class="parameter"><code>func</code></em> is of type <code class="classname">LqrCarverFunc</code>, whose
prototype is defined by:
</p><pre class="programlisting">
typedef LqrRetVal (*LqrCarverFunc) (LqrCarver *carver, LqrDataTok data);
</pre><p>
The <em class="parameter"><code>data</code></em> argument is of type <span class="structname">LqrDataTok</span>, which
is defined as a union with the following fields:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="type"><code class="classname">LqrCarver</code>*</span> <em class="structfield"><code>carver</code></em></p></li><li class="listitem"><p><span class="type">gint</span> <em class="structfield"><code>integer</code></em></p></li><li class="listitem"><p><span class="type">gpointer</span> <em class="structfield"><code>data</code></em></p></li></ul></div><p>
</p><p>
The function <code class="function">lqr_carver_list_foreach_recursive</code> is equivelant to
<code class="function">lqr_carver_list_foreach</code>, but it works recursively if the <code class="classname">LqrCarver</code> objects
in <em class="parameter"><code>list</code></em> have themselves other attached <code class="classname">LqrCarver</code> objects attached. In
this case, the function <em class="parameter"><code>func</code></em> will be applied to each element of the list
and to each element of the attached list recursively, before moving on to the next element.
</p></div><div class="refsect1" title="See also"><a name="idp33360896"></a><h2>See also</h2><p>
<span class="simplelist"><a class="xref" href="ref-lqr-ret-val.html" title="LqrRetVal"><span class="refentrytitle"><span class="type">LqrRetVal</span></span>(3)</a>, <a class="xref" href="ref-lqr-carver-attach.html" title="lqr_carver_attach"><span class="refentrytitle"><code class="function">lqr_carver_attach</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-list-start.html" title="lqr_carver_list_start"><span class="refentrytitle"><code class="function">lqr_carver_list_start</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-list-current.html" title="lqr_carver_list_current"><span class="refentrytitle"><code class="function">lqr_carver_list_current</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-list-next.html" title="lqr_carver_list_next"><span class="refentrytitle"><code class="function">lqr_carver_list_next</code></span>(3)</a></span>
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ref-lqr-carver-list-next.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ref-carve.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ref-vmaps.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><code class="function">lqr_carver_list_next</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Visibiliy maps</td></tr></table></div></body></html>
|