~ubuntu-branches/ubuntu/trusty/libgnome/trusty

« back to all changes in this revision

Viewing changes to doc/reference/html/libgnome-gnome-triggers.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-03-06 17:27:16 UTC
  • mfrom: (1.1.29 upstream)
  • Revision ID: james.westby@ubuntu.com-20090306172716-lnh6jr51eoy0x2qo
Tags: 2.25.1-0ubuntu1
* New upstream version
* debian/control.in:
  - set vcs location
* debian/watch:
  - track unstable series

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>gnome-triggers</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.2">
7
7
<link rel="home" href="index.html" title="GNOME Library Reference Manual">
8
8
<link rel="up" href="ch04.html" title="Miscellaneous">
9
9
<link rel="prev" href="libgnome-gnome-sound.html" title="gnome-sound">
10
10
<link rel="next" href="ch05.html" title="Lower Level Interactions">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgnome.html" title="Part I. GNOME Library (libgnome)">
14
14
<link rel="chapter" href="ch01.html" title="Initializing Applications and Starting Programs">
37
37
<th width="100%" align="center">GNOME Library Reference Manual</th>
38
38
<td><a accesskey="n" href="ch05.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
39
39
</tr>
40
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgnome-gnome-triggers.synopsis" class="shortcut">Top</a>
41
 
                   | 
42
 
                  <a href="#libgnome-gnome-triggers.description" class="shortcut">Description</a></nobr></td></tr>
 
40
<tr><td colspan="5" class="shortcuts">
 
41
<a href="#libgnome-gnome-triggers.synopsis" class="shortcut">Top</a>
 
42
                 | 
 
43
                <a href="#libgnome-gnome-triggers.description" class="shortcut">Description</a>
 
44
</td></tr>
43
45
</table>
44
46
<div class="refentry" lang="en">
45
47
<a name="libgnome-gnome-triggers"></a><div class="titlepage"></div>
60
62
void                (<a class="link" href="libgnome-gnome-triggers.html#GnomeTriggerActionFunction" title="GnomeTriggerActionFunction ()">*GnomeTriggerActionFunction</a>)       (char *msg,
61
63
                                                         char *level,
62
64
                                                         char *supinfo[]);
 
65
                    <a class="link" href="libgnome-gnome-triggers.html#GnomeTrigger" title="GnomeTrigger">GnomeTrigger</a>;
 
66
void                <a class="link" href="libgnome-gnome-triggers.html#gnome-triggers-add-trigger" title="gnome_triggers_add_trigger ()">gnome_triggers_add_trigger</a>          (<a class="link" href="libgnome-gnome-triggers.html#GnomeTrigger" title="GnomeTrigger">GnomeTrigger</a> *nt,
 
67
                                                         ...);
 
68
void                <a class="link" href="libgnome-gnome-triggers.html#gnome-triggers-vadd-trigger" title="gnome_triggers_vadd_trigger ()">gnome_triggers_vadd_trigger</a>         (<a class="link" href="libgnome-gnome-triggers.html#GnomeTrigger" title="GnomeTrigger">GnomeTrigger</a> *nt,
 
69
                                                         char *supinfo[]);
 
70
void                <a class="link" href="libgnome-gnome-triggers.html#gnome-triggers-do" title="gnome_triggers_do ()">gnome_triggers_do</a>                   (const char *msg,
 
71
                                                         const char *level,
 
72
                                                         ...);
 
73
void                <a class="link" href="libgnome-gnome-triggers.html#gnome-triggers-vdo" title="gnome_triggers_vdo ()">gnome_triggers_vdo</a>                  (const char *msg,
 
74
                                                         const char *level,
 
75
                                                         const char *supinfo[]);
63
76
</pre>
64
77
</div>
65
78
<div class="refsect1" lang="en">
105
118
<col align="left" valign="top">
106
119
<tbody>
107
120
<tr>
108
 
<td><p><a name="GTRIG-NONE:CAPS"></a><span class="term"><code class="literal">GTRIG_NONE</code></span></p></td>
 
121
<td><p><a name="GTRIG-NONE--CAPS"></a><span class="term"><code class="literal">GTRIG_NONE</code></span></p></td>
109
122
<td>A null trigger type. Should never be used.
110
123
</td>
111
124
</tr>
112
125
<tr>
113
 
<td><p><a name="GTRIG-FUNCTION:CAPS"></a><span class="term"><code class="literal">GTRIG_FUNCTION</code></span></p></td>
 
126
<td><p><a name="GTRIG-FUNCTION--CAPS"></a><span class="term"><code class="literal">GTRIG_FUNCTION</code></span></p></td>
114
127
<td>The trigger causes a function to be executed.
115
128
</td>
116
129
</tr>
117
130
<tr>
118
 
<td><p><a name="GTRIG-COMMAND:CAPS"></a><span class="term"><code class="literal">GTRIG_COMMAND</code></span></p></td>
 
131
<td><p><a name="GTRIG-COMMAND--CAPS"></a><span class="term"><code class="literal">GTRIG_COMMAND</code></span></p></td>
119
132
<td>The trigger causes a command to be executed (using <code class="function">execv()</code>).
120
133
</td>
121
134
</tr>
122
135
<tr>
123
 
<td><p><a name="GTRIG-MEDIAPLAY:CAPS"></a><span class="term"><code class="literal">GTRIG_MEDIAPLAY</code></span></p></td>
 
136
<td><p><a name="GTRIG-MEDIAPLAY--CAPS"></a><span class="term"><code class="literal">GTRIG_MEDIAPLAY</code></span></p></td>
124
137
<td>The trigger causes a sound to be played.
125
 
 
126
138
</td>
127
139
</tr>
128
140
</tbody>
135
147
                                                         char *level,
136
148
                                                         char *supinfo[]);</pre>
137
149
<p>
138
 
The signature of a function that can used as a target for <a class="link" href="libgnome-gnome-triggers.html#GTRIG-FUNCTION:CAPS"><span class="type">GTRIG_FUNCTION</span></a>
139
 
types of <span class="type">GnomeTrigger</span> instances.
 
150
The signature of a function that can used as a target for <a class="link" href="libgnome-gnome-triggers.html#GTRIG-FUNCTION--CAPS"><span class="type">GTRIG_FUNCTION</span></a>
 
151
types of <a class="link" href="libgnome-gnome-triggers.html#GnomeTrigger" title="GnomeTrigger"><span class="type">GnomeTrigger</span></a> instances.
140
152
</p>
141
153
<div class="variablelist"><table border="0">
142
154
<col align="left" valign="top">
143
155
<tbody>
144
156
<tr>
145
157
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
146
 
<td>The human-readable message that was passed to <code class="function">gnome_triggers_do()</code>. May be
 
158
<td>The human-readable message that was passed to <a class="link" href="libgnome-gnome-triggers.html#gnome-triggers-do" title="gnome_triggers_do ()"><code class="function">gnome_triggers_do()</code></a>. May be
147
159
<a
148
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
160
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
149
161
><code class="literal">NULL</code></a>.
150
162
</td>
151
163
</tr>
152
164
<tr>
153
165
<td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
154
166
<td>The severity level of the event. May be <a
155
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
167
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
156
168
><code class="literal">NULL</code></a>.
157
169
</td>
158
170
</tr>
159
171
<tr>
160
172
<td><p><span class="term"><em class="parameter"><code>supinfo</code></em> :</span></p></td>
161
173
<td>The section in which the event belongs. This is a <a
162
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
174
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
163
175
><code class="literal">NULL</code></a> terminated
164
176
array.
165
 
 
166
 
 
 
177
</td>
 
178
</tr>
 
179
</tbody>
 
180
</table></div>
 
181
</div>
 
182
<hr>
 
183
<div class="refsect2" lang="en">
 
184
<a name="GnomeTrigger"></a><h3>GnomeTrigger</h3>
 
185
<pre class="programlisting">typedef struct {
 
186
        GnomeTriggerType type;
 
187
        union {
 
188
                /*
 
189
                 * These will be passed the same info as
 
190
                 * gnome_triggers_do was given.
 
191
                 */
 
192
                GnomeTriggerActionFunction function;
 
193
                gchar *command;
 
194
                struct {
 
195
                        gchar *file;
 
196
                        int cache_id;
 
197
                } media;
 
198
        } u;
 
199
        gchar *level;
 
200
} GnomeTrigger;
 
201
</pre>
 
202
<p>
 
203
This structure stores the information about an action that is triggered for
 
204
a particular event. A filled in instance of this structure is passed to
 
205
<a class="link" href="libgnome-gnome-triggers.html#gnome-triggers-add-trigger" title="gnome_triggers_add_trigger ()"><code class="function">gnome_triggers_add_trigger()</code></a> and <a class="link" href="libgnome-gnome-triggers.html#gnome-triggers-vadd-trigger" title="gnome_triggers_vadd_trigger ()"><code class="function">gnome_triggers_vadd_trigger()</code></a>.
 
206
</p>
 
207
</div>
 
208
<hr>
 
209
<div class="refsect2" lang="en">
 
210
<a name="gnome-triggers-add-trigger"></a><h3>gnome_triggers_add_trigger ()</h3>
 
211
<pre class="programlisting">void                gnome_triggers_add_trigger          (<a class="link" href="libgnome-gnome-triggers.html#GnomeTrigger" title="GnomeTrigger">GnomeTrigger</a> *nt,
 
212
                                                         ...);</pre>
 
213
<p>
 
214
Adds a new <a class="link" href="libgnome-gnome-triggers.html#GnomeTrigger" title="GnomeTrigger"><span class="type">GnomeTrigger</span></a> instance to the event hierarchy.</p>
 
215
<p>
 
216
</p>
 
217
<div class="variablelist"><table border="0">
 
218
<col align="left" valign="top">
 
219
<tbody>
 
220
<tr>
 
221
<td><p><span class="term"><em class="parameter"><code>nt</code></em> :</span></p></td>
 
222
<td> Information on the new trigger to be added.
 
223
</td>
 
224
</tr>
 
225
<tr>
 
226
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 
227
<td> The section to add the trigger under.
 
228
</td>
 
229
</tr>
 
230
</tbody>
 
231
</table></div>
 
232
</div>
 
233
<hr>
 
234
<div class="refsect2" lang="en">
 
235
<a name="gnome-triggers-vadd-trigger"></a><h3>gnome_triggers_vadd_trigger ()</h3>
 
236
<pre class="programlisting">void                gnome_triggers_vadd_trigger         (<a class="link" href="libgnome-gnome-triggers.html#GnomeTrigger" title="GnomeTrigger">GnomeTrigger</a> *nt,
 
237
                                                         char *supinfo[]);</pre>
 
238
<p>
 
239
This does the same as <a class="link" href="libgnome-gnome-triggers.html#gnome-triggers-add-trigger" title="gnome_triggers_add_trigger ()"><code class="function">gnome_triggers_add_trigger()</code></a>, except the section is
 
240
stored in the <a
 
241
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
242
><code class="literal">NULL</code></a> terminated array <em class="parameter"><code>supinfo</code></em> instead of as a variable
 
243
length argument list.</p>
 
244
<p>
 
245
</p>
 
246
<div class="variablelist"><table border="0">
 
247
<col align="left" valign="top">
 
248
<tbody>
 
249
<tr>
 
250
<td><p><span class="term"><em class="parameter"><code>nt</code></em> :</span></p></td>
 
251
<td> Information on the new trigger to be added.
 
252
</td>
 
253
</tr>
 
254
<tr>
 
255
<td><p><span class="term"><em class="parameter"><code>supinfo</code></em> :</span></p></td>
 
256
<td> The section to add the trigger under.
 
257
</td>
 
258
</tr>
 
259
</tbody>
 
260
</table></div>
 
261
</div>
 
262
<hr>
 
263
<div class="refsect2" lang="en">
 
264
<a name="gnome-triggers-do"></a><h3>gnome_triggers_do ()</h3>
 
265
<pre class="programlisting">void                gnome_triggers_do                   (const char *msg,
 
266
                                                         const char *level,
 
267
                                                         ...);</pre>
 
268
<p>
 
269
Notifies GNOME about an event happening, so that any appropriate handlers
 
270
can be run.</p>
 
271
<p>
 
272
</p>
 
273
<div class="variablelist"><table border="0">
 
274
<col align="left" valign="top">
 
275
<tbody>
 
276
<tr>
 
277
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
 
278
<td> The human-readable message describing the event (can be <a
 
279
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
280
><code class="literal">NULL</code></a>).
 
281
</td>
 
282
</tr>
 
283
<tr>
 
284
<td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
 
285
<td> The level of severity of the event, or <a
 
286
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
287
><code class="literal">NULL</code></a>.
 
288
</td>
 
289
</tr>
 
290
<tr>
 
291
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 
292
<td> The classification of the event.
 
293
</td>
 
294
</tr>
 
295
</tbody>
 
296
</table></div>
 
297
</div>
 
298
<hr>
 
299
<div class="refsect2" lang="en">
 
300
<a name="gnome-triggers-vdo"></a><h3>gnome_triggers_vdo ()</h3>
 
301
<pre class="programlisting">void                gnome_triggers_vdo                  (const char *msg,
 
302
                                                         const char *level,
 
303
                                                         const char *supinfo[]);</pre>
 
304
<p>
 
305
Notifies GNOME about an event happening, so that any appropriate handlers
 
306
can be run. This does the same as <code class="function">gnome_trigger_do()</code> except that it takes a
 
307
<a
 
308
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
309
><code class="literal">NULL</code></a> terminated array instead of a varargs list.</p>
 
310
<p>
 
311
</p>
 
312
<div class="variablelist"><table border="0">
 
313
<col align="left" valign="top">
 
314
<tbody>
 
315
<tr>
 
316
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
 
317
<td> The human-readable message describing the event (can be <a
 
318
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
319
><code class="literal">NULL</code></a>).
 
320
</td>
 
321
</tr>
 
322
<tr>
 
323
<td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
 
324
<td> The level of severity of the event, or <a
 
325
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
326
><code class="literal">NULL</code></a>.
 
327
</td>
 
328
</tr>
 
329
<tr>
 
330
<td><p><span class="term"><em class="parameter"><code>supinfo</code></em> :</span></p></td>
 
331
<td> The classification of the event (<a
 
332
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
333
><code class="literal">NULL</code></a> terminated array).
167
334
</td>
168
335
</tr>
169
336
</tbody>
173
340
</div>
174
341
<div class="footer">
175
342
<hr>
176
 
          Generated by GTK-Doc V1.10</div>
 
343
          Generated by GTK-Doc V1.11</div>
177
344
</body>
178
345
</html>