libxfcegui4-dev 4.8.1-5 / usr / share / gtk-doc / html / libxfcegui4 / libxfcegui4-Xfce-Gdk-extensions.html

This file is indexed.

/usr/share/gtk-doc/html/libxfcegui4/libxfcegui4-Xfce-Gdk-extensions.html is in libxfcegui4-dev 4.8.1-5.

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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Xfce Gdk extensions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libxfcegui4 Reference Manual">
<link rel="up" href="libxfcegui4-fundamentals.html" title="Xfce GUI Fundamentals">
<link rel="prev" href="libxfcegui4-xfce-exec.html" title="xfce-exec">
<link rel="next" href="libxfcegui4-Xfce-Gtk+-extensions.html" title="Xfce Gtk+ extensions">
<meta name="generator" content="GTK-Doc V1.15 (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="libxfcegui4-xfce-exec.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libxfcegui4-fundamentals.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></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">libxfcegui4 Reference Manual</th>
<td><a accesskey="n" href="libxfcegui4-Xfce-Gtk+-extensions.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libxfcegui4-Xfce-Gdk-extensions.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libxfcegui4-Xfce-Gdk-extensions.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Xfce Gdk extensions">
<a name="libxfcegui4-Xfce-Gdk-extensions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxfcegui4-Xfce-Gdk-extensions.top_of_page"></a>Xfce Gdk extensions</span></h2>
<p>Xfce Gdk extensions — Additional Gdk related functions.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libxfcegui4-Xfce-Gdk-extensions.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libxfcegui4/libxfcegui4.h&gt;

<span class="returnvalue">gchar</span>*              <a class="link" href="libxfcegui4-Xfce-Gdk-extensions.html#xfce-gdk-display-get-fullname" title="xfce_gdk_display_get_fullname ()">xfce_gdk_display_get_fullname</a>       (<em class="parameter"><code><span class="type">GdkDisplay</span> *display</code></em>);
<span class="returnvalue">GdkScreen</span>*          <a class="link" href="libxfcegui4-Xfce-Gdk-extensions.html#xfce-gdk-display-locate-monitor-with-pointer" title="xfce_gdk_display_locate_monitor_with_pointer ()">xfce_gdk_display_locate_monitor_with_pointer</a>
                                                        (<em class="parameter"><code><span class="type">GdkDisplay</span> *display</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *monitor_return</code></em>);
<span class="returnvalue">gchar</span> *             <a class="link" href="libxfcegui4-Xfce-Gdk-extensions.html#xfce-gdk-screen-get-fullname" title="xfce_gdk_screen_get_fullname ()">xfce_gdk_screen_get_fullname</a>        (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libxfcegui4-Xfce-Gdk-extensions.html#xfce-gdk-spawn-on-screen" title="xfce_gdk_spawn_on_screen ()">xfce_gdk_spawn_on_screen</a>            (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **argv</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GSpawnFlags</span> flags</code></em>,
                                                         <em class="parameter"><code><span class="type">GSpawnChildSetupFunc</span> child_setup</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *child_pid</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libxfcegui4-Xfce-Gdk-extensions.html#xfce-gdk-spawn-on-screen-with-pipes" title="xfce_gdk_spawn_on_screen_with_pipes ()">xfce_gdk_spawn_on_screen_with_pipes</a> (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **argv</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GSpawnFlags</span> flags</code></em>,
                                                         <em class="parameter"><code><span class="type">GSpawnChildSetupFunc</span> child_setup</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *child_pid</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *standard_input</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *standard_output</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *standard_error</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libxfcegui4-Xfce-Gdk-extensions.html#xfce-gdk-spawn-command-line-on-screen" title="xfce_gdk_spawn_command_line_on_screen ()">xfce_gdk_spawn_command_line_on_screen</a>
                                                        (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *command_line</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libxfcegui4-Xfce-Gdk-extensions.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="libxfcegui4-Xfce-Gdk-extensions.details"></a><h2>Details</h2>
<div class="refsect2" title="xfce_gdk_display_get_fullname ()">
<a name="xfce-gdk-display-get-fullname"></a><h3>xfce_gdk_display_get_fullname ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span>*              xfce_gdk_display_get_fullname       (<em class="parameter"><code><span class="type">GdkDisplay</span> *display</code></em>);</pre>
<p>
Determines the full qualified name of <em class="parameter"><code>display</code></em>. The full name includes
both the hostname of the Xserver node and the display number
of the Xserver.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
<td>A valid Gdk display.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The full qualified name of <em class="parameter"><code>display</code></em>.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2" title="xfce_gdk_display_locate_monitor_with_pointer ()">
<a name="xfce-gdk-display-locate-monitor-with-pointer"></a><h3>xfce_gdk_display_locate_monitor_with_pointer ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkScreen</span>*          xfce_gdk_display_locate_monitor_with_pointer
                                                        (<em class="parameter"><code><span class="type">GdkDisplay</span> *display</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *monitor_return</code></em>);</pre>
<p>
Locates the monitor and the screen which contains the pointer. If
it is not possible to determine the current pointer position, <code class="literal">NULL</code>
is returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
<td>A Gdk display or <code class="literal">NULL</code> to choose the default display.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>monitor_return</code></em> :</span></p></td>
<td>Address to store the monitor number to or <code class="literal">NULL</code>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The screen that contains the pointer.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2" title="xfce_gdk_screen_get_fullname ()">
<a name="xfce-gdk-screen-get-fullname"></a><h3>xfce_gdk_screen_get_fullname ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *             xfce_gdk_screen_get_fullname        (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>);</pre>
<p>
Like <a class="link" href="libxfcegui4-Xfce-Gdk-extensions.html#xfce-gdk-display-get-fullname" title="xfce_gdk_display_get_fullname ()"><code class="function">xfce_gdk_display_get_fullname()</code></a>, but also includes the screen
number.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
<td>A Gdk screen.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The full qualified name of <em class="parameter"><code>screen</code></em>.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2" title="xfce_gdk_spawn_on_screen ()">
<a name="xfce-gdk-spawn-on-screen"></a><h3>xfce_gdk_spawn_on_screen ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            xfce_gdk_spawn_on_screen            (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **argv</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GSpawnFlags</span> flags</code></em>,
                                                         <em class="parameter"><code><span class="type">GSpawnChildSetupFunc</span> child_setup</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *child_pid</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Like <code class="function">g_spawn_async()</code>, except the child process is spawned in such
an environment that on calling <code class="function">gdk_display_open()</code> it would be
returned a <span class="type">GdkDisplay</span> with <em class="parameter"><code>screen</code></em> as the default screen.
</p>
<p>
This is useful for applications which wish to launch an application
on a specific screen.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
<td>a <span class="type">GdkScreen</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>working_directory</code></em> :</span></p></td>
<td>child's current working directory, or <code class="literal">NULL</code> to 
                     inherit parent's
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>child's argument vector
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
<td>child's environment, or <code class="literal">NULL</code> to inherit parent's
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>flags from <span class="type">GSpawnFlags</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child_setup</code></em> :</span></p></td>
<td>function to run in the child just before <code class="function">exec()</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data for <em class="parameter"><code>child_setup</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child_pid</code></em> :</span></p></td>
<td>return location for child process ID, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for error
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if error is set

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2" title="xfce_gdk_spawn_on_screen_with_pipes ()">
<a name="xfce-gdk-spawn-on-screen-with-pipes"></a><h3>xfce_gdk_spawn_on_screen_with_pipes ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            xfce_gdk_spawn_on_screen_with_pipes (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *working_directory</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **argv</code></em>,
                                                         <em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
                                                         <em class="parameter"><code><span class="type">GSpawnFlags</span> flags</code></em>,
                                                         <em class="parameter"><code><span class="type">GSpawnChildSetupFunc</span> child_setup</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *child_pid</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *standard_input</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *standard_output</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> *standard_error</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Like <code class="function">g_spawn_async_with_pipes()</code>, except the child process is
spawned in such an environment that on calling <code class="function">gdk_display_open()</code>
it would be returned a <span class="type">GdkDisplay</span> with <em class="parameter"><code>screen</code></em> as the default
screen.
</p>
<p>
This is useful for applications which wish to launch an application
on a specific screen.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
<td>a <span class="type">GdkScreen</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>working_directory</code></em> :</span></p></td>
<td>child's current working directory, or <code class="literal">NULL</code> to 
                     inherit parent's
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>child's argument vector
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
<td>child's environment, or <code class="literal">NULL</code> to inherit parent's
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>flags from <span class="type">GSpawnFlags</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child_setup</code></em> :</span></p></td>
<td>function to run in the child just before <code class="function">exec()</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data for <em class="parameter"><code>child_setup</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child_pid</code></em> :</span></p></td>
<td>return location for child process ID, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>standard_input</code></em> :</span></p></td>
<td>return location for file descriptor to write to 
                     child's stdin, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>standard_output</code></em> :</span></p></td>
<td>return location for file descriptor to read child's 
                     stdout, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>standard_error</code></em> :</span></p></td>
<td>return location for file descriptor to read child's 
                     stderr, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for error
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if an error was set

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2" title="xfce_gdk_spawn_command_line_on_screen ()">
<a name="xfce-gdk-spawn-command-line-on-screen"></a><h3>xfce_gdk_spawn_command_line_on_screen ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            xfce_gdk_spawn_command_line_on_screen
                                                        (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *command_line</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Like <code class="function">g_spawn_command_line_async()</code>, except the child process is
spawned in such an environment that on calling <code class="function">gdk_display_open()</code>
it would be returned a <span class="type">GdkDisplay</span> with <em class="parameter"><code>screen</code></em> as the default
screen.
</p>
<p>
This is useful for applications which wish to launch an application
on a specific screen.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
<td>a <span class="type">GdkScreen</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>command_line</code></em> :</span></p></td>
<td>a command line
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for errors
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if error is set.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="libxfcegui4-Xfce-Gdk-extensions.see-also"></a><h2>See Also</h2>
<p>
<a class="ulink" href="http://developer.gnome.org/doc/API/2.0/gdk/" target="_top">Gdk reference manual</a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.