This file is indexed.

/usr/share/gtk-doc/html/libgwymodule/libgwymodule-gwymoduleenums.html is in libgwyddion20-doc 2.34-3ubuntu1.

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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Module Library Reference Manual: gwymoduleenums</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="ModuleLibrary.html" title="Gwyddion Module Library">
<link rel="next" href="libgwymodule-gwymoduleloader.html" title="gwymoduleloader">
<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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
                   | 
                  <a href="#libgwymodule-gwymoduleenums.description" class="shortcut">Description</a>
</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="ModuleLibrary.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ModuleLibrary.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgwymodule-gwymoduleloader.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwymodule-gwymoduleenums"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwymodule-gwymoduleenums.top_of_page"></a>gwymoduleenums</span></h2>
<p>gwymoduleenums — Common enumerations</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwymodule-gwymoduleenums.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgwymodule/gwymodule.h&gt;

enum                <a class="link" href="libgwymodule-gwymoduleenums.html#GwyFileOperationType" title="enum GwyFileOperationType">GwyFileOperationType</a>;
enum                <a class="link" href="libgwymodule-gwymoduleenums.html#GwyToolSwitchEvent" title="enum GwyToolSwitchEvent">GwyToolSwitchEvent</a>;
enum                <a class="link" href="libgwymodule-gwymoduleenums.html#GwyRunType" title="enum GwyRunType">GwyRunType</a>;
</pre>
</div>
<div class="refsect1">
<a name="libgwymodule-gwymoduleenums.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgwymodule-gwymoduleenums.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyFileOperationType"></a><h3>enum GwyFileOperationType</h3>
<pre class="programlisting">typedef enum {
    GWY_FILE_OPERATION_DETECT = 1 &lt;&lt; 0,
    GWY_FILE_OPERATION_LOAD   = 1 &lt;&lt; 1,
    GWY_FILE_OPERATION_SAVE   = 1 &lt;&lt; 2,
    GWY_FILE_OPERATION_EXPORT = 1 &lt;&lt; 3,
    GWY_FILE_OPERATION_MASK   = 0x0f
} GwyFileOperationType;
</pre>
<p>
File type function file operations (capabilities).
</p>
<p>
The difference between save and export is that save is supposed to create
a file containing fairly complete representation of the container, while
export is the possibility to write some information to given file type.
Generally only native file format module implements
<a class="link" href="libgwymodule-gwymoduleenums.html#GWY-FILE-OPERATION-SAVE:CAPS"><code class="literal">GWY_FILE_OPERATION_SAVE</code></a>, all others implement <a class="link" href="libgwymodule-gwymoduleenums.html#GWY-FILE-OPERATION-EXPORT:CAPS"><code class="literal">GWY_FILE_OPERATION_EXPORT</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-FILE-OPERATION-DETECT:CAPS"></a><span class="term"><code class="literal">GWY_FILE_OPERATION_DETECT</code></span></p></td>
<td>Posibility to detect files are of this file type,
</td>
</tr>
<tr>
<td><p><a name="GWY-FILE-OPERATION-LOAD:CAPS"></a><span class="term"><code class="literal">GWY_FILE_OPERATION_LOAD</code></span></p></td>
<td>Posibility to load files of this type.
</td>
</tr>
<tr>
<td><p><a name="GWY-FILE-OPERATION-SAVE:CAPS"></a><span class="term"><code class="literal">GWY_FILE_OPERATION_SAVE</code></span></p></td>
<td>Posibility to save files of this type.
</td>
</tr>
<tr>
<td><p><a name="GWY-FILE-OPERATION-EXPORT:CAPS"></a><span class="term"><code class="literal">GWY_FILE_OPERATION_EXPORT</code></span></p></td>
<td>Posibility to export files of this type.
</td>
</tr>
<tr>
<td><p><a name="GWY-FILE-OPERATION-MASK:CAPS"></a><span class="term"><code class="literal">GWY_FILE_OPERATION_MASK</code></span></p></td>
<td>The mask for all the flags.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyToolSwitchEvent"></a><h3>enum GwyToolSwitchEvent</h3>
<pre class="programlisting">typedef enum {
    GWY_TOOL_SWITCH_WINDOW = 1,
    GWY_TOOL_SWITCH_TOOL
} GwyToolSwitchEvent;
</pre>
<div class="warning">
<h3 class="title">Warning</h3>
<p><code class="literal">GwyToolSwitchEvent</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-TOOL-SWITCH-WINDOW:CAPS"></a><span class="term"><code class="literal">GWY_TOOL_SWITCH_WINDOW</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GWY-TOOL-SWITCH-TOOL:CAPS"></a><span class="term"><code class="literal">GWY_TOOL_SWITCH_TOOL</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyRunType"></a><h3>enum GwyRunType</h3>
<pre class="programlisting">typedef enum {
    GWY_RUN_NONE           = 0,
    GWY_RUN_NONINTERACTIVE = 1 &lt;&lt; 0,
    GWY_RUN_INTERACTIVE    = 1 &lt;&lt; 1,
    GWY_RUN_IMMEDIATE      = 1 &lt;&lt; 2,
    GWY_RUN_MASK           = 0x07
} GwyRunType;
</pre>
<p>
Module function run-modes.
</p>
<p>
Note <em class="parameter"><code>GWY_RUN_NONINTERACTIVE</code></em> is only possible for file functions,
processing functions do not have a truly non-interactive interface yet and
therefore they should not claim they support it.  The closest match for
process functions is <em class="parameter"><code>GWY_RUN_IMMEDIATE</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GWY-RUN-NONE:CAPS"></a><span class="term"><code class="literal">GWY_RUN_NONE</code></span></p></td>
<td>None.
</td>
</tr>
<tr>
<td><p><a name="GWY-RUN-NONINTERACTIVE:CAPS"></a><span class="term"><code class="literal">GWY_RUN_NONINTERACTIVE</code></span></p></td>
<td>The function is run non-interactively, it must not
                         present any GUI and touch application state.
</td>
</tr>
<tr>
<td><p><a name="GWY-RUN-INTERACTIVE:CAPS"></a><span class="term"><code class="literal">GWY_RUN_INTERACTIVE</code></span></p></td>
<td>The function presents a modal user interfaces where
                      parameters can be adjusted, it returns after
                      finishing all operations.
</td>
</tr>
<tr>
<td><p><a name="GWY-RUN-IMMEDIATE:CAPS"></a><span class="term"><code class="literal">GWY_RUN_IMMEDIATE</code></span></p></td>
<td>Function is run immediately and uses parameter values
                    stored in the settings to reproduce previous run.
                    It can however present GUI error messages
                    or display progress, create new widndows, etc.
</td>
</tr>
<tr>
<td><p><a name="GWY-RUN-MASK:CAPS"></a><span class="term"><code class="literal">GWY_RUN_MASK</code></span></p></td>
<td>The mask for all the run modes.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>