/usr/share/gtk-doc/html/libgwyapp/libgwyapp-module-utils.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>module utils</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="prev" href="GwyPlainTool.html" title="GwyPlainTool">
<link rel="next" href="libgwyapp-file-module-utils.html" title="file module utils">
<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="GwyPlainTool.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </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 Application Library Reference Manual</th>
<td><a accesskey="n" href="libgwyapp-file-module-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwyapp-module-utils.synopsis" class="shortcut">Top</a>
|
<a href="#libgwyapp-module-utils.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyapp-module-utils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyapp-module-utils.top_of_page"></a>module utils</span></h2>
<p>module utils — Module utility functions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyapp-module-utils.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <app/gwymoduleutils.h>
<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="libgwyapp-module-utils.html#GwySaveAuxiliaryCreate" title="GwySaveAuxiliaryCreate ()">*GwySaveAuxiliaryCreate</a>) (<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>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> *data_len</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="libgwyapp-module-utils.html#GwySaveAuxiliaryDestroy" title="GwySaveAuxiliaryDestroy ()">*GwySaveAuxiliaryDestroy</a>) (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *data</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="libgwyapp-module-utils.html#gwy-save-auxiliary-data" title="gwy_save_auxiliary_data ()">gwy_save_auxiliary_data</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> *title</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> data_len</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> *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="libgwyapp-module-utils.html#gwy-save-auxiliary-with-callback" title="gwy_save_auxiliary_with_callback ()">gwy_save_auxiliary_with_callback</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> *title</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-module-utils.html#GwySaveAuxiliaryCreate" title="GwySaveAuxiliaryCreate ()"><span class="type">GwySaveAuxiliaryCreate</span></a> create</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-module-utils.html#GwySaveAuxiliaryDestroy" title="GwySaveAuxiliaryDestroy ()"><span class="type">GwySaveAuxiliaryDestroy</span></a> destroy</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>);
<span class="returnvalue">void</span> <a class="link" href="libgwyapp-module-utils.html#gwy-set-data-preview-size" title="gwy_set_data_preview_size ()">gwy_set_data_preview_size</a> (<em class="parameter"><code><a href="./../libgwydgets/libgwydgets/GwyDataView.html"><span class="type">GwyDataView</span></a> *data_view</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> max_size</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyapp-module-utils.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgwyapp-module-utils.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwySaveAuxiliaryCreate"></a><h3>GwySaveAuxiliaryCreate ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * (*GwySaveAuxiliaryCreate) (<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>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> *data_len</code></em>);</pre>
<p>
The type of auxiliary saved data creation function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>The data passed to <a class="link" href="libgwyapp-module-utils.html#gwy-save-auxiliary-with-callback" title="gwy_save_auxiliary_with_callback ()"><code class="function">gwy_save_auxiliary_with_callback()</code></a> as
<em class="parameter"><code>user_data</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_len</code></em> :</span></p></td>
<td>The length of the returned data in bytes. Leaving it unset has
the same effect as setting it to a negative value. See
<a class="link" href="libgwyapp-module-utils.html#gwy-save-auxiliary-data" title="gwy_save_auxiliary_data ()"><code class="function">gwy_save_auxiliary_data()</code></a> for details.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The data to save. It must not return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="GwySaveAuxiliaryDestroy"></a><h3>GwySaveAuxiliaryDestroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GwySaveAuxiliaryDestroy) (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *data</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>
The type of auxiliary saved data destruction 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 returned by the corresponding <a class="link" href="libgwyapp-module-utils.html#GwySaveAuxiliaryCreate" title="GwySaveAuxiliaryCreate ()"><span class="type">GwySaveAuxiliaryCreate</span></a>
function.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>The data passed to <a class="link" href="libgwyapp-module-utils.html#gwy-save-auxiliary-with-callback" title="gwy_save_auxiliary_with_callback ()"><code class="function">gwy_save_auxiliary_with_callback()</code></a> as
<em class="parameter"><code>user_data</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-save-auxiliary-data"></a><h3>gwy_save_auxiliary_data ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_save_auxiliary_data (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> data_len</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> *data</code></em>);</pre>
<p>
Saves a report or other auxiliary data to a user specified file.
</p>
<p>
This is actually a simple <a class="link" href="libgwyapp-module-utils.html#gwy-save-auxiliary-with-callback" title="gwy_save_auxiliary_with_callback ()"><code class="function">gwy_save_auxiliary_with_callback()</code></a> wrapper, see
its description for details.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>File chooser dialog title.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>Parent window for the file chooser dialog (may be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_len</code></em> :</span></p></td>
<td>The length of <em class="parameter"><code>data</code></em> in bytes. Pass -1 if <em class="parameter"><code>data</code></em> is text, it must
be nul-terminated then and it will be saved in text mode (this
matters if the operating system distinguishes between text and
binary). A non-negative value causes the data to be saved as
binary.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>The data to save.</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 the data was save, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was not saved for any
reason.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-save-auxiliary-with-callback"></a><h3>gwy_save_auxiliary_with_callback ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_save_auxiliary_with_callback (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-module-utils.html#GwySaveAuxiliaryCreate" title="GwySaveAuxiliaryCreate ()"><span class="type">GwySaveAuxiliaryCreate</span></a> create</code></em>,
<em class="parameter"><code><a class="link" href="libgwyapp-module-utils.html#GwySaveAuxiliaryDestroy" title="GwySaveAuxiliaryDestroy ()"><span class="type">GwySaveAuxiliaryDestroy</span></a> destroy</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>
Saves a report or other auxiliary data to a user specified file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>File chooser dialog title.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>Parent window for the file chooser dialog (may be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>create</code></em> :</span></p></td>
<td>Function to create the data (it will not be called if the user
cancels the saving).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
<td>Function to destroy the data (if will be called iff <em class="parameter"><code>create</code></em> will
be called), it may be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data passed to <em class="parameter"><code>create</code></em> and <em class="parameter"><code>destroy</code></em>.</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 the data was save, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was not saved for any
reason (I/O error, cancellation, overwrite cancellation, etc.).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-set-data-preview-size"></a><h3>gwy_set_data_preview_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_set_data_preview_size (<em class="parameter"><code><a href="./../libgwydgets/libgwydgets/GwyDataView.html"><span class="type">GwyDataView</span></a> *data_view</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> max_size</code></em>);</pre>
<p>
Sets up data view zoom to not exceed specified size.
</p>
<p>
Before calling this function, data keys have be set, data fields and layers
have to be present and physically square mode set in the container.
Sizing of both pixel-wise square and physically square displays is performed
correctly.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_view</code></em> :</span></p></td>
<td>A data view used for module preview.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_size</code></em> :</span></p></td>
<td>Maximum allowed <em class="parameter"><code>data_view</code></em> size (width and height).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|