This file is indexed.

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

<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-wait.html#gwy-app-wait-cursor-finish" title="gwy_app_wait_cursor_finish ()">gwy_app_wait_cursor_finish</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-wait.html#gwy-app-wait-cursor-start" title="gwy_app_wait_cursor_start ()">gwy_app_wait_cursor_start</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-wait.html#gwy-app-wait-finish" title="gwy_app_wait_finish ()">gwy_app_wait_finish</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-wait.html#gwy-app-wait-set-fraction" title="gwy_app_wait_set_fraction ()">gwy_app_wait_set_fraction</a>           (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</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-wait.html#gwy-app-wait-set-message" title="gwy_app_wait_set_message ()">gwy_app_wait_set_message</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> *message</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-wait.html#gwy-app-wait-set-message-prefix" title="gwy_app_wait_set_message_prefix ()">gwy_app_wait_set_message_prefix</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> *prefix</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgwyapp-wait.html#gwy-app-wait-start" title="gwy_app_wait_start ()">gwy_app_wait_start</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> *message</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyapp-wait.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgwyapp-wait.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-app-wait-cursor-finish"></a><h3>gwy_app_wait_cursor_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_wait_cursor_finish          (<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>
Resets the cursor for a window.
</p>
<p>
This function lets the Gtk+ main loop to run.
</p>
<p>
If the window cursor was non-default before <a class="link" href="libgwyapp-wait.html#gwy-app-wait-cursor-start" title="gwy_app_wait_cursor_start ()"><code class="function">gwy_app_wait_cursor_start()</code></a>,
it is not restored and has to be set manually.  This limitation is due to
the nonexistence of a method to obtain the current cursor.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-wait-cursor-start"></a><h3>gwy_app_wait_cursor_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_wait_cursor_start           (<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>
Changes the cursor for a window to indicate work.
</p>
<p>
This function lets the Gtk+ main loop to run.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<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>
<p class="since">Since 2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-wait-finish"></a><h3>gwy_app_wait_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_wait_finish                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Finishes waiting, closing the dialog.
</p>
<p>
No function like <a class="link" href="libgwyapp-wait.html#gwy-app-wait-set-message" title="gwy_app_wait_set_message ()"><code class="function">gwy_app_wait_set_message()</code></a> should be call after that.
</p>
<p>
This function must be called even if user cancelled the operation.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-wait-set-fraction"></a><h3>gwy_app_wait_set_fraction ()</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_wait_set_fraction           (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction</code></em>);</pre>
<p>
Sets the amount of progress the progress bar on the dialog displays.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fraction</code></em> :</span></p></td>
<td>The progress of the operation, as a number from 0 to 1.</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 the operation can continue, <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if user cancelled it
meanwhile.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-wait-set-message"></a><h3>gwy_app_wait_set_message ()</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_wait_set_message            (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);</pre>
<p>
Sets the message shown on the progress dialog.
</p>
<p>
See also <a class="link" href="libgwyapp-wait.html#gwy-app-wait-set-message-prefix" title="gwy_app_wait_set_message_prefix ()"><code class="function">gwy_app_wait_set_message_prefix()</code></a> which makes this function more
usable directly as a callback.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>A mesage to show in the progress dialog.</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 operation can continue, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if user cancelled it
meanwhile.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-wait-set-message-prefix"></a><h3>gwy_app_wait_set_message_prefix ()</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_wait_set_message_prefix     (<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>);</pre>
<p>
Sets prefix for the messages shown in the progress dialog.
</p>
<p>
The prefix will take effect in the next <a class="link" href="libgwyapp-wait.html#gwy-app-wait-set-message" title="gwy_app_wait_set_message ()"><code class="function">gwy_app_wait_set_message()</code></a> call.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
<td>The prefix for new messages.</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 operation can continue, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if user cancelled it
meanwhile.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-wait-start"></a><h3>gwy_app_wait_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gwy_app_wait_start                  (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/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> *message</code></em>);</pre>
<p>
Starts waiting for a window <em class="parameter"><code>window</code></em>, creating a dialog with a progress bar.
</p>
<p>
Waiting is global, there can be only one at a time.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>A window.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>A message to show in the wait dialog.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.8</div>
</body>
</html>