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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="glib-constants">
<refnamediv>
<refname>glib Constants</refname>
<refpurpose>the built-in constants of the glib module</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<programlisting>
<xref linkend="glib-io-condition-constants" endterm="glib-io-condition-constants-title"></xref>
<xref linkend="glib-priority-constants" endterm="glib-priority-constants-title"></xref>
<xref linkend="glib-spawn-flag-constants" endterm="glib-spawn-flag-constants-title"></xref>
<xref linkend="glib-user-directory-constants" endterm="glib-user-directory-constants-title"></xref>
<xref linkend="glib-version-constants" endterm="glib-version-constants-title"></xref>
</programlisting>
</refsect1>
<refsect1 id="glib-constants-description">
<title>Description</title>
<refsect2 id="glib-io-condition-constants">
<title id="glib-io-condition-constants-title">Glib IO Condition Constants</title>
<para>The IO Condition constants are a set of bit-flags that specify a
condition to watch for on an event source.</para>
<variablelist>
<varlistentry>
<term><literal>glib.IO_IN</literal></term>
<listitem>
<simpara>There is data to read</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.IO_OUT</literal></term>
<listitem>
<simpara>Data can be written (without blocking).</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.IO_PRI</literal></term>
<listitem>
<simpara>There is urgent data to read.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.IO_ERR</literal></term>
<listitem>
<simpara>Error condition.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.IO_HUP</literal></term>
<listitem>
<simpara>Hung up (the connection has been broken, usually for
pipes and sockets).</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.IO_NVAL</literal></term>
<listitem>
<simpara>Invalid request. The file descriptor is not
open.</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="glib-priority-constants">
<title id="glib-priority-constants-title">Glib Priority Constants</title>
<para>The Priority constants specify </para>
<variablelist>
<varlistentry>
<term><literal>glib.PRIORITY_HIGH</literal></term>
<listitem>
<simpara>Use this for high priority event sources.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.PRIORITY_DEFAULT</literal></term>
<listitem>
<simpara>Use this for default priority event sources. This
priority is used when adding timeout functions with the <link
linkend="function-glib--timeout-add"><function>glib.timeout_add</function>()</link>
function. This priority is also used for events from the X
server.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.PRIORITY_HIGH_IDLE</literal></term>
<listitem>
<simpara>Use this for high priority idle functions. For example,
glib.PRIORITY_HIGH_IDLE + 10 is used for resizing operations;
and, glib.PRIORITY_HIGH_IDLE + 20, for redrawing
operations. (This is done to ensure that any pending resizes are
processed before any pending redraws, so that widgets are not
redrawn twice unnecessarily.)</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.PRIORITY_DEFAULT_IDLE</literal></term>
<listitem>
<simpara>Use this for default priority idle functions. This
priority is used when adding idle functions with the <link
linkend="function-glib--idle-add"><function>glib.idle_add</function>()</link>
function.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.PRIORITY_LOW</literal></term>
<listitem>
<simpara>Use this for very low priority background
tasks.</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="glib-spawn-flag-constants">
<title id="glib-spawn-flag-constants-title">Glib Spawn Flag Constants</title>
<para>The Spawn Flag constants are a set of bit-flags that can be
passed to the <link
linkend="function-glib--spawn-async"><function>glib.spawn_async</function>()</link>
function.</para>
<variablelist>
<varlistentry>
<term><literal>glib.SPAWN_LEAVE_DESCRIPTORS_OPEN</literal></term>
<listitem>
<simpara>the parent's open file descriptors will be inherited by
the child; otherwise all descriptors except stdin/stdout/stderr will be
closed before calling <function>exec</function>() in the child.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.SPAWN_DO_NOT_REAP_CHILD</literal></term>
<listitem>
<simpara>the child will not be automatically reaped; you must
call <function>waitpid</function>() or handle <literal>SIGCHLD</literal>
yourself, or the child will become a zombie.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.SPAWN_SEARCH_PATH</literal></term>
<listitem>
<simpara><parameter>argv</parameter>[0] need not be an absolute
path, it will be looked for in the user's <envar>PATH</envar>.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.SPAWN_STDOUT_TO_DEV_NULL</literal></term>
<listitem>
<simpara>the child's standard output will be discarded, instead
of going to the same location as the parent's standard output.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.SPAWN_STDERR_TO_DEV_NULL</literal></term>
<listitem>
<simpara>the child's standard error will be discarded.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.SPAWN_CHILD_INHERITS_STDIN</literal></term>
<listitem>
<simpara>the child will inherit the parent's standard input (by
default, the child's standard input is attached to /dev/null).</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.SPAWN_FILE_AND_ARGV_ZERO</literal></term>
<listitem>
<simpara>the first element of <parameter>argv</parameter> is the
file to execute, while the remaining elements are the actual argument vector
to pass to the file. Normally <link
linkend="function-glib--spawn-async"><function>glib.spawn_async</function>()</link>
uses <parameter>argv</parameter>[0] as the file to execute, and passes all
of <parameter>argv</parameter> to the child.</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="glib-user-directory-constants">
<title id="glib-user-directory-constants-title">Glib User Directory Constants</title>
<para>The User Directory constants are integer values that are currently used only as arguments to
<link linkend="function-glib--get-user-special-dir"><function>glib.get_user_special_dir</function>()</link>
function. See function documentation for details.</para>
<variablelist>
<varlistentry>
<term><literal>glib.USER_DIRECTORY_DESKTOP</literal></term>
<listitem>
<simpara>the user's Desktop directory</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.USER_DIRECTORY_DOCUMENTS</literal></term>
<listitem>
<simpara>the user's Documents directory</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.USER_DIRECTORY_DOWNLOAD</literal></term>
<listitem>
<simpara>the user's Downloads directory</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.USER_DIRECTORY_MUSIC</literal></term>
<listitem>
<simpara>the user's Music directory</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.USER_DIRECTORY_PICTURES</literal></term>
<listitem>
<simpara>the user's Pictures directory</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.USER_DIRECTORY_PUBLIC_SHARE</literal></term>
<listitem>
<simpara>the user's shared directory</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.USER_DIRECTORY_TEMPLATES</literal></term>
<listitem>
<simpara>the user's Templates directory</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.USER_DIRECTORY_VIDEOS</literal></term>
<listitem>
<simpara>the user's Movies directory</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="glib-version-constants">
<title id="glib-version-constants-title">Glib Version Constants</title>
<para>The Version constants specify the version of
<literal>Glib</literal> used by PyGObject as a 3-tuple containing the major,
minor and patch release numbers.</para>
<variablelist>
<varlistentry>
<term><literal>glib.glib_version</literal></term>
<listitem>
<simpara>A 3-tuple containing (major, minor, patch) release
numbers of glib.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>glib.pyglib_version</literal></term>
<listitem>
<simpara>A 3-tuple containing (major, minor, patch) release
numbers of the python bindings.</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</refentry>
|
