This file is indexed.

/usr/share/gtk-doc/html/libgwymodule/libgwymodule-gwymodule-tool.html is in libgwyddion20-doc 2.26-1ubuntu1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gwymodule-tool</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gwyddion Module Library Reference Manual">
<link rel="up" href="ModuleLibrary.html" title="Gwyddion Module Library">
<link rel="prev" href="libgwymodule-gwymodule-process.html" title="gwymodule-process">
<link rel="next" href="libgwymodule-gwymodule-graph.html" title="gwymodule-graph">
<meta name="generator" content="GTK-Doc V1.8 (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="libgwymodule-gwymodule-process.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ModuleLibrary.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">Gwyddion Module Library Reference Manual</th>
<td><a accesskey="n" href="libgwymodule-gwymodule-graph.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwymodule-gwymodule-tool.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgwymodule-gwymodule-tool.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwymodule-gwymodule-tool"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwymodule-gwymodule-tool.top_of_page"></a>gwymodule-tool</span></h2>
<p>gwymodule-tool — Interactive tool modules</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwymodule-gwymodule-tool.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgwymodule/gwymodule.h&gt;

<span class="returnvalue">void</span>                <a class="link" href="libgwymodule-gwymodule-tool.html#gwy-tool-func-foreach" title="gwy_tool_func_foreach ()">gwy_tool_func_foreach</a>               (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Doubly-Linked-Lists.html#GFunc"><span class="type">GFunc</span></a> function</code></em>,
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgwymodule-gwymodule-tool.html#gwy-tool-func-register" title="gwy_tool_func_register ()">gwy_tool_func_register</a>              (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwymodule-gwymodule-tool.description"></a><h2>Description</h2>
<p>
Tool modules implement interactive tools that work directly on data
windows.
</p>
</div>
<div class="refsect1">
<a name="libgwymodule-gwymodule-tool.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-tool-func-foreach"></a><h3>gwy_tool_func_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_tool_func_foreach               (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Doubly-Linked-Lists.html#GFunc"><span class="type">GFunc</span></a> function</code></em>,
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Calls a function for each tool function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
<td>Function to run for each tool function.  It will get function
name (constant string owned by module system) as its first
argument, <em class="parameter"><code>user_data</code></em> as the second argument.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Data to pass to <em class="parameter"><code>function</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-tool-func-register"></a><h3>gwy_tool_func_register ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gwy_tool_func_register              (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre>
<p>
Registeres a tool function (tool type).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>Layer type in GObject type system.  That is the return value of
<code class="function">gwy_tool_foo_get_type()</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Normally <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>; <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.8</div>
</body>
</html>