Initial commit
[platform/upstream/glib2.0.git] / docs / reference / gobject / tmpl / gobject-unused.sgml
1 <!-- ##### ENUM GTypeFundamentals ##### -->
2 <para>
3 The predefined identifiers of the reserved fundamental types.
4 </para>
5
6 @G_TYPE_INVALID:                Usually a return value indicating an error.
7 @G_TYPE_NONE:                   A synonym for the "void" type in C.
8 @G_TYPE_INTERFACE:              Root type of all interface types.
9 @G_TYPE_CHAR:                   Identifier for the built-in type "gchar".
10 @G_TYPE_UCHAR:                  Identifier for the built-in type "guchar".
11 @G_TYPE_BOOLEAN:                Identifier for the built-in type "gboolean".
12 @G_TYPE_INT:                    Identifier for the built-in type "gint".
13 @G_TYPE_UINT:                   Identifier for the built-in type "guint".
14 @G_TYPE_LONG:                   Identifier for the built-in type "glong".
15 @G_TYPE_ULONG:                  Identifier for the built-in type "gulong".
16 @G_TYPE_INT64: 
17 @G_TYPE_UINT64: 
18 @G_TYPE_ENUM:                   Identifier for the "#GEnum" type.
19 @G_TYPE_FLAGS:                  Identifier for the "#GFlags" type.
20 @G_TYPE_FLOAT:                  Identifier for the built-in type "gfloat".
21 @G_TYPE_DOUBLE:                 Identifier for the built-in type "gdouble".
22 @G_TYPE_STRING:                 Identifier for a pointer to a null-terminated string "gchar*".
23 @G_TYPE_POINTER:                Identifier for anonymous pointers "void*".
24 @G_TYPE_BOXED:                  Identifier for the "#GBoxed" type.
25 @G_TYPE_PARAM:                  Identifier for the "#GParam" type.
26 @G_TYPE_OBJECT:                 Identifier for the "#GObject" type.
27 @G_TYPE_RESERVED_BSE_FIRST:     First fundamental type ID reserved for BSE.
28 @G_TYPE_RESERVED_BSE_LAST:      Last fundamental type ID reserved for BSE.
29 @G_TYPE_RESERVED_LAST_FUNDAMENTAL: 
30 @G_TYPE_CONSTANT_TYPES: 
31 @G_TYPE_CLOSURE: 
32 @G_TYPE_VALUE: 
33 @G_TYPE_VALUE_ARRAY: 
34 @G_TYPE_GSTRING: 
35 @G_TYPE_PARAM_CHAR: 
36 @G_TYPE_PARAM_UCHAR: 
37 @G_TYPE_PARAM_BOOLEAN: 
38 @G_TYPE_PARAM_INT: 
39 @G_TYPE_PARAM_UINT: 
40 @G_TYPE_PARAM_LONG: 
41 @G_TYPE_PARAM_ULONG: 
42 @G_TYPE_PARAM_INT64: 
43 @G_TYPE_PARAM_UINT64: 
44 @G_TYPE_PARAM_UNICHAR: 
45 @G_TYPE_PARAM_ENUM: 
46 @G_TYPE_PARAM_FLAGS: 
47 @G_TYPE_PARAM_FLOAT: 
48 @G_TYPE_PARAM_DOUBLE: 
49 @G_TYPE_PARAM_STRING: 
50 @G_TYPE_PARAM_PARAM: 
51 @G_TYPE_PARAM_BOXED: 
52 @G_TYPE_PARAM_POINTER: 
53 @G_TYPE_PARAM_VALUE_ARRAY: 
54 @G_TYPE_PARAM_CLOSURE: 
55 @G_TYPE_PARAM_OBJECT: 
56
57 <!-- ##### FUNCTION g_type_check_flags ##### -->
58 <para>
59 Determines whether a given set of #GTypeFlags and #GTypeFundamentalFlags
60 are set for @type.
61 </para>
62
63 @type:    The type to check for flags.
64 @flags:   Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags.
65 @Returns: #TRUE if all @flags are set for @type, #FALSE otherwise.
66
67 <!-- ##### FUNCTION g_type_class_get_private ##### -->
68 <para>
69
70 </para>
71
72 @klass: 
73 @private_type: 
74 @Returns: 
75
76 <!-- ##### FUNCTION g_type_instance_is_a ##### -->
77 <para>
78 Determines if @instance adheres to the interface exported
79 by @iface_type. @iface_type is either a type that @instance
80 is derived from, or an interface type that is supported by
81 the anchestry of @instance.
82 </para>
83
84 @instance:      A valid #GTypeInstance structure.
85 @iface_type:    A #GType value.
86 @Returns:       #TRUE if @instance conforms to @iface_type, #FALSE otherwise.
87
88 <!-- ##### FUNCTION g_type_value_is_a ##### -->
89 <para>
90 Determines if @value is a #GValue whose type conforms to @type.
91 </para>
92
93 @value:           A valid #GValue structure.
94 @type:    A #GType value.
95 @Returns: #TRUE if @value is a #GValue of @type or #FALSE if not.
96