/usr/share/gtk-doc/html/nautilus-actions-3/nautilus-actions-NATimeout.html is in nautilus-actions 3.2.3-1build3.
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 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NATimeout</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Nautilus-Actions™ Reference Manual">
<link rel="up" href="ch07.html" title="Miscellaneous API">
<link rel="prev" href="nautilus-actions-Core-Misc.html" title="Core Misc">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="nautilus-actions-Core-Misc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">
<span class="productname">Nautilus-Actions</span>™ Reference Manual</th>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#nautilus-actions-NATimeout.synopsis" class="shortcut">Top</a>
|
<a href="#nautilus-actions-NATimeout.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="nautilus-actions-NATimeout"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="nautilus-actions-NATimeout.top_of_page"></a>NATimeout</span></h2>
<p>NATimeout — The NATimeout Structure</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="nautilus-actions-NATimeout.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <nautilus-actions/na-timeout.h>
<a class="link" href="nautilus-actions-NATimeout.html#NATimeout" title="NATimeout">NATimeout</a>;
<span class="returnvalue">void</span> <a class="link" href="nautilus-actions-NATimeout.html#NATimeoutFunc" title="NATimeoutFunc ()">NATimeoutFunc</a> (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="nautilus-actions-NATimeout.html#na-timeout-event" title="na_timeout_event ()">na_timeout_event</a> (<em class="parameter"><code><a class="link" href="nautilus-actions-NATimeout.html#NATimeout" title="NATimeout"><span class="type">NATimeout</span></a> *timeout</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="nautilus-actions-NATimeout.description"></a><h2>Description</h2>
<p>
The NATimeout structure is a convenience structure to manage timeout
functions.
</p>
</div>
<div class="refsect1">
<a name="nautilus-actions-NATimeout.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="NATimeout"></a><h3>NATimeout</h3>
<pre class="programlisting">typedef struct {
guint timeout;
NATimeoutFunc handler;
gpointer user_data;
} NATimeout;
</pre>
<p>
This structure let the user (i.e. the code which uses it) manage functions
which should only be called after some time of inactivity, which is typically
the case of 'item-change' handlers.
</p>
<p>
The structure is supposed to be initialized at construction time with
<em class="parameter"><code>timeout</code></em> in milliseconds, <em class="parameter"><code>handler</code></em> and <em class="parameter"><code>user_data</code></em> input parameters.
The private data should be set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<p>
Such a structure must be allocated for each managed event.
</p>
<p>
When an event is detected, the <a class="link" href="nautilus-actions-NATimeout.html#na-timeout-event" title="na_timeout_event ()"><code class="function">na_timeout_event()</code></a> function must be called
with this structure. The function makes sure that the <em class="parameter"><code>handler</code></em> callback
will be triggered as soon as no event will be recorded after <em class="parameter"><code>timeout</code></em>
milliseconds of inactivity.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="NATimeout.timeout"></a>timeout</code></em>;</span></p></td>
<td>(i) timeout configurable parameter (ms)</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="nautilus-actions-NATimeout.html#NATimeoutFunc" title="NATimeoutFunc ()"><span class="type">NATimeoutFunc</span></a> <em class="structfield"><code><a name="NATimeout.handler"></a>handler</code></em>;</span></p></td>
<td>(i) handler function</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="NATimeout.user-data"></a>user_data</code></em>;</span></p></td>
<td>(i) user data</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.1</p>
</div>
<hr>
<div class="refsect2">
<a name="NATimeoutFunc"></a><h3>NATimeoutFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> NATimeoutFunc (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
Prototype of the callback function.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to be passed to the callback function.</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.1</p>
</div>
<hr>
<div class="refsect2">
<a name="na-timeout-event"></a><h3>na_timeout_event ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> na_timeout_event (<em class="parameter"><code><a class="link" href="nautilus-actions-NATimeout.html#NATimeout" title="NATimeout"><span class="type">NATimeout</span></a> *timeout</code></em>);</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td>
<td>the <a class="link" href="nautilus-actions-NATimeout.html#NATimeout" title="NATimeout"><span class="type">NATimeout</span></a> structure which will handle this event.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|