libcanberra-doc 0.30-2.1ubuntu1 / usr / share / gtk-doc / html / libcanberra / libcanberra-canberra-gtk.html

This file is indexed.

/usr/share/gtk-doc/html/libcanberra/libcanberra-canberra-gtk.html is in libcanberra-doc 0.30-2.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>canberra-gtk: libcanberra Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libcanberra Reference Manual">
<link rel="up" href="ch01.html" title="libcanberra">
<link rel="prev" href="libcanberra-canberra.html" title="canberra">
<meta name="generator" content="GTK-Doc V1.24 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libcanberra-canberra-gtk.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libcanberra-canberra.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><img src="right-insensitive.png" width="16" height="16" border="0"></td>
</tr></table>
<div class="refentry">
<a name="libcanberra-canberra-gtk"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libcanberra-canberra-gtk.top_of_page"></a>canberra-gtk</span></h2>
<p>canberra-gtk — Gtk+ libcanberra Bindings</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libcanberra-canberra-gtk.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libcanberra-canberra.html#ca-context" title="struct ca_context"><span class="returnvalue">ca_context</span></a> *
</td>
<td class="function_name">
<a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-context-get" title="ca_gtk_context_get ()">ca_gtk_context_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-proplist-set-for-widget" title="ca_gtk_proplist_set_for_widget ()">ca_gtk_proplist_set_for_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-play-for-widget" title="ca_gtk_play_for_widget ()">ca_gtk_play_for_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-proplist-set-for-event" title="ca_gtk_proplist_set_for_event ()">ca_gtk_proplist_set_for_event</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-play-for-event" title="ca_gtk_play_for_event ()">ca_gtk_play_for_event</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-widget-disable-sounds" title="ca_gtk_widget_disable_sounds ()">ca_gtk_widget_disable_sounds</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libcanberra-canberra-gtk.description"></a><h2>Description</h2>
<p>libcanberra-gtk provides a few functions that simplify libcanberra
usage from Gtk+ programs. It maintains a single ca_context object
per <span class="type">GdkScreen</span> that is made accessible via
<code class="function">ca_gtk_context_get_for_screen()</code>, with a shortcut <a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-context-get" title="ca_gtk_context_get ()"><code class="function">ca_gtk_context_get()</code></a>
to get the context for the default screen. More importantly, it provides
a few functions
to compile event sound property lists based on GtkWidget objects or
GdkEvent events.</p>
</div>
<div class="refsect1">
<a name="libcanberra-canberra-gtk.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ca-gtk-context-get"></a><h3>ca_gtk_context_get ()</h3>
<pre class="programlisting"><a class="link" href="libcanberra-canberra.html#ca-context" title="struct ca_context"><span class="returnvalue">ca_context</span></a> *
ca_gtk_context_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Gets the single ca_context object for the default screen. See
<code class="function">ca_gtk_context_get_for_screen()</code>.</p>
<div class="refsect3">
<a name="id-1.2.3.5.2.5"></a><h4>Returns</h4>
<p> a ca_context object. The object is owned by libcanberra-gtk
and must not be destroyed</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ca-gtk-proplist-set-for-widget"></a><h3>ca_gtk_proplist_set_for_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
ca_gtk_proplist_set_for_widget (<em class="parameter"><code><a class="link" href="libcanberra-canberra.html#ca-proplist" title="struct ca_proplist"><span class="type">ca_proplist</span></a> *p</code></em>,
                                <em class="parameter"><code><span class="type">GtkWidget</span> *w</code></em>);</pre>
<p>Fill in a ca_proplist object for a sound event that shall originate
from the specified Gtk Widget. This will fill in properties like
<a class="link" href="libcanberra-canberra.html#CA-PROP-WINDOW-NAME:CAPS" title="CA_PROP_WINDOW_NAME"><code class="literal">CA_PROP_WINDOW_NAME</code></a> or <a class="link" href="libcanberra-canberra.html#CA-PROP-WINDOW-X11-DISPLAY:CAPS" title="CA_PROP_WINDOW_X11_DISPLAY"><code class="literal">CA_PROP_WINDOW_X11_DISPLAY</code></a> for you.</p>
<div class="refsect3">
<a name="id-1.2.3.5.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>p</p></td>
<td class="parameter_description"><p>The proplist to store these sound event properties in</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>w</p></td>
<td class="parameter_description"><p>The Gtk widget to base these sound event properties on</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.5.3.6"></a><h4>Returns</h4>
<p> 0 on success, negative error code on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ca-gtk-play-for-widget"></a><h3>ca_gtk_play_for_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
ca_gtk_play_for_widget (<em class="parameter"><code><span class="type">GtkWidget</span> *w</code></em>,
                        <em class="parameter"><code><span class="type">uint32_t</span> id</code></em>,
                        <em class="parameter"><code>...</code></em>);</pre>
<p>Play a sound event for the specified widget. This will internally
call <a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-proplist-set-for-widget" title="ca_gtk_proplist_set_for_widget ()"><code class="function">ca_gtk_proplist_set_for_widget()</code></a> and then merge them with the
properties passed in via the NULL terminated argument
list. Finally, it will call <a class="link" href="libcanberra-canberra.html#ca-context-play-full" title="ca_context_play_full ()"><code class="function">ca_context_play_full()</code></a> to actually play
the event sound.</p>
<div class="refsect3">
<a name="id-1.2.3.5.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>w</p></td>
<td class="parameter_description"><p>The Gtk widget to base these sound event properties on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>The event id that can later be used to cancel this event sound
using <a class="link" href="libcanberra-canberra.html#ca-context-cancel" title="ca_context_cancel ()"><code class="function">ca_context_cancel()</code></a>. This can be any integer and shall be
chosen be the client program. It is a good idea to pass 0 here if
cancelling the sound later is not needed. If the same id is passed
to multiple sounds they can be canceled with a single
<a class="link" href="libcanberra-canberra.html#ca-context-cancel" title="ca_context_cancel ()"><code class="function">ca_context_cancel()</code></a> call.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>additional event properties as pairs of strings, terminated by NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.5.4.6"></a><h4>Returns</h4>
<p> 0 on success, negative error code on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ca-gtk-proplist-set-for-event"></a><h3>ca_gtk_proplist_set_for_event ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
ca_gtk_proplist_set_for_event (<em class="parameter"><code><a class="link" href="libcanberra-canberra.html#ca-proplist" title="struct ca_proplist"><span class="type">ca_proplist</span></a> *p</code></em>,
                               <em class="parameter"><code><span class="type">GdkEvent</span> *e</code></em>);</pre>
<p>Fill in a ca_proplist object for a sound event that is being
triggered by the specified Gdk Event. This will fill in properties
like <a class="link" href="libcanberra-canberra.html#CA-PROP-EVENT-MOUSE-X:CAPS" title="CA_PROP_EVENT_MOUSE_X"><code class="literal">CA_PROP_EVENT_MOUSE_X</code></a> or <a class="link" href="libcanberra-canberra.html#CA-PROP-EVENT-MOUSE-BUTTON:CAPS" title="CA_PROP_EVENT_MOUSE_BUTTON"><code class="literal">CA_PROP_EVENT_MOUSE_BUTTON</code></a> for
you. This will internally also cal <a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-proplist-set-for-widget" title="ca_gtk_proplist_set_for_widget ()"><code class="function">ca_gtk_proplist_set_for_widget()</code></a>
on the widget this event belongs to.</p>
<div class="refsect3">
<a name="id-1.2.3.5.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>p</p></td>
<td class="parameter_description"><p>The proplist to store these sound event properties in</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>e</p></td>
<td class="parameter_description"><p>The Gdk event to base these sound event properties on</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.5.5.6"></a><h4>Returns</h4>
<p> 0 on success, negative error code on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ca-gtk-play-for-event"></a><h3>ca_gtk_play_for_event ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
ca_gtk_play_for_event (<em class="parameter"><code><span class="type">GdkEvent</span> *e</code></em>,
                       <em class="parameter"><code><span class="type">uint32_t</span> id</code></em>,
                       <em class="parameter"><code>...</code></em>);</pre>
<p>Play a sound event for the specified event. This will internally
call <a class="link" href="libcanberra-canberra-gtk.html#ca-gtk-proplist-set-for-event" title="ca_gtk_proplist_set_for_event ()"><code class="function">ca_gtk_proplist_set_for_event()</code></a> and then merge them with the
properties passed in via the NULL terminated argument
list. Finally, it will call <a class="link" href="libcanberra-canberra.html#ca-context-play-full" title="ca_context_play_full ()"><code class="function">ca_context_play_full()</code></a> to actually play
the event sound.</p>
<div class="refsect3">
<a name="id-1.2.3.5.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>e</p></td>
<td class="parameter_description"><p>The Gdk event to base these sound event properties on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>The event id that can later be used to cancel this event sound
using <a class="link" href="libcanberra-canberra.html#ca-context-cancel" title="ca_context_cancel ()"><code class="function">ca_context_cancel()</code></a>. This can be any integer and shall be
chosen be the client program. It is a good idea to pass 0 here if
cancelling the sound later is not needed. If the same id is passed
to multiple sounds they can be canceled with a single
<a class="link" href="libcanberra-canberra.html#ca-context-cancel" title="ca_context_cancel ()"><code class="function">ca_context_cancel()</code></a> call.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>additional event properties as pairs of strings, terminated by NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.5.6.6"></a><h4>Returns</h4>
<p> 0 on success, negative error code on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ca-gtk-widget-disable-sounds"></a><h3>ca_gtk_widget_disable_sounds ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ca_gtk_widget_disable_sounds (<em class="parameter"><code><span class="type">GtkWidget</span> *w</code></em>,
                              <em class="parameter"><code><span class="type">gboolean</span> enable</code></em>);</pre>
<p>By default sound events are automatically generated for all kinds
of input events. Use this function to disable this. This is
intended to be used for widgets which directly generate sound
events.</p>
<div class="refsect3">
<a name="id-1.2.3.5.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>w</p></td>
<td class="parameter_description"><p>The Gtk widget to disable automatic event sounds for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enable</p></td>
<td class="parameter_description"><p>Boolean specifying whether sound events shall be enabled or disabled for this widget.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libcanberra-canberra-gtk.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.