make struct _GPatternSpec and GMatchType private. (g_pattern_equal): new
[platform/upstream/glib.git] / docs / reference / glib / tmpl / glib-unused.sgml
1 <!-- ##### ENUM GChannelError ##### -->
2 <para>
3
4 </para>
5
6 @G_CHANNEL_ERROR_ACCES: 
7 @G_CHANNEL_ERROR_BADF: 
8 @G_CHANNEL_ERROR_DEADLK: 
9 @G_CHANNEL_ERROR_FAULT: 
10 @G_CHANNEL_ERROR_INVAL: 
11 @G_CHANNEL_ERROR_IO: 
12 @G_CHANNEL_ERROR_ISDIR: 
13 @G_CHANNEL_ERROR_MFILE: 
14 @G_CHANNEL_ERROR_NOLCK: 
15 @G_CHANNEL_ERROR_NOSPC: 
16 @G_CHANNEL_ERROR_PERM: 
17 @G_CHANNEL_ERROR_PIPE: 
18 @G_CHANNEL_ERROR_SPIPE: 
19 @G_CHANNEL_ERROR_ENCODE_RW: 
20 @G_CHANNEL_ERROR_FAILED: 
21
22 <!-- ##### ENUM GChannelStatus ##### -->
23 <para>
24
25 </para>
26
27 @G_CHANNEL_STATUS_NORMAL: 
28 @G_CHANNEL_STATUS_EOF: 
29 @G_CHANNEL_STATUS_PARTIAL_CHARS: 
30 @G_CHANNEL_STATUS_AGAIN: 
31 @G_CHANNEL_STATUS_INTR: 
32 @G_CHANNEL_STATUS_ERROR: 
33 @G_CHANNEL_STATUS_BAD_INPUT: 
34
35 <!-- ##### USER_FUNCTION GCompareFuncData ##### -->
36 <para>
37
38 </para>
39
40 @a: 
41 @b: 
42 @user_data: 
43 @Returns: 
44
45 <!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
46 <para>
47
48 </para>
49
50 @s1: 
51 @s2: 
52 @Returns: 
53
54 <!-- ##### USER_FUNCTION GErrorFunc ##### -->
55 <para>
56 Specifies the type of function passed to g_set_error_handler().
57 </para>
58
59 @str: the error message.
60
61 <!-- ##### USER_FUNCTION GHookFreeFunc ##### -->
62 <para>
63
64 </para>
65
66 @hook_list: 
67 @hook: 
68
69 <!-- ##### ENUM GIOFileMode ##### -->
70 <para>
71
72 </para>
73
74 @G_IO_FILE_MODE_READ: 
75 @G_IO_FILE_MODE_WRITE: 
76 @G_IO_FILE_MODE_APPEND: 
77 @G_IO_FILE_MODE_READ_WRITE: 
78 @G_IO_FILE_MODE_READ_WRITE_TRUNCATE: 
79 @G_IO_FILE_MODE_READ_WRITE_APPEND: 
80
81 <!-- ##### ENUM GMatchType ##### -->
82 <para>
83 Enumeration representing different kinds of patterns. This is only used
84 internally for optimizing the match algorithm.
85 </para>
86
87 @G_MATCH_ALL: a general pattern.
88 @G_MATCH_ALL_TAIL: a general pattern which contains a fixed part matching
89 the end of the string.
90 @G_MATCH_HEAD: a pattern matching every string with a certain prefix.
91 @G_MATCH_TAIL: a pattern matching every string with a certain suffix.
92 @G_MATCH_EXACT: a pattern matching exactly one string.
93 @G_MATCH_LAST: 
94
95 <!-- ##### USER_FUNCTION GWarningFunc ##### -->
96 <para>
97 Specifies the type of function passed to g_set_warning_handler().
98 </para>
99
100 @str: the warning message.
101
102 <!-- ##### MACRO G_CHANNEL_ERROR ##### -->
103 <para>
104
105 </para>
106
107
108 <!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### -->
109 <para>
110
111 </para>
112
113
114 <!-- ##### MACRO G_IO_CHANNEL_DEFAULT_LINE_TERM ##### -->
115 <para>
116 One of %G_IO_CHANNEL_UNIX_LINE_TERM, %G_IO_CHANNEL_DOS_LINE_TERM,
117 or %G_IO_CHANNEL_MACINTOSH_LINE_TERM (unimplemented)
118 depending on the system type.
119 </para>
120
121
122 <!-- ##### MACRO G_IO_CHANNEL_DOS_LINE_TERM ##### -->
123 <para>
124
125 </para>
126
127
128 <!-- ##### MACRO G_IO_CHANNEL_ENCODE_RAW ##### -->
129 <para>
130 Encoding for nonbuffered IO. With this encoding, data must be
131 read using g_io_channel_read_chars(); the other functions will
132 not work.
133 </para>
134
135
136 <!-- ##### MACRO G_IO_CHANNEL_MACINTOSH_LINE_TERM ##### -->
137 <para>
138
139 </para>
140
141
142 <!-- ##### MACRO G_IO_CHANNEL_UNIX_LINE_TERM ##### -->
143 <para>
144
145 </para>
146
147
148 <!-- ##### MACRO NAME_MAX ##### -->
149 <para>
150 Provided for UNIX emulation on Windows; equivalent to UNIX macro 
151 %NAME_MAX, which is the maximum length of a single path component.
152 i.e. just the <filename>foo</filename> in <filename>/usr/bin/foo</filename>.
153 </para>
154
155
156 <!-- ##### MACRO access ##### -->
157 <para>
158
159 </para>
160
161
162 <!-- ##### MACRO close ##### -->
163 <para>
164
165 </para>
166
167
168 <!-- ##### MACRO fdopen ##### -->
169 <para>
170
171 </para>
172
173
174 <!-- ##### FUNCTION g_channel_error_from_errno ##### -->
175 <para>
176
177 </para>
178
179 @en: 
180 @Returns: 
181
182 <!-- ##### FUNCTION g_channel_error_quark ##### -->
183 <para>
184
185 </para>
186
187 @Returns: 
188
189 <!-- ##### FUNCTION g_convert_error_quark ##### -->
190 <para>
191
192 </para>
193
194 @Returns: 
195
196 <!-- ##### FUNCTION g_io_channel_error_quark ##### -->
197 <para>
198
199 </para>
200
201 @Returns: 
202
203 <!-- ##### FUNCTION g_main_add_poll ##### -->
204 <para>
205 Adds a file descriptor to be polled.
206 This is usually combined with g_source_add() to add an event source.
207 The event source's check function will typically test the revents
208 field in the #GPollFD struct and return TRUE if events need to be processed.
209 </para>
210
211 @fd: a #GPollFD, which is a file descriptor together with a bitwise
212 combination of #GIOCondition flags determining which events to poll for.
213 @priority: the priority of the poll, which should be the same as the priority
214 used for g_source_add() to ensure that the file descriptor is polled whenever
215 the results may be needed.
216 See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
217 #G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
218
219 <!-- ##### FUNCTION g_main_context_get ##### -->
220 <para>
221
222 </para>
223
224 @thread: 
225 @Returns: 
226
227 <!-- ##### FUNCTION g_main_loop_destroy ##### -->
228 <para>
229
230 </para>
231
232 @loop: 
233
234 <!-- ##### FUNCTION g_main_remove_poll ##### -->
235 <para>
236 Removes a file descriptor from the list being polled.
237 </para>
238
239 @fd: the #GPollFD to remove.
240
241 <!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
242 <para>
243
244 </para>
245
246 @Returns: 
247
248 <!-- ##### FUNCTION g_mem_check ##### -->
249 <para>
250 Checks if the given memory has already been freed. If it has it outputs
251 a warning message.
252 To use this function you must configure glib with the flag
253 '--enable-mem-check=yes' before compiling.
254 </para>
255
256 @mem: the memory to check.
257
258 <!-- ##### FUNCTION g_scanner_stat_mode ##### -->
259 <para>
260 Gets the file attributes.
261 This is the <structfield>st_mode</structfield> field from the
262 <structname>stat</structname> structure. See the <function>stat()</function>
263 documentation.
264 </para>
265
266 @filename: the file name.
267 @Returns: the file attributes.
268
269 <!-- ##### FUNCTION g_set_error_handler ##### -->
270 <para>
271 Sets the function to be called to handle error messages.
272 This function is deprecated in favour of the new logging facilities.
273 </para>
274
275 @func: the function to be called to handle error messages.
276 @Returns: the old error handler.
277
278 <!-- ##### FUNCTION g_set_message_handler ##### -->
279 <para>
280 Sets the function to be called to handle messages.
281 This function is deprecated in favour of the new logging facilities.
282 </para>
283
284 @func: the function to be called to handle normal messages.
285 @Returns: the old message handler.
286
287 <!-- ##### FUNCTION g_set_warning_handler ##### -->
288 <para>
289 Sets the function to be called to handle warning messages.
290 This function is deprecated in favour of the new logging facilities.
291 </para>
292
293 @func: the function to be called to handle warning messages.
294 @Returns: the old warning handler.
295
296 <!-- ##### FUNCTION g_source_add ##### -->
297 <para>
298 </para>
299
300 @priority: 
301 @can_recurse: 
302 @funcs: 
303 @source_data: 
304 @user_data: 
305 @notify: 
306 @Returns: 
307 @source: 
308 @context: 
309
310 <!-- ##### FUNCTION g_source_connect ##### -->
311 <para>
312
313 </para>
314
315 @source: 
316 @func: 
317 @data: 
318 @notify: 
319
320 <!-- ##### FUNCTION g_source_connect_indirect ##### -->
321 <para>
322
323 </para>
324
325 @source: 
326 @callback_data: 
327 @callback_funcs: 
328
329 <!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
330 <para>
331 Removes the first event source found with the given source data.
332 </para>
333 <para>
334 Event sources are sorted with the highest priority first. Sources with equal
335 priority are stored in the order in which they were added.
336 </para>
337
338 @source_data: the source data, which contains information specific to the
339 type of source.
340 @Returns: TRUE if an event source was found and removed.
341
342 <!-- ##### FUNCTION g_static_private_get_for_thread ##### -->
343 <para>
344
345 </para>
346
347 @private_key: 
348 @thread: 
349 @Returns: 
350
351 <!-- ##### FUNCTION g_static_private_set_for_thread ##### -->
352 <para>
353
354 </para>
355
356 @private_key: 
357 @thread: 
358 @data: 
359 @notify: 
360
361 <!-- ##### MACRO g_string ##### -->
362 <para>
363 Turns the argument into a string literal by using the '#' stringizing operator.
364 </para>
365
366 @x: text to convert to a literal string.
367
368 <!-- ##### MACRO getcwd ##### -->
369 <para>
370
371 </para>
372
373
374 <!-- ##### MACRO getpid ##### -->
375 <para>
376
377 </para>
378
379
380 <!-- ##### MACRO lseek ##### -->
381 <para>
382
383 </para>
384
385
386 <!-- ##### MACRO open ##### -->
387 <para>
388
389 </para>
390
391
392 <!-- ##### MACRO pclose ##### -->
393 <para>
394
395 </para>
396
397
398 <!-- ##### MACRO popen ##### -->
399 <para>
400
401 </para>
402
403
404 <!-- ##### MACRO read ##### -->
405 <para>
406
407 </para>
408
409
410 <!-- ##### MACRO readdir ##### -->
411 <para>
412 Provided for UNIX emulation on Windows; see documentation for <function>readdir()</function>
413 in any UNIX manual.
414 </para>
415
416
417 <!-- ##### MACRO write ##### -->
418 <para>
419
420 </para>
421
422