Add g_type_interface_prerequisites.
[glib.git] / docs / reference / gobject / gobject-sections.txt
blobefe9e10a5b087b9583c649c85ca1ae507218a76d
1 <INCLUDE>gobject.h</INCLUDE>
3 <SECTION>
4 <FILE>gtype</FILE>
5 <TITLE>Type Information</TITLE>
6 GType
7 G_TYPE_FUNDAMENTAL
8 G_TYPE_FUNDAMENTAL_MAX
9 G_TYPE_MAKE_FUNDAMENTAL
10 G_TYPE_IS_ABSTRACT
11 G_TYPE_IS_DERIVED
12 G_TYPE_IS_FUNDAMENTAL
13 G_TYPE_IS_VALUE_TYPE
14 G_TYPE_HAS_VALUE_TABLE
15 G_TYPE_IS_CLASSED
16 G_TYPE_IS_INSTANTIATABLE
17 G_TYPE_IS_DERIVABLE
18 G_TYPE_IS_DEEP_DERIVABLE
19 G_TYPE_IS_INTERFACE
20 GTypeInterface
21 GTypeInstance
22 GTypeInfo
23 GTypeFundamentalInfo
24 GInterfaceInfo
25 GTypeValueTable
26 <TITLE>GType</TITLE>
27 G_TYPE_FROM_INSTANCE
28 G_TYPE_FROM_CLASS
29 G_TYPE_FROM_INTERFACE
30 G_TYPE_INSTANCE_GET_CLASS
31 G_TYPE_INSTANCE_GET_INTERFACE
32 G_TYPE_CHECK_INSTANCE
33 G_TYPE_CHECK_INSTANCE_CAST
34 G_TYPE_CHECK_INSTANCE_TYPE
35 G_TYPE_CHECK_CLASS_CAST
36 G_TYPE_CHECK_CLASS_TYPE
37 G_TYPE_CHECK_VALUE
38 G_TYPE_CHECK_VALUE_TYPE
39 G_TYPE_FLAG_RESERVED_ID_BIT
40 g_type_init
41 GTypeDebugFlags
42 g_type_init_with_debug_flags
43 g_type_name
44 g_type_qname
45 g_type_from_name
46 g_type_parent
47 g_type_depth
48 g_type_next_base
49 g_type_is_a
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_interface_peek_parent
56 g_type_children
57 g_type_interfaces
58 g_type_interface_prerequisites
59 g_type_set_qdata
60 g_type_get_qdata
61 g_type_query
62 GTypeQuery
63 GBaseInitFunc
64 GBaseFinalizeFunc
65 GClassInitFunc
66 GClassFinalizeFunc
67 GInstanceInitFunc
68 GInterfaceInitFunc
69 GInterfaceFinalizeFunc
70 GTypeClassCacheFunc
71 GTypeFlags
72 GTypeFundamentalFlags
73 g_type_register_static
74 g_type_register_dynamic
75 g_type_register_fundamental
76 g_type_add_interface_static
77 g_type_add_interface_dynamic
78 g_type_interface_add_prerequisite
79 g_type_get_plugin
80 g_type_interface_get_plugin
81 g_type_fundamental_next
82 g_type_fundamental
83 g_type_create_instance
84 g_type_free_instance
85 g_type_add_class_cache_func
86 g_type_remove_class_cache_func
87 g_type_class_unref_uncached
88 g_type_value_table_peek
89 <SUBSECTION Private>
90 G_TYPE_FUNDAMENTAL_SHIFT
91 g_type_check_instance
92 g_type_check_instance_cast
93 g_type_check_instance_is_a
94 g_type_check_class_cast
95 g_type_check_class_is_a
96 g_type_check_is_value_type
97 g_type_check_value
98 g_type_check_value_holds
99 g_type_test_flags
100 g_type_name_from_instance
101 g_type_name_from_class
103 <SUBSECTION>
104 G_TYPE_INVALID
105 G_TYPE_NONE
106 G_TYPE_INTERFACE
107 G_TYPE_CHAR
108 G_TYPE_UCHAR
109 G_TYPE_BOOLEAN
110 G_TYPE_INT
111 G_TYPE_UINT
112 G_TYPE_LONG
113 G_TYPE_ULONG
114 G_TYPE_INT64
115 G_TYPE_UINT64
116 G_TYPE_ENUM
117 G_TYPE_FLAGS
118 G_TYPE_FLOAT
119 G_TYPE_DOUBLE
120 G_TYPE_STRING
121 G_TYPE_POINTER
122 G_TYPE_BOXED
123 G_TYPE_PARAM
124 G_TYPE_OBJECT
126 <SUBSECTION>
127 G_TYPE_RESERVED_GLIB_FIRST
128 G_TYPE_RESERVED_GLIB_LAST
129 G_TYPE_RESERVED_BSE_FIRST
130 G_TYPE_RESERVED_BSE_LAST
131 G_TYPE_RESERVED_USER_FIRST
133 <SUBSECTION Private>
134 GOBJECT_VAR
135 </SECTION>
137 <SECTION>
138 <FILE>gtypeplugin</FILE>
139 <TITLE>GTypePlugin</TITLE>
140 GTypePlugin
141 GTypePluginUse
142 GTypePluginUnuse
143 GTypePluginCompleteTypeInfo
144 GTypePluginCompleteInterfaceInfo
145 g_type_plugin_use
146 g_type_plugin_unuse
147 g_type_plugin_complete_type_info
148 g_type_plugin_complete_interface_info
149 <SUBSECTION Standard>
150 G_TYPE_PLUGIN
151 G_IS_TYPE_PLUGIN
152 G_TYPE_TYPE_PLUGIN
153 g_type_plugin_get_type
154 G_TYPE_PLUGIN_CLASS
155 G_IS_TYPE_PLUGIN_CLASS
156 G_TYPE_PLUGIN_GET_CLASS
157 </SECTION>
159 <SECTION>
160 <FILE>gtypemodule</FILE>
161 <TITLE>GTypeModule</TITLE>
162 GTypeModule
163 g_type_module_use
164 g_type_module_unuse
165 g_type_module_set_name
166 g_type_module_register_type
167 g_type_module_add_interface
168 <SUBSECTION Standard>
169 G_TYPE_MODULE
170 G_IS_TYPE_MODULE
171 G_TYPE_TYPE_MODULE
172 g_type_module_get_type
173 G_TYPE_MODULE_CLASS
174 G_IS_TYPE_MODULE_CLASS
175 G_TYPE_MODULE_GET_CLASS
176 </SECTION>
178 <SECTION>
179 <TITLE>The Base Object Type</TITLE>
180 <FILE>objects</FILE>
181 GObject
182 GObjectClass
183 GObjectGetPropertyFunc
184 GObjectSetPropertyFunc
185 GObjectFinalizeFunc
186 G_TYPE_IS_OBJECT
187 G_OBJECT
188 G_IS_OBJECT
189 G_OBJECT_CLASS
190 G_IS_OBJECT_CLASS
191 G_OBJECT_GET_CLASS
192 G_OBJECT_TYPE
193 G_OBJECT_TYPE_NAME
194 G_OBJECT_CLASS_TYPE
195 G_OBJECT_CLASS_NAME
196 g_object_class_install_property
197 g_object_class_find_property
198 g_object_class_list_properties
199 g_object_new
200 g_object_newv
201 GParameter
202 g_object_ref
203 g_object_unref
204 GWeakNotify
205 g_object_weak_ref
206 g_object_weak_unref
207 g_object_add_weak_pointer
208 g_object_remove_weak_pointer
209 g_object_connect
210 g_object_disconnect
211 g_object_set
212 g_object_get
213 g_object_notify
214 g_object_freeze_notify
215 g_object_thaw_notify
216 g_object_get_data
217 g_object_set_data
218 g_object_set_data_full
219 g_object_steal_data
220 g_object_get_qdata
221 g_object_set_qdata
222 g_object_set_qdata_full
223 g_object_steal_qdata
224 g_object_set_property
225 g_object_get_property
226 g_object_new_valist
227 g_object_set_valist
228 g_object_get_valist
229 g_object_watch_closure
230 g_object_run_dispose
231 G_OBJECT_WARN_INVALID_PSPEC
232 G_OBJECT_WARN_INVALID_PROPERTY_ID
233 <SUBSECTION Private>
234 GObjectConstructParam
235 </SECTION>
237 <SECTION>
238 <TITLE>Enumeration and Flag Types</TITLE>
239 <FILE>enumerations_flags</FILE>
240 GEnumClass
241 GFlagsClass
242 G_ENUM_CLASS_TYPE
243 G_ENUM_CLASS_TYPE_NAME
244 G_TYPE_IS_ENUM
245 G_ENUM_CLASS
246 G_IS_ENUM_CLASS
247 G_TYPE_IS_FLAGS
248 G_FLAGS_CLASS
249 G_IS_FLAGS_CLASS
250 G_FLAGS_CLASS_TYPE
251 G_FLAGS_CLASS_TYPE_NAME
252 GEnumValue
253 GFlagsValue
254 g_enum_get_value
255 g_enum_get_value_by_name
256 g_enum_get_value_by_nick
257 g_flags_get_first_value
258 g_flags_get_value_by_name
259 g_flags_get_value_by_nick
260 g_enum_register_static
261 g_flags_register_static
262 g_enum_complete_type_info
263 g_flags_complete_type_info
264 </SECTION>
266 <SECTION>
267 <FILE>gboxed</FILE>
268 <TITLE>Boxed Types</TITLE>
269 GBoxedCopyFunc
270 GBoxedFreeFunc
271 g_boxed_copy
272 g_boxed_free
273 g_boxed_type_register_static
274 g_pointer_type_register_static
276 <SUBSECTION>
277 G_TYPE_GSTRING
279 <SUBSECTION Standard>
280 G_TYPE_IS_BOXED
282 <SUBSECTION Private>
283 g_gstring_get_type
284 </SECTION>
286 <SECTION>
287 <TITLE>Generic values</TITLE>
288 <FILE>generic_values</FILE>
289 G_VALUE_HOLDS
290 G_VALUE_TYPE
291 G_VALUE_TYPE_NAME
292 G_TYPE_IS_VALUE
293 G_TYPE_IS_VALUE_ABSTRACT
294 G_IS_VALUE
295 GValue
296 G_TYPE_VALUE
297 G_TYPE_VALUE_ARRAY
298 g_value_init
299 g_value_copy
300 g_value_reset
301 g_value_unset
302 g_value_fits_pointer
303 g_value_peek_pointer
304 g_value_type_compatible
305 g_value_type_transformable
306 g_value_transform
307 GValueTransform
308 g_value_register_transform_func
309 g_strdup_value_contents
311 <SUBSECTION Private>
312 G_VALUE_NOCOPY_CONTENTS
313 g_value_get_type
314 g_value_array_get_type
315 </SECTION>
317 <SECTION>
318 <TITLE>Value arrays</TITLE>
319 <FILE>value_arrays</FILE>
320 GValueArray
321 g_value_array_get_nth
322 g_value_array_new
323 g_value_array_copy
324 g_value_array_free
325 g_value_array_append
326 g_value_array_prepend
327 g_value_array_insert
328 g_value_array_remove
329 g_value_array_sort
330 g_value_array_sort_with_data
331 </SECTION>
333 <SECTION>
334 <TITLE>GParamSpec</TITLE>
335 <FILE>gparamspec</FILE>
336 G_TYPE_IS_PARAM
337 G_PARAM_SPEC
338 G_IS_PARAM_SPEC
339 G_PARAM_SPEC_CLASS
340 G_IS_PARAM_SPEC_CLASS
341 G_PARAM_SPEC_GET_CLASS
342 G_PARAM_SPEC_TYPE
343 G_PARAM_SPEC_TYPE_NAME
344 G_PARAM_SPEC_VALUE_TYPE
345 GParamSpec
346 GParamSpecClass
347 GParamFlags
348 G_PARAM_READWRITE
349 G_PARAM_MASK
350 G_PARAM_USER_SHIFT
351 g_param_spec_ref
352 g_param_spec_unref
353 g_param_spec_sink
354 g_param_value_set_default
355 g_param_value_defaults
356 g_param_value_validate
357 g_param_value_convert
358 g_param_values_cmp
359 g_param_spec_get_name
360 g_param_spec_get_nick
361 g_param_spec_get_blurb
362 g_param_spec_get_qdata
363 g_param_spec_set_qdata
364 g_param_spec_set_qdata_full
365 g_param_spec_steal_qdata
366 g_param_spec_internal
367 GParamSpecTypeInfo
368 g_param_type_register_static
369 GParamSpecPool
370 g_param_spec_pool_new
371 g_param_spec_pool_insert
372 g_param_spec_pool_remove
373 g_param_spec_pool_lookup
374 g_param_spec_pool_list
375 g_param_spec_pool_list_owned
376 </SECTION>
378 <SECTION>
379 <TITLE>Standard Parameter and Value Types</TITLE>
380 <FILE>param_value_types</FILE>
382 <SUBSECTION gboolean>
383 G_IS_PARAM_SPEC_BOOLEAN
384 G_PARAM_SPEC_BOOLEAN
385 G_VALUE_HOLDS_BOOLEAN
386 G_TYPE_PARAM_BOOLEAN
387 GParamSpecBoolean
388 g_param_spec_boolean
389 g_value_set_boolean
390 g_value_get_boolean
392 <SUBSECTION gchar>
393 G_IS_PARAM_SPEC_CHAR
394 G_PARAM_SPEC_CHAR
395 G_VALUE_HOLDS_CHAR
396 G_TYPE_PARAM_CHAR
397 GParamSpecChar
398 g_param_spec_char
399 g_value_set_char
400 g_value_get_char
402 <SUBSECTION guchar>
403 G_IS_PARAM_SPEC_UCHAR
404 G_PARAM_SPEC_UCHAR
405 G_VALUE_HOLDS_UCHAR
406 G_TYPE_PARAM_UCHAR
407 GParamSpecUChar
408 g_param_spec_uchar
409 g_value_set_uchar
410 g_value_get_uchar
412 <SUBSECTION gint>
413 G_IS_PARAM_SPEC_INT
414 G_PARAM_SPEC_INT
415 G_VALUE_HOLDS_INT  
416 G_TYPE_PARAM_INT
417 GParamSpecInt
418 g_param_spec_int
419 g_value_set_int
420 g_value_get_int
422 <SUBSECTION guint>
423 G_IS_PARAM_SPEC_UINT
424 G_PARAM_SPEC_UINT
425 G_VALUE_HOLDS_UINT  
426 G_TYPE_PARAM_UINT
427 GParamSpecUInt
428 g_param_spec_uint
429 g_value_set_uint
430 g_value_get_uint
432 <SUBSECTION glong>
433 G_IS_PARAM_SPEC_LONG
434 G_PARAM_SPEC_LONG
435 G_VALUE_HOLDS_LONG 
436 G_TYPE_PARAM_LONG
437 GParamSpecLong
438 g_param_spec_long
439 g_value_set_long
440 g_value_get_long
442 <SUBSECTION gulong>
443 G_IS_PARAM_SPEC_ULONG
444 G_PARAM_SPEC_ULONG
445 G_VALUE_HOLDS_ULONG 
446 G_TYPE_PARAM_ULONG
447 GParamSpecULong
448 g_param_spec_ulong
449 g_value_set_ulong
450 g_value_get_ulong
452 <SUBSECTION gint64>
453 G_IS_PARAM_SPEC_INT64
454 G_PARAM_SPEC_INT64
455 G_VALUE_HOLDS_INT64
456 G_TYPE_PARAM_INT64
457 GParamSpecInt64
458 g_param_spec_int64
459 g_value_set_int64
460 g_value_get_int64
462 <SUBSECTION guint64>
463 G_IS_PARAM_SPEC_UINT64
464 G_PARAM_SPEC_UINT64
465 G_VALUE_HOLDS_UINT64
466 G_TYPE_PARAM_UINT64
467 GParamSpecUInt64
468 g_param_spec_uint64
469 g_value_set_uint64
470 g_value_get_uint64
472 <SUBSECTION gfloat>
473 G_IS_PARAM_SPEC_FLOAT
474 G_PARAM_SPEC_FLOAT
475 G_VALUE_HOLDS_FLOAT
476 G_TYPE_PARAM_FLOAT
477 GParamSpecFloat
478 g_param_spec_float
479 g_value_set_float
480 g_value_get_float
482 <SUBSECTION gdouble>
483 G_IS_PARAM_SPEC_DOUBLE
484 G_PARAM_SPEC_DOUBLE
485 G_VALUE_HOLDS_DOUBLE
486 G_TYPE_PARAM_DOUBLE
487 GParamSpecDouble
488 g_param_spec_double
489 g_value_set_double
490 g_value_get_double
492 <SUBSECTION GEnum>
493 G_IS_PARAM_SPEC_ENUM
494 G_PARAM_SPEC_ENUM
495 G_VALUE_HOLDS_ENUM
496 G_TYPE_PARAM_ENUM
497 GParamSpecEnum
498 g_param_spec_enum
499 g_value_set_enum
500 g_value_get_enum
502 <SUBSECTION GFLags>
503 G_IS_PARAM_SPEC_FLAGS
504 G_PARAM_SPEC_FLAGS
505 G_VALUE_HOLDS_FLAGS
506 G_TYPE_PARAM_FLAGS
507 GParamSpecFlags
508 g_param_spec_flags
509 g_value_set_flags
510 g_value_get_flags
512 <SUBSECTION gchararray>
513 G_IS_PARAM_SPEC_STRING
514 G_PARAM_SPEC_STRING
515 G_VALUE_HOLDS_STRING
516 G_TYPE_PARAM_STRING
517 GParamSpecString
518 gchararray
519 g_param_spec_string
520 g_value_set_string
521 g_value_set_static_string
522 g_value_set_string_take_ownership
523 g_value_get_string
524 g_value_dup_string
526 <SUBSECTION GParamSpec>
527 G_IS_PARAM_SPEC_PARAM
528 G_PARAM_SPEC_PARAM
529 G_VALUE_HOLDS_PARAM
530 G_TYPE_PARAM_PARAM
531 GParamSpecParam
532 g_param_spec_param
533 g_value_set_param
534 g_value_set_param_take_ownership
535 g_value_get_param
536 g_value_dup_param
538 <SUBSECTION GBoxed>
539 G_IS_PARAM_SPEC_BOXED
540 G_PARAM_SPEC_BOXED
541 G_VALUE_HOLDS_BOXED
542 G_TYPE_PARAM_BOXED
543 GParamSpecBoxed
544 g_param_spec_boxed
545 g_value_set_boxed
546 g_value_set_static_boxed
547 g_value_set_boxed_take_ownership
548 g_value_get_boxed
549 g_value_dup_boxed
551 <SUBSECTION gpointer>
552 G_IS_PARAM_SPEC_POINTER
553 G_PARAM_SPEC_POINTER
554 G_VALUE_HOLDS_POINTER
555 G_TYPE_PARAM_POINTER
556 GParamSpecPointer
557 g_param_spec_pointer
558 g_value_set_pointer
559 g_value_get_pointer
561 <SUBSECTION GObject>
562 G_IS_PARAM_SPEC_OBJECT
563 G_PARAM_SPEC_OBJECT
564 G_VALUE_HOLDS_OBJECT
565 G_TYPE_PARAM_OBJECT
566 GParamSpecObject
567 g_param_spec_object
568 g_value_set_object
569 g_value_set_object_take_ownership
570 g_value_get_object
571 g_value_dup_object
573 <SUBSECTION gunichar>
574 G_IS_PARAM_SPEC_UNICHAR
575 G_PARAM_SPEC_UNICHAR
576 G_TYPE_PARAM_UNICHAR
577 GParamSpecUnichar
578 g_param_spec_unichar
580 <SUBSECTION GValueArray>
581 G_IS_PARAM_SPEC_VALUE_ARRAY
582 G_PARAM_SPEC_VALUE_ARRAY
583 G_TYPE_PARAM_VALUE_ARRAY
584 GParamSpecValueArray
585 g_param_spec_value_array
587 <SUBSECTION Private>
588 g_value_set_instance
589 g_param_spec_types
590 </SECTION>
592 <SECTION>
593 <TITLE>Varargs Value Collection</TITLE>
594 <FILE>value_collection</FILE>
595 GTypeCValue
596 G_VALUE_COLLECT
597 G_VALUE_LCOPY
598 G_VALUE_COLLECT_FORMAT_MAX_LENGTH
599 </SECTION>
601 <SECTION>
602 <TITLE>Signals</TITLE>
603 <FILE>signals</FILE>
604 GSignalInvocationHint
605 GSignalAccumulator
606 GSignalCMarshaller
607 GSignalEmissionHook
608 GSignalFlags
609 GSignalMatchType
610 GSignalQuery
611 G_SIGNAL_TYPE_STATIC_SCOPE
612 G_SIGNAL_MATCH_MASK
613 G_SIGNAL_FLAGS_MASK
614 g_signal_new
615 g_signal_newv
616 g_signal_new_valist
617 g_signal_query
618 g_signal_lookup
619 g_signal_name
620 g_signal_list_ids
621 g_signal_emit
622 g_signal_emit_by_name
623 g_signal_emitv
624 g_signal_emit_valist
625 g_signal_connect
626 g_signal_connect_after
627 g_signal_connect_swapped
628 g_signal_connect_object
629 GConnectFlags
630 g_signal_connect_data
631 g_signal_connect_closure
632 g_signal_connect_closure_by_id
633 g_signal_handler_block
634 g_signal_handler_unblock
635 g_signal_handler_disconnect
636 g_signal_handler_find
637 g_signal_handlers_block_matched
638 g_signal_handlers_unblock_matched
639 g_signal_handlers_disconnect_matched
640 g_signal_handler_is_connected
641 g_signal_handlers_block_by_func
642 g_signal_handlers_unblock_by_func
643 g_signal_handlers_disconnect_by_func
644 g_signal_has_handler_pending
645 g_signal_stop_emission
646 g_signal_stop_emission_by_name
647 g_signal_override_class_closure
648 g_signal_chain_from_overridden
649 g_signal_add_emission_hook
650 g_signal_remove_emission_hook
651 g_signal_parse_name
652 g_signal_get_invocation_hint
653 g_signal_handlers_destroy
654 g_signal_type_cclosure_new
655 </SECTION>
657 <SECTION>
658 <FILE>gclosure</FILE>
659 <TITLE>Closures</TITLE>
660 G_CLOSURE_NEEDS_MARSHAL
661 G_CLOSURE_N_NOTIFIERS
662 G_CCLOSURE_SWAP_DATA
663 G_CALLBACK
664 GCallback
665 GClosure
666 G_TYPE_CLOSURE
667 GCClosure
668 GClosureMarshal
669 GClosureNotify
670 GClosureNotifyData
671 g_cclosure_new
672 g_cclosure_new_swap
673 g_cclosure_new_object
674 g_cclosure_new_object_swap
675 g_closure_new_object
676 g_closure_ref
677 g_closure_sink
678 g_closure_unref
679 g_closure_invoke
680 g_closure_invalidate
681 g_closure_add_finalize_notifier
682 g_closure_add_invalidate_notifier
683 g_closure_remove_finalize_notifier
684 g_closure_remove_invalidate_notifier
685 g_closure_new_simple
686 g_closure_set_marshal
687 g_closure_add_marshal_guards
688 g_closure_set_meta_marshal
689 g_source_set_closure
690 G_TYPE_IO_CHANNEL
691 G_TYPE_IO_CONDITION
693 <SUBSECTION Private>
694 g_closure_get_type
695 g_cclosure_marshal_VOID__VOID
696 g_cclosure_marshal_VOID__BOOLEAN
697 g_cclosure_marshal_VOID__CHAR
698 g_cclosure_marshal_VOID__UCHAR
699 g_cclosure_marshal_VOID__INT
700 g_cclosure_marshal_VOID__UINT
701 g_cclosure_marshal_VOID__LONG
702 g_cclosure_marshal_VOID__ULONG
703 g_cclosure_marshal_VOID__ENUM
704 g_cclosure_marshal_VOID__FLAGS
705 g_cclosure_marshal_VOID__FLOAT
706 g_cclosure_marshal_VOID__DOUBLE
707 g_cclosure_marshal_VOID__STRING
708 g_cclosure_marshal_VOID__PARAM
709 g_cclosure_marshal_VOID__BOXED
710 g_cclosure_marshal_VOID__POINTER
711 g_cclosure_marshal_VOID__OBJECT
712 g_cclosure_marshal_STRING__OBJECT_POINTER
713 g_cclosure_marshal_VOID__UINT_POINTER
714 g_cclosure_marshal_BOOLEAN__FLAGS
715 g_cclosure_marshal_BOOL__FLAGS
716 g_io_channel_get_type
717 g_io_condition_get_type
718 </SECTION>