/usr/share/doc/liblqr-1-0-dev/html/ref-lqr-progress-set-init.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 27 28 29 30 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>lqr_progress_set_init</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-progress.html" title="Progress reports"><link rel="prev" href="ref-lqr-progress-new.html" title="lqr_progress_new"><link rel="next" href="ref-lqr-progress-set-update.html" title="lqr_progress_set_update"></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_progress_set_init</code></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ref-lqr-progress-new.html">Prev</a> </td><th width="60%" align="center">Progress reports</th><td width="20%" align="right"> <a accesskey="n" href="ref-lqr-progress-set-update.html">Next</a></td></tr></table><hr></div><div class="refentry" title="lqr_progress_set_init"><a name="ref-lqr-progress-set-init"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>lqr_progress_set_init — execude custom code before each rescaling operation</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_progress_set_init</b>(</code></td><td>LqrProgress* <var class="pdparam">p</var>, </td></tr><tr><td> </td><td>LqrProgressFuncInit <var class="pdparam">init_func</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Description"><a name="idp34159248"></a><h2>Description</h2><p>
The function <code class="function">lqr_progress_set_init</code> sets the hook
<em class="parameter"><code>init_func</code></em> to the <code class="classname">LqrProgress</code> object pointed to by
<em class="parameter"><code>p</code></em>.
</p><p>
The function <em class="parameter"><code>init_func</code></em> is of type
<code class="classname">LqrProgressFuncInit</code>, whose prototype is defined by:
</p><pre class="programlisting">
typedef LqrRetVal (*LqrProgressFuncInit) (const gchar* init_message);
</pre><p>
Each time that the function <a class="xref" href="ref-lqr-carver-resize.html" title="lqr_carver_resize"><span class="refentrytitle"><code class="function">lqr_carver_resize</code></span>(3)</a> performs a rescale
operation (recall that it can perform more than one rescale operation at each call) this
function will be called first, with a string argument passed through the parameter
<em class="parameter"><code>init_message</code></em>, which is different for horizontal and vertical rescalings.
</p><p>
The message arguments can be set with the functions
<a class="xref" href="ref-lqr-progress-set-init-width-message.html" title="lqr_progress_set_init_width_message"><span class="refentrytitle"><code class="function">lqr_progress_set_init_width_message</code></span>(3)</a> and
<a class="xref" href="ref-lqr-progress-set-init-height-message.html" title="lqr_progress_set_init_height_message"><span class="refentrytitle"><code class="function">lqr_progress_set_init_height_message</code></span>(3)</a>.
</p><p>
The default values for newly created <code class="classname">LqrProgress</code> objects are:
</p><div class="variablelist"><dl><dt><span class="term">Horizontal:</span></dt><dd><p>
<code class="computeroutput">"Resizing width..."</code>
</p></dd><dt><span class="term">Vertical:</span></dt><dd><p>
<code class="computeroutput">"Resizing height..."</code>
</p></dd></dl></div><p>
</p></div><div class="refsect1" title="Return value"><a name="idp34175168"></a><h2>Return value</h2><p>
The return value follows the Liquid Rescale library signalling system.
</p></div><div class="refsect1" title="See also"><a name="idp34176576"></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-progress-new.html" title="lqr_progress_new"><span class="refentrytitle"><code class="function">lqr_progress_new</code></span>(3)</a>, <a class="xref" href="ref-lqr-progress-set-update.html" title="lqr_progress_set_update"><span class="refentrytitle"><code class="function">lqr_progress_set_update</code></span>(3)</a>, <a class="xref" href="ref-lqr-progress-set-end.html" title="lqr_progress_set_end"><span class="refentrytitle"><code class="function">lqr_progress_set_end</code></span>(3)</a>, <a class="xref" href="ref-lqr-progress-set-init-width-message.html" title="lqr_progress_set_init_width_message"><span class="refentrytitle"><code class="function">lqr_progress_set_init_width_message</code></span>(3)</a>, <a class="xref" href="ref-lqr-progress-set-init-height-message.html" title="lqr_progress_set_init_height_message"><span class="refentrytitle"><code class="function">lqr_progress_set_init_height_message</code></span>(3)</a>, <a class="xref" href="ref-lqr-progress-set-end-width-message.html" title="lqr_progress_set_end_width_message"><span class="refentrytitle"><code class="function">lqr_progress_set_end_width_message</code></span>(3)</a>, <a class="xref" href="ref-lqr-progress-set-end-height-message.html" title="lqr_progress_set_end_height_message"><span class="refentrytitle"><code class="function">lqr_progress_set_end_height_message</code></span>(3)</a>, <a class="xref" href="ref-lqr-progress-set-update-step.html" title="lqr_progress_set_update_step"><span class="refentrytitle"><code class="function">lqr_progress_set_update_step</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-set-progress.html" title="lqr_carver_set_progress"><span class="refentrytitle"><code class="function">lqr_carver_set_progress</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-progress-new.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ref-progress.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ref-lqr-progress-set-update.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><code class="function">lqr_progress_new</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <code class="function">lqr_progress_set_update</code></td></tr></table></div></body></html>
|