libgwyddion20-doc 2.34-3ubuntu1 / usr / share / gtk-doc / html / libgwyapp / libgwyapp-app.html

This file is indexed.

/usr/share/gtk-doc/html/libgwyapp/libgwyapp-app.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
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
<!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 Application Library Reference Manual: app</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="next" href="libgwyapp-data-browser.html" title="data-browser">
<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="#libgwyapp-app.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><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgwyapp-data-browser.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwyapp-app"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyapp-app.top_of_page"></a>app</span></h2>
<p>app — Core application interface, window management</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyapp-app.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;app/gwyapp.h&gt;

<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-app.html#gwy-app-switch-tool" title="gwy_app_switch_tool ()">gwy_app_switch_tool</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> *toolname</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-app.html#gwy-app-add-main-accel-group" title="gwy_app_add_main_accel_group ()">gwy_app_add_main_accel_group</a>        (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-app.html#gwy-app-save-window-position" title="gwy_app_save_window_position ()">gwy_app_save_window_position</a>        (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</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> *prefix</code></em>,
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> position</code></em>,
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> size</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-app.html#gwy-app-restore-window-position" title="gwy_app_restore_window_position ()">gwy_app_restore_window_position</a>     (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</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> *prefix</code></em>,
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> grow_only</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="libgwyapp-app.html#gwy-app-main-window-get" title="gwy_app_main_window_get ()">gwy_app_main_window_get</a>             (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-app.html#gwy-app-data-view-change-mask-color" title="gwy_app_data_view_change_mask_color ()">gwy_app_data_view_change_mask_color</a> (<em class="parameter"><code><a href="../libgwydgets/GwyDataView.html"><span class="type">GwyDataView</span></a> *data_view</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-app.html#gwy-app-quit" title="gwy_app_quit ()">gwy_app_quit</a>                        (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-app.html#gwy-app-init-widget-styles" title="gwy_app_init_widget_styles ()">gwy_app_init_widget_styles</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-app.html#gwy-app-init-i18n" title="gwy_app_init_i18n ()">gwy_app_init_i18n</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-app.html#gwy-app-init-common" title="gwy_app_init_common ()">gwy_app_init_common</a>                 (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>,
                                                         <em class="parameter"><code>...</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyapp-app.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgwyapp-app.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-app-switch-tool"></a><h3>gwy_app_switch_tool ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_switch_tool                 (<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> *toolname</code></em>);</pre>
<p>
Switches the current tool.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>toolname</code></em> :</span></p></td>
<td>Tool name, that is <a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> name of the tool type.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-add-main-accel-group"></a><h3>gwy_app_add_main_accel_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_add_main_accel_group        (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>);</pre>
<p>
Adds main (global) application accelerator group to a window.
</p>
<p>
This includes accelerators for terminating Gwyddion, opening files, etc.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>A window.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-save-window-position"></a><h3>gwy_app_save_window_position ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_save_window_position        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</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> *prefix</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> position</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> size</code></em>);</pre>
<p>
Saves position and/or size of a window to settings.
</p>
<p>
Some sanity checks are included, therefore if window position and/or size
is too suspicious, it is not saved.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>A window to save position of.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
<td>Unique prefix in settings to store the information under.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to save position information.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to save size information.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-restore-window-position"></a><h3>gwy_app_restore_window_position ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_restore_window_position     (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</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> *prefix</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> grow_only</code></em>);</pre>
<p>
Restores a window position and/or size from settings.
</p>
<p>
Unlike <a class="link" href="libgwyapp-app.html#gwy-app-save-window-position" title="gwy_app_save_window_position ()"><code class="function">gwy_app_save_window_position()</code></a>, this function has no <em class="parameter"><code>position</code></em> and
<em class="parameter"><code>size</code></em> arguments, it simply restores all attributes that were saved.
</p>
<p>
Note to restore position (not size) it should be called twice for each
window to accommodate sloppy window managers: once before the window is
shown, second time immediately after showing the window.
</p>
<p>
Some sanity checks are included, therefore if saved window position and/or
size is too suspicious, it is not restored.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>A window to restore position of.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
<td>Unique prefix in settings to get the information from (the same as
in <a class="link" href="libgwyapp-app.html#gwy-app-save-window-position" title="gwy_app_save_window_position ()"><code class="function">gwy_app_save_window_position()</code></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grow_only</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to only attempt set the window default size bigger than it
requests, never smaller.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-main-window-get"></a><h3>gwy_app_main_window_get ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         gwy_app_main_window_get             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns Gwyddion main application window (toolbox).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The Gwyddion toolbox.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-data-view-change-mask-color"></a><h3>gwy_app_data_view_change_mask_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_data_view_change_mask_color (<em class="parameter"><code><a href="../libgwydgets/GwyDataView.html"><span class="type">GwyDataView</span></a> *data_view</code></em>);</pre>
<p>
Runs mask color selector on a data view.
</p>
<p>
This is a convenience function to run <a href="../libgwydgets/libgwydgets-gwydgetutils.html#gwy-color-selector-for-mask"><code class="function">gwy_color_selector_for_mask()</code></a>,
possibly taking the initial color from settings.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>data_view</code></em> :</span></p></td>
<td>A data view (of application's data window).  It must have a
mask.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-quit"></a><h3>gwy_app_quit ()</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_quit                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Quits the application.
</p>
<p>
This function may present a confirmation dialog to the user and it may
let the application to continue running.  If it quits the application,
it performs some shutdown actions and then quits the Gtk+ main loop with
<a href="/usr/share/gtk-doc/html/gtk3/gtk3-General.html#gtk-main-quit"><code class="function">gtk_main_quit()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Always <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to be usable as an event handler.  However, if the
application is actually terminated, this function does not return.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-init-widget-styles"></a><h3>gwy_app_init_widget_styles ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_init_widget_styles          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Sets up style properties for special Gwyddion widgets.
</p>
<p>
Normally not needed to call explicitly.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-init-i18n"></a><h3>gwy_app_init_i18n ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_init_i18n                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Initializes internationalization.
</p>
<p>
Normally not needed to call explicitly.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-init-common"></a><h3>gwy_app_init_common ()</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_init_common                 (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>,
                                                         <em class="parameter"><code>...</code></em>);</pre>
<p>
Performs common initialization.
</p>
<p>
FIXME: Much more to say.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Error location for settings loading error.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>List of module types to load, terminated with <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.  Possible types
are "file", "graph", "layer", "process", "tool" plus two special
values "" and "all" for untyped modules (like plug-in proxy) and
all modules, respectively.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Settings loading status.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.