libgwyddion20-doc 2.26-1ubuntu1 / usr / share / gtk-doc / html / libgwyapp / libgwyapp-file.html

This file is indexed.

/usr/share/gtk-doc/html/libgwyapp/libgwyapp-file.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>file</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="libgwyapp-settings.html" title="settings">
<link rel="next" href="libgwyapp-filelist.html" title="filelist">
<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="libgwyapp-settings.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-filelist.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-file.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgwyapp-file.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyapp-file"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyapp-file.top_of_page"></a>file</span></h2>
<p>file — High level file functions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyapp-file.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;app/gwyapp.h&gt;

<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-file.html#gwy-app-file-confirm-overwrite" title="gwy_app_file_confirm_overwrite ()">gwy_app_file_confirm_overwrite</a>      (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *chooser</code></em>);
<a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="returnvalue">GwyContainer</span></a> *      <a class="link" href="libgwyapp-file.html#gwy-app-file-load" title="gwy_app_file_load ()">gwy_app_file_load</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> *filename_utf8</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> *filename_sys</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>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-file.html#gwy-app-file-merge" title="gwy_app_file_merge ()">gwy_app_file_merge</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-file.html#gwy-app-file-open" title="gwy_app_file_open ()">gwy_app_file_open</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-file.html#gwy-app-file-save" title="gwy_app_file_save ()">gwy_app_file_save</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-file.html#gwy-app-file-save-as" title="gwy_app_file_save_as ()">gwy_app_file_save_as</a>                (<em class="parameter"><code><span class="type">void</span></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-file.html#gwy-app-file-write" title="gwy_app_file_write ()">gwy_app_file_write</a>                  (<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</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> *filename_utf8</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> *filename_sys</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>);
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="libgwyapp-file.html#gwy-app-get-current-directory" title="gwy_app_get_current_directory ()">gwy_app_get_current_directory</a>       (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-file.html#gwy-app-set-current-directory" title="gwy_app_set_current_directory ()">gwy_app_set_current_directory</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> *directory</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyapp-file.description"></a><h2>Description</h2>
<p>
High-level functions <a class="link" href="libgwyapp-file.html#gwy-app-file-load" title="gwy_app_file_load ()"><code class="function">gwy_app_file_load()</code></a> and <a class="link" href="libgwyapp-file.html#gwy-app-file-write" title="gwy_app_file_write ()"><code class="function">gwy_app_file_write()</code></a>
wrap low-level file handling functions from
<a href="./../libgwymodule/libgwymodule/libgwymodule-gwymodule-file.html">gwymodule-file</a>
and handle registration of loaded containers in data browser, showing
windows, remembering file types, or the differenced between save and export.
</p>
<p>
They are complemented by application-level functions <a class="link" href="libgwyapp-file.html#gwy-app-file-open" title="gwy_app_file_open ()"><code class="function">gwy_app_file_open()</code></a>,
<a class="link" href="libgwyapp-file.html#gwy-app-file-save" title="gwy_app_file_save ()"><code class="function">gwy_app_file_save()</code></a>, and <a class="link" href="libgwyapp-file.html#gwy-app-file-save-as" title="gwy_app_file_save_as ()"><code class="function">gwy_app_file_save_as()</code></a> that perform the
corresponding operations of File menu.  These are probably not of general
interest.
</p>
<p>
Beside that, functions to maintain application-level idea of current
directory are provided: <a class="link" href="libgwyapp-file.html#gwy-app-get-current-directory" title="gwy_app_get_current_directory ()"><code class="function">gwy_app_get_current_directory()</code></a>,
<a class="link" href="libgwyapp-file.html#gwy-app-set-current-directory" title="gwy_app_set_current_directory ()"><code class="function">gwy_app_set_current_directory()</code></a>.  They should be used in place of system
<code class="function">chdir()</code> which has various unwanted side-effect, like change of the directory
where core is dumped on segfault.
</p>
</div>
<div class="refsect1">
<a name="libgwyapp-file.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-app-file-confirm-overwrite"></a><h3>gwy_app_file_confirm_overwrite ()</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_app_file_confirm_overwrite      (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *chooser</code></em>);</pre>
<p>
Asks for file overwrite for a file save chooser.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>A file chooser for save action.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if it is OK to overwrite the file, <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> when user cancelled
it or there was other problem.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-file-load"></a><h3>gwy_app_file_load ()</h3>
<pre class="programlisting"><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="returnvalue">GwyContainer</span></a> *      gwy_app_file_load                   (<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> *filename_utf8</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> *filename_sys</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>
Loads a file into application (a high-level function).
</p>
<p>
At least one of <em class="parameter"><code>filename_utf8</code></em>, <em class="parameter"><code>filename_sys</code></em> must be non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<p>
The file is loaded in interactive mode, modules can ask for user input.
Upon a successful load all necessary setup tasks are performed.  If the
load fails, an error dialog is presented.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename_utf8</code></em> :</span></p></td>
<td>Name of file to load, in UTF-8.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename_sys</code></em> :</span></p></td>
<td>Name of file to load, in GLib encoding.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>File type to open file as, but normally <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to automatically
detect from file contents.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Container of the just loaded file on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-file-merge"></a><h3>gwy_app_file_merge ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_file_merge                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Merges a user-selected file (very high-level app function).
</p>
<p class="since">Since 2.7</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-file-open"></a><h3>gwy_app_file_open ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_file_open                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Opens a user-selected file (very high-level app function).
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-file-save"></a><h3>gwy_app_file_save ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_file_save                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Saves current data to a file (very high-level app function).
</p>
<p>
May fall back to <a class="link" href="libgwyapp-file.html#gwy-app-file-save-as" title="gwy_app_file_save_as ()"><code class="function">gwy_app_file_save_as()</code></a> when current data has no file name
associated with it, or the format it was loaded from is not saveable.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-file-save-as"></a><h3>gwy_app_file_save_as ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_file_save_as                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Saves current data to a user-selected file (very high-level app function).
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-file-write"></a><h3>gwy_app_file_write ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gwy_app_file_write                  (<em class="parameter"><code><a href="./../libgwyddion/libgwyddion/GwyContainer.html"><span class="type">GwyContainer</span></a> *data</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> *filename_utf8</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> *filename_sys</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>
Writes container to a file (a high-level function).
</p>
<p>
At least one of <em class="parameter"><code>filename_utf8</code></em>, <em class="parameter"><code>filename_sys</code></em> must be non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<p>
The file is saved in interactive mode, modules can ask for user input.
If the write fails, an error dialog is presented.
</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>Data to write.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename_utf8</code></em> :</span></p></td>
<td>Name of file to write data to, in UTF-8.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename_sys</code></em> :</span></p></td>
<td>Name of file to write data to, in GLib encoding.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>File type to open file as, but normally <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to automatically detect
from file 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> on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-get-current-directory"></a><h3>gwy_app_get_current_directory ()</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_app_get_current_directory       (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns what the app uses as `current directory'.
</p>
<p>
Warning: This function is probably temporary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string in GLib file name encoding that should not be modified
neither freed, valid only until next call to
<a class="link" href="libgwyapp-file.html#gwy-app-set-current-directory" title="gwy_app_set_current_directory ()"><code class="function">gwy_app_set_current_directory()</code></a>.  It ends with a
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#G-DIR-SEPARATOR-S:CAPS"><code class="literal">G_DIR_SEPARATOR_S</code></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-set-current-directory"></a><h3>gwy_app_set_current_directory ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_set_current_directory       (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *directory</code></em>);</pre>
<p>
Sets what the app should use as `current directory'.
</p>
<p>
Warning: This function is probably temporary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>The directory to set, or a filename to take directory part
from, it must be an absolute path.  In GLib file name encoding.</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.