API revamp to shorten GValueArray structure.
[platform/upstream/glib.git] / docs / reference / gobject / tmpl / gtype.sgml
index 33abba9..fe6ce1c 100644 (file)
@@ -63,31 +63,11 @@ for types that are assigned at compile-time.
 
 
 
-<!-- ##### MACRO G_TYPE_DERIVE_ID ##### -->
+<!-- ##### MACRO G_TYPE_FUNDAMENTAL_SHIFT ##### -->
 <para>
 
 </para>
 
-@ptype: 
-@branch_seqno: 
-
-
-<!-- ##### MACRO G_TYPE_BRANCH_SEQNO ##### -->
-<para>
-
-</para>
-
-@type: 
-
-
-<!-- ##### MACRO G_TYPE_FUNDAMENTAL_LAST ##### -->
-<para>
-An integer that currently represents the highest value of all
-fundamental type identifiers. This is of interest for dynamic
-introduction of new fundamental types (a
-<emphasis>rarely</emphasis> needed feature).
-</para>
-
 
 
 <!-- ##### MACRO G_TYPE_IS_ABSTRACT ##### -->
@@ -126,6 +106,14 @@ Returns #TRUE if @type is a fundamental type.
 @type: A #GType value.
 
 
+<!-- ##### MACRO G_TYPE_HAS_VALUE_TABLE ##### -->
+<para>
+
+</para>
+
+@type: 
+
+
 <!-- ##### MACRO G_TYPE_IS_CLASSED ##### -->
 <para>
 Returns #TRUE if @type is a classed type.
@@ -201,31 +189,33 @@ The predefined identifiers of the reserved fundamental types.
 @G_TYPE_OBJECT:                Identifier for the "#GObject" type.
 @G_TYPE_RESERVED_BSE_FIRST:    First fundamental type ID reserved for BSE.
 @G_TYPE_RESERVED_BSE_LAST:     Last fundamental type ID reserved for BSE.
-@G_TYPE_RESERVED_LAST_FUNDAMENTAL: Last reserved fundamental type ID.
+@G_TYPE_RESERVED_LAST_FUNDAMENTAL: 
+@G_TYPE_CONSTANT_TYPES: 
 @G_TYPE_CLOSURE: 
 @G_TYPE_VALUE: 
 @G_TYPE_VALUE_ARRAY: 
 @G_TYPE_GSTRING: 
-@G_TYPE_PARAM_CHAR:            Identifier for the "#GParamSpecChar" type.
-@G_TYPE_PARAM_UCHAR:           Identifier for the "#GParamSpecUChar" type.
-@G_TYPE_PARAM_BOOLEAN:                 Identifier for the "#GParamSpecBoolean" type.
-@G_TYPE_PARAM_INT:             Identifier for the "#GParamSpecInt" type.
-@G_TYPE_PARAM_UINT:            Identifier for the "#GParamSpecUInt" type.
-@G_TYPE_PARAM_LONG:            Identifier for the "#GParamSpecLong" type.
-@G_TYPE_PARAM_ULONG:           Identifier for the "#GParamSpecULong" type.
+@G_TYPE_PARAM_CHAR: 
+@G_TYPE_PARAM_UCHAR: 
+@G_TYPE_PARAM_BOOLEAN: 
+@G_TYPE_PARAM_INT: 
+@G_TYPE_PARAM_UINT: 
+@G_TYPE_PARAM_LONG: 
+@G_TYPE_PARAM_ULONG: 
 @G_TYPE_PARAM_INT64: 
 @G_TYPE_PARAM_UINT64: 
 @G_TYPE_PARAM_UNICHAR: 
-@G_TYPE_PARAM_ENUM:            Identifier for the "#GParamSpecEnum" type.
-@G_TYPE_PARAM_FLAGS:           Identifier for the "#GParamSpecFlags" type.
-@G_TYPE_PARAM_FLOAT:           Identifier for the "#GParamSpecFloat" type.
-@G_TYPE_PARAM_DOUBLE:          Identifier for the "#GParamSpecDouble" type.
-@G_TYPE_PARAM_STRING:          Identifier for the "#GParamSpecString" type.
-@G_TYPE_PARAM_PARAM:           Identifier for the "#GParamSpecParam" type.
-@G_TYPE_PARAM_BOXED:           Identifier for the "#GParamSpecBoxed" type.
-@G_TYPE_PARAM_POINTER:                 Identifier for the "#GParamSpecPointer" type.
-@G_TYPE_PARAM_VALUE_ARRAY:     Identifier for the "#GParamSpecValueArray" type.
-@G_TYPE_PARAM_OBJECT:          Identifier for the "#GParamSpecObject" type.
+@G_TYPE_PARAM_ENUM: 
+@G_TYPE_PARAM_FLAGS: 
+@G_TYPE_PARAM_FLOAT: 
+@G_TYPE_PARAM_DOUBLE: 
+@G_TYPE_PARAM_STRING: 
+@G_TYPE_PARAM_PARAM: 
+@G_TYPE_PARAM_BOXED: 
+@G_TYPE_PARAM_POINTER: 
+@G_TYPE_PARAM_VALUE_ARRAY: 
+@G_TYPE_PARAM_CLOSURE: 
+@G_TYPE_PARAM_OBJECT: 
 
 <!-- ##### STRUCT GTypeInterface ##### -->
 <para>
@@ -596,6 +586,16 @@ type implementations or the signal system).
 @debug_flags: Bitwise combination of #GTypeDebugFlags values for debugging purposes.
 
 
+<!-- ##### ENUM GTypeDebugFlags ##### -->
+<para>
+
+</para>
+
+@G_TYPE_DEBUG_NONE: 
+@G_TYPE_DEBUG_OBJECTS: 
+@G_TYPE_DEBUG_SIGNALS: 
+@G_TYPE_DEBUG_MASK: 
+
 <!-- ##### FUNCTION g_type_init_with_debug_flags ##### -->
 <para>
 
@@ -677,15 +677,6 @@ Check whether @type is a descendant of @is_a_type.
 @Returns:   %TRUE if @type is_a @is_a_type holds true.
 
 
-<!-- ##### FUNCTION g_type_fundamental_branch_last ##### -->
-<para>
-
-</para>
-
-@type: 
-@Returns: 
-
-
 <!-- ##### FUNCTION g_type_class_ref ##### -->
 <para>
 Increments the reference count of the class structure belonging to
@@ -811,6 +802,16 @@ g_free()ed after use.
 @query: 
 
 
+<!-- ##### STRUCT GTypeQuery ##### -->
+<para>
+
+</para>
+
+@type: 
+@type_name: 
+@class_size: 
+@instance_size: 
+
 <!-- ##### USER_FUNCTION GBaseInitFunc ##### -->
 <para>
 A callback function used by the type system to do base initialization
@@ -1129,13 +1130,27 @@ Returns the the #GTypePlugin structure for @type or
 @Returns: 
 
 
-<!-- ##### FUNCTION g_type_fundamental_last ##### -->
+<!-- ##### FUNCTION g_type_fundamental_next ##### -->
+<para>
+Returns the next free fundamental type id which can be used to
+register a new fundamental type with g_type_register_fundamental().
+The returned type ID represents the highest currently registered
+fundamental type identifier.
+
+</para>
+
+@Returns: The nextmost fundamental type ID to be registered,
+          or 0 if the type system ran out of fundamental type IDs.
+
+
+<!-- ##### FUNCTION g_type_fundamental ##### -->
 <para>
-Returns the last fundamental type which is registered plus one,
-i.e. the next fundamental type ID that may be registered.
+Internal function, used to extract the fundamental type ID portion.
+use G_TYPE_FUNDAMENTAL() instead.
 </para>
 
-@Returns: The nextmost not registered fundamental type ID.
+@type_id: valid type ID
+@Returns: fundamental type ID
 
 
 <!-- ##### FUNCTION g_type_create_instance ##### -->
@@ -1143,7 +1158,7 @@ i.e. the next fundamental type ID that may be registered.
 Creates and initializes an instance of @type if @type is valid and can
 be instantiated. The type system only performs basic allocation and
 structure setups for instances, actual instance creation should happen
-through functions supplied by the types fundamental type implementation.
+through functions supplied by the type's fundamental type implementation.
 So use of g_type_create_instance() is reserved for implementators of
 fundamental types only. E.g. instances of the #GObject hierarchy
 should be created via g_object_new() and <emphasis>never</emphasis>