added some function documentations.
[platform/upstream/glib.git] / docs / reference / gobject / gobject-sections.txt
1 <INCLUDE>gobject.h</INCLUDE>
2
3 <SECTION>
4 <TITLE>Type Information</TITLE>
5 <FILE>types</FILE>
6 GType
7 G_TYPE_FUNDAMENTAL
8 G_TYPE_FUNDAMENTAL_MAX
9 G_TYPE_DERIVE_ID
10 G_TYPE_BRANCH_SEQNO
11 G_TYPE_FUNDAMENTAL_LAST
12 G_TYPE_IS_ABSTRACT
13 G_TYPE_IS_DERIVED
14 G_TYPE_IS_FUNDAMENTAL
15 G_TYPE_IS_VALUE_TYPE
16 G_TYPE_IS_CLASSED
17 G_TYPE_IS_INSTANTIATABLE
18 G_TYPE_IS_DERIVABLE
19 G_TYPE_IS_DEEP_DERIVABLE
20 G_TYPE_IS_INTERFACE
21 GTypeFundamentals
22 GTypeInterface
23 GTypeInstance
24 GTypeInfo
25 GTypeFundamentalInfo
26 GInterfaceInfo
27 GTypeValueTable
28
29 <TITLE>GType</TITLE>
30 G_TYPE_FROM_INSTANCE
31 G_TYPE_FROM_CLASS
32 G_TYPE_FROM_INTERFACE
33 G_TYPE_INSTANCE_GET_CLASS
34 G_TYPE_INSTANCE_GET_INTERFACE
35 G_TYPE_CHECK_INSTANCE
36 G_TYPE_CHECK_INSTANCE_CAST
37 G_TYPE_CHECK_INSTANCE_TYPE
38 G_TYPE_CHECK_CLASS_CAST
39 G_TYPE_CHECK_CLASS_TYPE
40 G_TYPE_CHECK_VALUE
41 G_TYPE_CHECK_VALUE_TYPE
42 g_type_init
43 g_type_name
44 g_type_qname
45 g_type_from_name
46 g_type_parent
47 g_type_next_base
48 g_type_is_a
49 g_type_fundamental_branch_last
50 g_type_class_ref
51 g_type_class_peek
52 g_type_class_unref
53 g_type_class_peek_parent
54 g_type_interface_peek
55 g_type_children
56 g_type_interfaces
57 g_type_set_qdata
58 g_type_get_qdata
59 GBaseInitFunc
60 GBaseFinalizeFunc
61 GClassInitFunc
62 GClassFinalizeFunc
63 GInstanceInitFunc
64 GInterfaceInitFunc
65 GInterfaceFinalizeFunc
66 GTypeClassCacheFunc
67 GTypeFlags
68 GTypeFundamentalFlags
69 g_type_register_static
70 g_type_register_dynamic
71 g_type_register_fundamental
72 g_type_add_interface_static
73 g_type_add_interface_dynamic
74 g_type_get_plugin
75 g_type_interface_get_plugin
76 g_type_fundamental_last
77 g_type_check_flags
78 g_type_create_instance
79 g_type_free_instance
80 g_type_add_class_cache_func
81 g_type_remove_class_cache_func
82 g_type_class_unref_uncached
83 g_type_check_instance
84 g_type_check_instance_cast
85 g_type_instance_is_a
86 g_type_check_class_cast
87 g_type_class_is_a
88 g_type_check_value
89 g_type_value_is_a
90 g_type_value_table_peek
91 <SUBSECTION Private>
92 </SECTION>
93
94 <SECTION>
95 <FILE>gtypeplugin</FILE>
96 <TITLE>GTypePlugin</TITLE>
97 GTypePlugin
98 GTypePluginUse
99 GTypePluginUnuse
100 GTypePluginCompleteTypeInfo
101 GTypePluginCompleteInterfaceInfo
102 g_type_plugin_use
103 g_type_plugin_unuse
104 g_type_plugin_complete_type_info
105 g_type_plugin_complete_interface_info
106 <SUBSECTION Standard>
107 G_TYPE_PLUGIN
108 G_IS_TYPE_PLUGIN
109 G_TYPE_TYPE_PLUGIN
110 g_type_plugin_get_type
111 G_TYPE_PLUGIN_CLASS
112 G_IS_TYPE_PLUGIN_CLASS
113 G_TYPE_PLUGIN_GET_CLASS
114 </SECTION>
115
116 <SECTION>
117 <FILE>gtypemodule</FILE>
118 <TITLE>GTypeModule</TITLE>
119 GTypeModule
120 g_type_module_use
121 g_type_module_unuse
122 g_type_module_set_name
123 g_type_module_register_type
124 g_type_module_add_interface
125 <SUBSECTION Standard>
126 G_TYPE_MODULE
127 G_IS_TYPE_MODULE
128 G_TYPE_TYPE_MODULE
129 g_type_module_get_type
130 G_TYPE_MODULE_CLASS
131 G_IS_TYPE_MODULE_CLASS
132 G_TYPE_MODULE_GET_CLASS
133 </SECTION>
134
135 <SECTION>
136 <TITLE>The Base Object Type</TITLE>
137 <FILE>objects</FILE>
138 GObject
139 GObjectClass
140 GObjectConstructParam
141 GObjectGetPropertyFunc
142 GObjectSetPropertyFunc
143 G_OBJECT
144 G_OBJECT_GET_CLASS
145 G_OBJECT_TYPE
146 G_OBJECT_TYPE_NAME
147 G_OBJECT_CLASS_TYPE
148 G_OBJECT_CLASS_NAME
149 G_IS_VALUE_OBJECT
150 G_TYPE_IS_OBJECT
151 G_IS_OBJECT
152 G_OBJECT_CLASS
153 G_IS_OBJECT_CLASS
154 GObjectFinalizeFunc
155 g_object_class_install_property
156 g_object_class_find_property
157 g_object_new
158 g_object_new_valist
159 g_object_set
160 g_object_get
161 g_object_set_valist
162 g_object_get_valist
163 g_object_set_property
164 g_object_get_property
165 g_object_freeze_notify
166 g_object_notify
167 g_object_thaw_notify
168 g_object_ref
169 g_object_unref
170 g_object_get_qdata
171 g_object_set_qdata
172 g_object_set_qdata_full
173 g_object_steal_qdata
174 g_object_get_data
175 g_object_set_data
176 g_object_set_data_full
177 g_object_steal_data
178 g_value_set_object
179 g_value_get_object
180 g_value_dup_object
181 g_object_watch_closure
182 G_OBJECT_WARN_INVALID_PROPERTY_ID
183 </SECTION>
184
185 <SECTION>
186 <TITLE>Enumeration and Flag Types</TITLE>
187 <FILE>enumerations_flags</FILE>
188 GEnumClass
189 GFlagsClass
190 G_ENUM_CLASS_TYPE
191 G_ENUM_CLASS_TYPE_NAME
192 G_TYPE_IS_ENUM
193 G_ENUM_CLASS
194 G_IS_ENUM_CLASS
195 G_TYPE_IS_FLAGS
196 G_FLAGS_CLASS
197 G_IS_FLAGS_CLASS
198 G_FLAGS_CLASS_TYPE
199 G_FLAGS_CLASS_TYPE_NAME
200 G_IS_VALUE_ENUM
201 G_IS_VALUE_FLAGS
202 GEnumValue
203 GFlagsValue
204 g_enum_get_value
205 g_enum_get_value_by_name
206 g_enum_get_value_by_nick
207 g_flags_get_first_value
208 g_flags_get_value_by_name
209 g_flags_get_value_by_nick
210 g_value_set_enum
211 g_value_get_enum
212 g_value_set_flags
213 g_value_get_flags
214 g_enum_register_static
215 g_flags_register_static
216 g_enum_complete_type_info
217 g_flags_complete_type_info
218 </SECTION>
219
220 <SECTION>
221 <FILE>gboxed</FILE>
222 <TITLE>Boxed Types</TITLE>
223 GBoxed
224 GBoxedCopyFunc
225 GBoxedFreeFunc
226 g_boxed_copy
227 g_boxed_free
228 g_value_set_boxed
229 g_value_set_static_boxed
230 g_value_get_boxed
231 g_value_dup_boxed
232 g_boxed_type_register_static
233 <SUBSECTION Standard>
234 G_IS_VALUE_BOXED
235 G_TYPE_IS_BOXED
236 </SECTION>
237
238 <SECTION>
239 <TITLE>Generic values</TITLE>
240 <FILE>generic_values</FILE>
241 G_VALUE_HOLDS
242 G_VALUE_TYPE
243 G_VALUE_TYPE_NAME
244 G_TYPE_IS_VALUE
245 G_IS_VALUE
246 GValueExchange
247 GValue
248 g_value_init
249 g_value_copy
250 g_value_convert
251 g_value_reset
252 g_value_unset
253 g_value_fits_pointer
254 g_values_exchange
255 g_value_types_exchangable
256 g_value_register_exchange_func
257 </SECTION>
258
259 <SECTION>
260 <TITLE>Standard value types</TITLE>
261 <FILE>value_types</FILE>
262 G_IS_VALUE_CHAR
263 G_IS_VALUE_UCHAR
264 G_IS_VALUE_BOOLEAN
265 G_IS_VALUE_INT
266 G_IS_VALUE_UINT
267 G_IS_VALUE_LONG
268 G_IS_VALUE_ULONG
269 G_IS_VALUE_FLOAT
270 G_IS_VALUE_DOUBLE
271 G_IS_VALUE_STRING
272 G_IS_VALUE_POINTER
273 G_IS_VALUE_CCALLBACK
274 G_IS_VALUE_PARAM
275 g_value_set_char
276 g_value_get_char
277 g_value_set_uchar
278 g_value_get_uchar
279 g_value_set_boolean
280 g_value_get_boolean
281 g_value_set_int
282 g_value_get_int
283 g_value_set_uint
284 g_value_get_uint
285 g_value_set_long
286 g_value_get_long
287 g_value_set_ulong
288 g_value_get_ulong
289 g_value_set_float
290 g_value_get_float
291 g_value_set_double
292 g_value_get_double
293 g_value_set_string
294 g_value_set_static_string
295 g_value_get_string
296 g_value_dup_string
297 g_value_set_param
298 g_value_get_param
299 g_value_dup_param
300 g_value_get_ccallback
301 g_value_get_pointer
302 g_value_set_pointer
303 g_value_set_ccallback
304 g_value_set_instance
305 </SECTION>
306
307 <SECTION>
308 <TITLE>Parameter Specifications</TITLE>
309 <FILE>param_specs</FILE>
310 GParamSpec
311 GParamSpecClass
312 G_PARAM_SPEC_TYPE
313 G_PARAM_SPEC_TYPE_NAME
314 G_PARAM_SPEC
315 G_IS_PARAM_SPEC
316 G_PARAM_SPEC_GET_CLASS
317 G_PARAM_SPEC_VALUE_TYPE
318 G_TYPE_IS_PARAM
319 GParamFlags
320 g_param_spec_ref
321 g_param_spec_unref
322 g_param_spec_sink
323 g_param_spec_get_qdata
324 g_param_spec_set_qdata
325 g_param_spec_set_qdata_full
326 g_param_spec_steal_qdata
327 g_param_value_set_default
328 g_param_value_defaults
329 g_param_value_validate
330 g_param_values_cmp
331 g_param_spec_internal
332 g_param_spec_pool_new
333 g_param_spec_pool_insert
334 g_param_spec_pool_remove
335 g_param_spec_pool_lookup
336 g_param_type_register_static
337 </SECTION>
338
339 <SECTION>
340 <TITLE>Standard Parameter Types</TITLE>
341 <FILE>standard_params</FILE>
342 G_IS_PARAM_SPEC_CHAR
343 G_PARAM_SPEC_CHAR
344 G_IS_PARAM_SPEC_UCHAR
345 G_PARAM_SPEC_UCHAR
346 G_IS_PARAM_SPEC_BOOLEAN
347 G_PARAM_SPEC_BOOLEAN
348 G_IS_PARAM_SPEC_INT
349 G_PARAM_SPEC_INT
350 G_IS_PARAM_SPEC_UINT
351 G_PARAM_SPEC_UINT
352 G_IS_PARAM_SPEC_LONG
353 G_PARAM_SPEC_LONG
354 G_IS_PARAM_SPEC_ULONG
355 G_PARAM_SPEC_ULONG
356 G_IS_PARAM_SPEC_ENUM
357 G_PARAM_SPEC_ENUM
358 G_IS_PARAM_SPEC_FLAGS
359 G_PARAM_SPEC_FLAGS
360 G_IS_PARAM_SPEC_FLOAT
361 G_PARAM_SPEC_FLOAT
362 G_IS_PARAM_SPEC_DOUBLE
363 G_PARAM_SPEC_DOUBLE
364 G_IS_PARAM_SPEC_STRING
365 G_PARAM_SPEC_STRING
366 G_IS_PARAM_SPEC_POINTER
367 G_PARAM_SPEC_POINTER
368 G_IS_PARAM_SPEC_BOXED
369 G_PARAM_SPEC_BOXED
370 G_IS_PARAM_SPEC_CCALLBACK
371 G_PARAM_SPEC_CCALLBACK
372 G_IS_PARAM_SPEC_PARAM
373 G_PARAM_SPEC_PARAM
374 G_IS_PARAM_SPEC_OBJECT
375 G_PARAM_SPEC_OBJECT
376 GParamSpecChar
377 GParamSpecUChar
378 GParamSpecBoolean
379 GParamSpecInt
380 GParamSpecUInt
381 GParamSpecLong
382 GParamSpecULong
383 GParamSpecEnum
384 GParamSpecFlags
385 GParamSpecFloat
386 GParamSpecDouble
387 GParamSpecString
388 GParamSpecBoxed
389 GParamSpecCCallback
390 GParamSpecParam
391 GParamSpecPointer
392 GParamSpecObject
393 g_param_spec_char
394 g_param_spec_uchar
395 g_param_spec_boolean
396 g_param_spec_int
397 g_param_spec_uint
398 g_param_spec_long
399 g_param_spec_ulong
400 g_param_spec_enum
401 g_param_spec_flags
402 g_param_spec_float
403 g_param_spec_double
404 g_param_spec_string
405 g_param_spec_string_c
406 g_param_spec_boxed
407 g_param_spec_ccallback
408 g_param_spec_param
409 g_param_spec_pointer
410 g_param_spec_object
411 </SECTION>
412
413 <SECTION>
414 <TITLE>Varargs Value Collection</TITLE>
415 <FILE>value_collection</FILE>
416 GTypeCValue
417 G_VALUE_COLLECT
418 G_VALUE_LCOPY
419 </SECTION>
420
421 <SECTION>
422 <TITLE>Signals</TITLE>
423 <FILE>signals</FILE>
424 GSignalInvocationHint
425 GSignalAccumulator
426 GSignalCMarshaller
427 GSignalEmissionHook
428 GSignalFlags
429 GSignalMatchType
430 GSignalQuery
431 g_signal_newc
432 g_signal_newv
433 g_signal_new_valist
434 g_signal_query
435 g_signal_lookup
436 g_signal_name
437 g_signal_list_ids
438 g_signal_emit
439 g_signal_emit_by_name
440 g_signal_emitv
441 g_signal_emit_valist
442 g_signal_connect_data
443 g_signal_connect_object
444 g_signal_connect_closure
445 g_signal_connect_closure_by_id
446 g_signal_handler_block
447 g_signal_handler_unblock
448 g_signal_handler_disconnect
449 g_signal_handler_find
450 g_signal_handlers_block_matched
451 g_signal_handlers_unblock_matched
452 g_signal_handlers_disconnect_matched
453 g_signal_has_handler_pending
454 g_signal_stop_emission
455 g_signal_add_emission_hook_full
456 g_signal_remove_emission_hook
457 g_signal_parse_name
458 g_signal_handlers_destroy
459 g_signal_type_cclosure_new
460 </SECTION>
461
462 <SECTION>
463 <TITLE>Closures</TITLE>
464 <FILE>closures</FILE>
465 GClosureMarshal
466 GClosureNotify
467 GClosure
468 GCClosure
469 GClosureNotifyData
470 GCallback
471 G_CLOSURE_NEEDS_MARSHAL
472 G_CCLOSURE_SWAP_DATA
473 g_cclosure_new
474 g_cclosure_new_swap
475 g_cclosure_new_object
476 g_cclosure_new_object_swap
477 g_closure_ref
478 g_closure_unref
479 g_closure_invoke
480 g_closure_invalidate
481 g_closure_add_fnotify
482 g_closure_remove_fnotify
483 g_closure_add_inotify
484 g_closure_remove_inotify
485 g_closure_new_simple
486 g_closure_set_marshal
487 g_closure_add_marshal_guards
488 g_closure_set_meta_marshal
489 </SECTION>