← Back to branch summary

~ubuntu-branches/ubuntu/precise/vte/precise

« back to all changes in this revision

Viewing changes to doc/reference/html/VteReaper.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Vogt
  • Date: 2011-06-16 17:59:49 UTC
  • mfrom: (1.1.65 upstream) (3.1.14 sid)
  • Revision ID: james.westby@ubuntu.com-20110616175949-dexr6gu2dxiifi00
Tags: 1:0.28.1-1ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Add 93_add_alt_screen_scroll_toggle.patch: Handle scrolling differently
    when using alternate screen or scrolling is restricted.
  - Add lp246701_scroll_region_updates.patch: Bug fix. (LP #246701)
  - 91_keep_fds.patch:
    vte-2.90 does not yet support G_SPAWN_LEAVE_DESCRIPTORS_OPEN
    when calling vte_terminal_fork_command_full() until that is
    fixed we need to keep this patch

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/VteReaper.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>VteReaper</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
 
<link rel="home" href="index.html" title="VTE Reference Manual">
8
 
<link rel="up" href="deprecated-objects.html" title="Deprecated">
9
 
<link rel="prev" href="deprecated-objects.html" title="Deprecated">
10
 
<link rel="next" href="object-hierarchy.html" title="Object Hierarchy">
11
 
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="deprecated-objects.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="deprecated-objects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">VTE Reference Manual</th>
21
 
<td><a accesskey="n" href="object-hierarchy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#VteReaper.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#VteReaper.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#VteReaper.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#VteReaper.signals" class="shortcut">Signals</a>
31
 
</td></tr>
32
 
</table>
33
 
<div class="refentry">
34
 
<a name="VteReaper"></a><div class="titlepage"></div>
35
 
<div class="refnamediv"><table width="100%"><tr>
36
 
<td valign="top">
37
 
<h2><span class="refentrytitle"><a name="VteReaper.top_of_page"></a>VteReaper</span></h2>
38
 
<p>VteReaper — A singleton object which catches <code class="literal">SIGCHLD</code> signals and
39
 
converts them into GObject-style "child-exited" signals</p>
40
 
</td>
41
 
<td valign="top" align="right"></td>
42
 
</tr></table></div>
43
 
<div class="refsynopsisdiv">
44
 
<a name="VteReaper.synopsis"></a><h2>Synopsis</h2>
45
 
<pre class="synopsis">                    <a class="link" href="VteReaper.html#VteReaper-struct" title="VteReaper">VteReaper</a>;
46
 
<span class="returnvalue">int</span>                 <a class="link" href="VteReaper.html#vte-reaper-add-child" title="vte_reaper_add_child ()">vte_reaper_add_child</a>                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GPid"><span class="type">GPid</span></a> pid</code></em>);
47
 
<a class="link" href="VteReaper.html" title="VteReaper"><span class="returnvalue">VteReaper</span></a> *         <a class="link" href="VteReaper.html#vte-reaper-get" title="vte_reaper_get ()">vte_reaper_get</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
48
 
</pre>
49
 
</div>
50
 
<div class="refsect1">
51
 
<a name="VteReaper.object-hierarchy"></a><h2>Object Hierarchy</h2>
52
 
<pre class="synopsis">
53
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
54
 
   +----VteReaper
55
 
</pre>
56
 
</div>
57
 
<div class="refsect1">
58
 
<a name="VteReaper.signals"></a><h2>Signals</h2>
59
 
<pre class="synopsis">
60
 
  "<a class="link" href="VteReaper.html#VteReaper-child-exited" title='The "child-exited" signal'>child-exited</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
61
 
</pre>
62
 
</div>
63
 
<div class="refsect1">
64
 
<a name="VteReaper.description"></a><h2>Description</h2>
65
 
<p>
66
 
Because an application may need to be notified when child processes
67
 
exit, and because there is only one <code class="literal">SIGCHLD</code> handler, the <a class="link" href="VteTerminal.html" title="VteTerminal"><span class="type">VteTerminal</span></a>
68
 
widget relies on a <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> to watch for <code class="literal">SIGCHLD</code> notifications and
69
 
retrieve the exit status of child processes which have exited.  When
70
 
glib provides child_watch functionality, the <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> merely acts as
71
 
a proxy for glib's own functionality.
72
 
</p>
73
 
<p>
74
 
Since 0.11.11
75
 
</p>
76
 
</div>
77
 
<div class="refsect1">
78
 
<a name="VteReaper.details"></a><h2>Details</h2>
79
 
<div class="refsect2">
80
 
<a name="VteReaper-struct"></a><h3>VteReaper</h3>
81
 
<pre class="programlisting">typedef struct _VteReaper VteReaper;</pre>
82
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
83
 
<h3 class="title">Warning</h3>
84
 
<p><code class="literal">VteReaper</code> is deprecated and should not be used in newly-written code.</p>
85
 
</div>
86
 
<p>
87
 
The reaper object.
88
 
</p>
89
 
</div>
90
 
<hr>
91
 
<div class="refsect2">
92
 
<a name="vte-reaper-add-child"></a><h3>vte_reaper_add_child ()</h3>
93
 
<pre class="programlisting"><span class="returnvalue">int</span>                 vte_reaper_add_child                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GPid"><span class="type">GPid</span></a> pid</code></em>);</pre>
94
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
95
 
<h3 class="title">Warning</h3>
96
 
<p><code class="literal">vte_reaper_add_child</code> is deprecated and should not be used in newly-written code.</p>
97
 
</div>
98
 
<p>
99
 
Ensures that child-exited signals will be emitted when <em class="parameter"><code>pid</code></em> exits.  This is
100
 
necessary for correct operation when running with glib versions &gt;= 2.4.
101
 
</p>
102
 
<div class="variablelist"><table border="0">
103
 
<col align="left" valign="top">
104
 
<tbody>
105
 
<tr>
106
 
<td><p><span class="term"><em class="parameter"><code>pid</code></em> :</span></p></td>
107
 
<td>the ID of a child process which will be monitored
108
 
</td>
109
 
</tr>
110
 
<tr>
111
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
112
 
<td> the new source ID
113
 
 
114
 
Since 0.11.11
115
 
</td>
116
 
</tr>
117
 
</tbody>
118
 
</table></div>
119
 
</div>
120
 
<hr>
121
 
<div class="refsect2">
122
 
<a name="vte-reaper-get"></a><h3>vte_reaper_get ()</h3>
123
 
<pre class="programlisting"><a class="link" href="VteReaper.html" title="VteReaper"><span class="returnvalue">VteReaper</span></a> *         vte_reaper_get                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
124
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
125
 
<h3 class="title">Warning</h3>
126
 
<p><code class="literal">vte_reaper_get</code> is deprecated and should not be used in newly-written code.</p>
127
 
</div>
128
 
<p>
129
 
Finds the address of the global <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> object, creating the object if
130
 
necessary.
131
 
</p>
132
 
<div class="variablelist"><table border="0">
133
 
<col align="left" valign="top">
134
 
<tbody><tr>
135
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
136
 
<td> the global <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> object, which should not be unreffed.
137
 
</td>
138
 
</tr></tbody>
139
 
</table></div>
140
 
</div>
141
 
</div>
142
 
<div class="refsect1">
143
 
<a name="VteReaper.signal-details"></a><h2>Signal Details</h2>
144
 
<div class="refsect2">
145
 
<a name="VteReaper-child-exited"></a><h3>The <code class="literal">"child-exited"</code> signal</h3>
146
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> *vtereaper,
147
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>       arg1,
148
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>       arg2,
149
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
150
 
<p>
151
 
Emitted when the <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> object detects that a child of the
152
 
current process has exited.
153
 
</p>
154
 
<div class="variablelist"><table border="0">
155
 
<col align="left" valign="top">
156
 
<tbody>
157
 
<tr>
158
 
<td><p><span class="term"><em class="parameter"><code>vtereaper</code></em> :</span></p></td>
159
 
<td>the object which received the signal
160
 
</td>
161
 
</tr>
162
 
<tr>
163
 
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
164
 
<td>the process ID of the exited child
165
 
</td>
166
 
</tr>
167
 
<tr>
168
 
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
169
 
<td>the status of the exited child, as returned by <code class="function">waitpid()</code>
170
 
</td>
171
 
</tr>
172
 
<tr>
173
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
174
 
<td>user data set when the signal handler was connected.</td>
175
 
</tr>
176
 
</tbody>
177
 
</table></div>
178
 
<p class="since">Since 0.11.11</p>
179
 
</div>
180
 
</div>
181
 
</div>
182
 
<div class="footer">
183
 
<hr>
184
 
          Generated by GTK-Doc V1.15.1</div>
185
 
</body>
186
 
</html>
 
 
b'\\ No newline at end of file'