libgwyddion20-doc 2.26-1ubuntu1 / usr / share / gtk-doc / html / libgwymodule / libgwymodule-gwymodule-process.html

This file is indexed.

/usr/share/gtk-doc/html/libgwymodule/libgwymodule-gwymodule-process.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
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<!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-process</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-file.html" title="gwymodule-file">
<link rel="next" href="libgwymodule-gwymodule-tool.html" title="gwymodule-tool">
<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-file.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-tool.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-process.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgwymodule-gwymodule-process.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwymodule-gwymodule-process"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwymodule-gwymodule-process.top_of_page"></a>gwymodule-process</span></h2>
<p>gwymodule-process — Data processing modules</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwymodule-gwymodule-process.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-process.html#GwyProcessFunc" title="GwyProcessFunc ()">*GwyProcessFunc</a>)                   (<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgwymodule-gwymoduleenums.html#GwyRunType" title="enum GwyRunType"><span class="type">GwyRunType</span></a> run</code></em>,
                                                         <em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</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-process.html#gwy-process-func-exists" title="gwy_process_func_exists ()">gwy_process_func_exists</a>             (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwymodule-gwymodule-process.html#gwy-process-func-foreach" title="gwy_process_func_foreach ()">gwy_process_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>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libgwymodule-gwymodule-process.html#gwy-process-func-get-menu-path" title="gwy_process_func_get_menu_path ()">gwy_process_func_get_menu_path</a>      (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<a class="link" href="libgwymodule-gwymoduleenums.html#GwyRunType" title="enum GwyRunType"><span class="returnvalue">GwyRunType</span></a>          <a class="link" href="libgwymodule-gwymodule-process.html#gwy-process-func-get-run-types" title="gwy_process_func_get_run_types ()">gwy_process_func_get_run_types</a>      (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="libgwymodule-gwymodule-process.html#gwy-process-func-get-sensitivity-mask" title="gwy_process_func_get_sensitivity_mask ()">gwy_process_func_get_sensitivity_mask</a>
                                                        (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libgwymodule-gwymodule-process.html#gwy-process-func-get-stock-id" title="gwy_process_func_get_stock_id ()">gwy_process_func_get_stock_id</a>       (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libgwymodule-gwymodule-process.html#gwy-process-func-get-tooltip" title="gwy_process_func_get_tooltip ()">gwy_process_func_get_tooltip</a>        (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</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-process.html#gwy-process-func-register" title="gwy_process_func_register ()">gwy_process_func_register</a>           (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgwymodule-gwymodule-process.html#GwyProcessFunc" title="GwyProcessFunc ()"><span class="type">GwyProcessFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *menu_path</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgwymodule-gwymoduleenums.html#GwyRunType" title="enum GwyRunType"><span class="type">GwyRunType</span></a> run</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> sens_mask</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwymodule-gwymodule-process.html#gwy-process-func-run" title="gwy_process_func_run ()">gwy_process_func_run</a>                (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgwymodule-gwymoduleenums.html#GwyRunType" title="enum GwyRunType"><span class="type">GwyRunType</span></a> run</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwymodule-gwymodule-process.description"></a><h2>Description</h2>
<p>
Data processing modules implement the actual ability to do something useful
with data. They reigster functions that get a <a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> with data
and either modify it or create a new data from it.
</p>
</div>
<div class="refsect1">
<a name="libgwymodule-gwymodule-process.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyProcessFunc"></a><h3>GwyProcessFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*GwyProcessFunc)                   (<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgwymodule-gwymoduleenums.html#GwyRunType" title="enum GwyRunType"><span class="type">GwyRunType</span></a> run</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
The type of data processing function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>The data container to operate on.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>run</code></em> :</span></p></td>
<td>Run mode.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Function name from as registered with <a class="link" href="libgwymodule-gwymodule-process.html#gwy-process-func-register" title="gwy_process_func_register ()"><code class="function">gwy_process_func_register()</code></a>
(single-function modules can safely ignore this argument).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-process-func-exists"></a><h3>gwy_process_func_exists ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gwy_process_func_exists             (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Checks whether a data processing function exists.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Data processing function name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if function <em class="parameter"><code>name</code></em> exists, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-process-func-foreach"></a><h3>gwy_process_func_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_process_func_foreach            (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GFunc"><span class="type">GFunc</span></a> function</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Calls a function for each process 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 process 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-process-func-get-menu-path"></a><h3>gwy_process_func_get_menu_path ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gwy_process_func_get_menu_path      (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Returns the menu path of a data processing function.
</p>
<p>
The returned menu path is only the tail part registered by the function,
i.e., without any leading "/Data Process".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Data processing function name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The menu path.  The returned string is owned by the module.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-process-func-get-run-types"></a><h3>gwy_process_func_get_run_types ()</h3>
<pre class="programlisting"><a class="link" href="libgwymodule-gwymoduleenums.html#GwyRunType" title="enum GwyRunType"><span class="returnvalue">GwyRunType</span></a>          gwy_process_func_get_run_types      (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Returns run modes supported by a data processing function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Data processing function name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The run mode bit mask.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-process-func-get-sensitivity-mask"></a><h3>gwy_process_func_get_sensitivity_mask ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gwy_process_func_get_sensitivity_mask
                                                        (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Gets menu sensititivy mask for a data processing function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Data processing function name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The menu item sensitivity mask (a combination of <a href="./../libgwyapp/libgwyapp/libgwyapp-menu.html#GwyMenuSensFlags"><span class="type">GwyMenuSensFlags</span></a>
flags).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-process-func-get-stock-id"></a><h3>gwy_process_func_get_stock_id ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gwy_process_func_get_stock_id       (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Gets stock icon id of a data processing  function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Data processing function name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The stock icon id.  The returned string is owned by the module.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-process-func-get-tooltip"></a><h3>gwy_process_func_get_tooltip ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gwy_process_func_get_tooltip        (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Gets tooltip for a data processing function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Data processing function name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The tooltip.  The returned string is owned by the module.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-process-func-register"></a><h3>gwy_process_func_register ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gwy_process_func_register           (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgwymodule-gwymodule-process.html#GwyProcessFunc" title="GwyProcessFunc ()"><span class="type">GwyProcessFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *menu_path</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgwymodule-gwymoduleenums.html#GwyRunType" title="enum GwyRunType"><span class="type">GwyRunType</span></a> run</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> sens_mask</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>);</pre>
<p>
Registers a data processing function.
</p>
<p>
Note: the string arguments are not copied as modules are not expected to
vanish.  If they are constructed (non-constant) strings, do not free them.
Should modules ever become unloadable they will get a chance to clean-up.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Name of function to register.  It should be a valid identifier and
if a module registers only one function, module and function names
should be the same.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>The function itself.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>menu_path</code></em> :</span></p></td>
<td>Menu path under Data Process menu.  The menu path should be
marked translatabe, but passed untranslated (to allow merging
of translated and untranslated submenus).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stock_id</code></em> :</span></p></td>
<td>Stock icon id for toolbar.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>run</code></em> :</span></p></td>
<td>Supported run modes.  Data processing functions can have two run
modes: <a class="link" href="libgwymodule-gwymoduleenums.html#GWY-RUN-IMMEDIATE:CAPS"><code class="literal">GWY_RUN_IMMEDIATE</code></a> (no questions asked) and
<a class="link" href="libgwymodule-gwymoduleenums.html#GWY-RUN-INTERACTIVE:CAPS"><code class="literal">GWY_RUN_INTERACTIVE</code></a> (a modal dialog with parameters).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sens_mask</code></em> :</span></p></td>
<td>Sensitivity mask (a combination of <a href="./../libgwyapp/libgwyapp/libgwyapp-menu.html#GwyMenuSensFlags"><span class="type">GwyMenuSensFlags</span></a> flags).
Usually it contains <a href="./../libgwyapp/libgwyapp/libgwyapp-menu.html#GWY-MENU-FLAG-DATA:CAPS"><span class="type">GWY_MENU_FLAG_DATA</span></a>, possibly other
requirements.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
<td>Tooltip for this function.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Normally <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>; <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-process-func-run"></a><h3>gwy_process_func_run ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_process_func_run                (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgwymodule-gwymoduleenums.html#GwyRunType" title="enum GwyRunType"><span class="type">GwyRunType</span></a> run</code></em>);</pre>
<p>
Runs a data processing function identified by <em class="parameter"><code>name</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Data processing function name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Data (a <a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>run</code></em> :</span></p></td>
<td>How the function should be run.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.8</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.