Types
<!-- ##### SECTION Short_Description ##### -->
-Handle run-time type creation.
+Handle run-time type creation
<!-- ##### SECTION Long_Description ##### -->
<para>
-Gtk's type system is extensible. Because of that, types have to be
+The GTK+ type system is extensible. Because of that, types have to be
managed at runtime.
</para>
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### TYPEDEF GtkType ##### -->
<para>
-@GtkType is unique integer identifying the type. The guts of the
+#GtkType is unique integer identifying the type. The guts of the
information about the type is held in a private struct named
-GtkTypeNode.
+#GtkTypeNode.
</para>
-<!-- ##### ENUM GtkFundamentalType ##### -->
+<!-- ##### TYPEDEF GtkFundamentalType ##### -->
<para>
-@GtkFundamentalType is an enumerated type which lists all the possible
-fundamental types (e.g. char, uchar, int, long, float, etc).
+#GtkFundamentalType is an enumerated type which lists all the possible
+fundamental types (e.g. <type>char</type>, <type>uchar</type>, <type>int</type>,
+<type>long</type>, <type>float</type>, etc).
</para>
-@GTK_TYPE_INVALID:
-@GTK_TYPE_NONE:
-@GTK_TYPE_ENUM:
-@GTK_TYPE_FLAGS:
-@GTK_TYPE_CHAR:
-@GTK_TYPE_UCHAR:
-@GTK_TYPE_BOOL:
-@GTK_TYPE_INT:
-@GTK_TYPE_UINT:
-@GTK_TYPE_LONG:
-@GTK_TYPE_ULONG:
-@GTK_TYPE_FLOAT:
-@GTK_TYPE_DOUBLE:
-@GTK_TYPE_STRING:
-@GTK_TYPE_BOXED:
-@GTK_TYPE_POINTER:
-@GTK_TYPE_SIGNAL:
<!-- ##### MACRO GTK_CLASS_NAME ##### -->
<para>
-
+Returns the type name of @class.
</para>
-@class:
+@class: a #GtkTypeClass.
+@Deprecated: Use g_type_name() and G_TYPE_FROM_CLASS() instead.
<!-- ##### MACRO GTK_CLASS_TYPE ##### -->
<para>
-
+Returns the type of @class.
</para>
-@class:
+@class: a #GtkTypeClass.
+@Deprecated: Use G_TYPE_FROM_CLASS() instead.
<!-- ##### MACRO GTK_TYPE_IS_OBJECT ##### -->
<para>
-
+Returns %TRUE if @type is a %GTK_TYPE_OBJECT.
</para>
-@type:
+@type: a #GtkType.
+@Deprecated: Use G_TYPE_IS_OBJECT() instead.
<!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_LAST ##### -->
The highest-numbered structured or flat enumerated type value.
</para>
+@Deprecated: Use #G_TYPE_LAST_RESERVED_FUNDAMENTAL - 1 instead.
<!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_MAX ##### -->
<para>
-The highest maximum fundamental enumerated type value.
+The maximum fundamental enumerated type value.
</para>
+@Deprecated: Use #G_TYPE_FUNDAMENTAL_MAX instead.
<!-- ##### MACRO GTK_STRUCT_OFFSET ##### -->
<para>
-Use in place of offsetof(), which is used if it exists.
+Use in place of <function>offsetof()</function>, which is used if it exists.
</para>
-<!-- # Unused Parameters # -->
-@struct: The type of the structure.
-@field: The field within the structure.
+@Deprecated: Use G_STRUCT_OFFSET() instead.
<!-- ##### MACRO GTK_CHECK_CAST ##### -->
<para>
-Cast the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is
+Casts the object in @tobj into @cast. If %G_DISABLE_CAST_CHECKS is
defined, just cast it. Otherwise, check to see if we can cast @tobj
into a @cast.
</para>
-<!-- # Unused Parameters # -->
-@tobj: a pointer to a GtkObject.
-@cast_type: a Gtk type.
-@cast: a C type
<!-- ##### MACRO GTK_CHECK_CLASS_CAST ##### -->
<para>
-Cast the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is
+Casts the object in @tobj into @cast. If %G_DISABLE_CAST_CHECKS is
defined, just cast it. Otherwise, check to see if we can cast @tobj
into a @cast.
</para>
<!-- # Unused Parameters # -->
-@tclass: a pointer to a GtkClassInitFunc
-@cast_type: a Gtk type.
+@tclass: a #GtkClassInitFunc
+@cast_type: a GTK+ type.
@cast: a C type
</para>
<!-- # Unused Parameters # -->
-@type_object: A GtkTypeObject object.
-@otype:
+@type_object: a #GtkTypeObject object
<!-- ##### MACRO GTK_CHECK_CLASS_TYPE ##### -->
</para>
<!-- # Unused Parameters # -->
-@type_class: A GtkTypeClass class.
-@otype:
+@type_class: a #GtkTypeClass class.
<!-- ##### MACRO GTK_CHECK_GET_CLASS ##### -->
<para>
-
+Gets the class of @tobj.
</para>
+<!-- # Unused Parameters # -->
+@tobj: a #GtkObject.
<!-- ##### MACRO GTK_FUNDAMENTAL_TYPE ##### -->
<para>
-Convert a gtk type into a fundamental type
+Converts a GTK+ type into a fundamental type.
</para>
-<!-- # Unused Parameters # -->
-@type:
<!-- ##### MACRO GTK_SIGNAL_FUNC ##### -->
<para>
-Just a macroized cast into a GtkSignalFunc
+Just a macroized cast into a #GtkSignalFunc.
</para>
@f:
<!-- ##### TYPEDEF GtkClassInitFunc ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
<!-- ##### TYPEDEF GtkObjectInitFunc ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
<!-- ##### USER_FUNCTION GtkSignalFunc ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
<!-- ##### USER_FUNCTION GtkFunction ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
-@data: gpointer
-@Returns: gint
+@data: #gpointer
+@Returns: #gint
<!-- ##### USER_FUNCTION GtkDestroyNotify ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
-@data: gpointer
+@data: #gpointer
<!-- ##### USER_FUNCTION GtkCallbackMarshal ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
-@object: GtkObject*
-@data: gpointer
-@n_args: guint
-@args: GtkArg*
+@object: #GtkObject*
+@data: #gpointer
+@n_args: #guint
+@args: #GtkArg*
<!-- ##### TYPEDEF GtkSignalMarshaller ##### -->
<para>
-Define a function pointer.
-</para>
-
-
-<!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
-<para>
-Define a function pointer. Deprecated.
-</para>
-
-@object:
-@arg:
-@arg_id:
-
-
-<!-- ##### USER_FUNCTION GtkArgSetFunc ##### -->
-<para>
-Define a function pointer. Deprecated.
+Defines a function pointer.
</para>
-@object:
-@arg:
-@arg_id:
-
<!-- ##### TYPEDEF GtkTypeObject ##### -->
<para>
-A GtkTypeObject defines the minimum structure requirements
+A #GtkTypeObject defines the minimum structure requirements
for type instances. Type instances returned from gtk_type_new ()
-and initialized through a GtkObjectInitFunc need to directly inherit
+and initialized through a #GtkObjectInitFunc need to directly inherit
from this structure or at least copy its fields one by one.
</para>
<!-- ##### MACRO GTK_VALUE_CHAR ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CHAR
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_CHAR.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_UCHAR ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_UCHAR
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_UCHAR.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_BOOL ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_BOOL
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_BOOL.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_INT ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_INT
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_INT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_UINT ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_UINT
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_UINT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_LONG ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_LONG
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_LONG.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_ULONG ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ULONG
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_ULONG.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_FLOAT ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_FLOAT
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_FLOAT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_DOUBLE ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_DOUBLE
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_DOUBLE.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_STRING ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_STRING
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_STRING.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_ENUM ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ENUM
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_ENUM.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_FLAGS ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_FLAGS
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_FLAGS.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_BOXED ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_BOXED
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_BOXED.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_POINTER ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_POINTER
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_POINTER.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_OBJECT ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_OBJECT
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_OBJECT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_SIGNAL ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_SIGNAL
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_SIGNAL.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_CHAR ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_CHAR
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_CHAR.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_UCHAR ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_UCHAR
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_UCHAR.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_BOOL ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_BOOL
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_BOOL.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_INT ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_INT
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_INT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_UINT ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_UINT
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_UINT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_LONG ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_LONG
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_LONG.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_ULONG ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_ULONG
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_ULONG.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_FLOAT ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_FLOAT
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_FLOAT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_DOUBLE ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_DOUBLE
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_DOUBLE.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_STRING ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_STRING
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_STRING.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_ENUM ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_ENUM
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_ENUM.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_FLAGS ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_FLAGS
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_FLAGS.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_BOXED ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_BOXED
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_BOXED.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_POINTER ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_POINTER
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_POINTER.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_OBJECT ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_OBJECT
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_OBJECT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### STRUCT GtkTypeInfo ##### -->
<para>
-Holds information about the type. @gtk_type_name returns the name.
+Holds information about the type. gtk_type_name() returns the name.
@object_size is somehow set to the number of bytes that an instance of
the object will occupy. @class_init_func holds the type's
initialization function. @object_init_func holds the initialization
function for an instance of the object. @reserved_1 is used for
-GtkEnumValue to hold the enumerated values.
+#GtkEnumValue to hold the enumerated values.
</para>
@type_name:
<!-- ##### TYPEDEF GtkTypeClass ##### -->
<para>
-The base structure for a Gtk Type. Every type inherits this as a base structure.
+The base structure for a GTK+ type. Every type inherits this as a base structure.
</para>
<!-- ##### TYPEDEF GtkEnumValue ##### -->
<para>
-A structure which contains a single enum value, and its name, and it's
+A structure which contains a single enum value, and its name, and its
nickname.
</para>
<!-- ##### FUNCTION gtk_type_init ##### -->
<para>
-Initialize the data structures associated with gtk types.
+Initializes the data structures associated with GTK+ types.
</para>
@debug_flags:
<!-- ##### FUNCTION gtk_type_unique ##### -->
<para>
-Create a new, unique type.
+Creates a new, unique type.
</para>
@parent_type: if zero, a fundamental type is created.
@gtkinfo:
-@Returns: the new GtkType.
+@Returns: the new #GtkType.
<!-- # Unused Parameters # -->
-@type_info: must not be null, and @type_info->type_name must also not be null.
+@type_info: must not be %NULL, and @type_info->type_name must also not be %NULL.
<!-- ##### MACRO gtk_type_name ##### -->
<para>
+Returns a pointer to the name of a type, or %NULL if it has none.
</para>
-@Returns: a pointer to the name of a type, or NULL if it has none.
-<!-- # Unused Parameters # -->
-@type: a GtkType
+@type: a #GtkType.
+@Returns: a pointer to the name of a type, or %NULL if it has none.
<!-- ##### MACRO gtk_type_from_name ##### -->
<para>
-Get the internal representation of a type given its name.
+Gets the internal representation of a type, given its name.
</para>
-@Returns: a GtkType
-<!-- # Unused Parameters # -->
-@name: the name of a gtk type
+@name: the name of a GTK+ type
+@Returns: a #GtkType.
<!-- ##### MACRO gtk_type_parent ##### -->
<para>
-
+Returns the parent type of a #GtkType.
</para>
-@Returns: the GtkType of the parent
-<!-- # Unused Parameters # -->
-@type: a GtkType
+@type: a #GtkType.
+@Returns: the #GtkType of the parent.
<!-- ##### FUNCTION gtk_type_class ##### -->
<para>
-Return a gpointer pointing to the class of @type or NULL if there was
-any trouble identifying @type. Initialize the class if necessary.
+Returns a pointer pointing to the class of @type or %NULL if there was
+any trouble identifying @type. Initializes the class if necessary.
</para>
-@type: a GtkType
-@Returns: gpointer to the klass.
+@type: a #GtkType.
+@Returns: pointer to the class.
<!-- ##### FUNCTION gtk_type_new ##### -->
<para>
-Create a new object of a given type, and return a gpointer to it.
-Returns NULL if you give it an invalid type. It allocates the object
+Creates a new object of a given type, and return a pointer to it.
+Returns %NULL if you give it an invalid type. It allocates the object
out of the type's memory chunk if there is a memory chunk. The object
has all the proper initializers called.
</para>
-@type: GtkType
-@Returns: gpointer to a GtkTypeObject
+@type: a #GtkType.
+@Returns: pointer to a #GtkTypeObject.
<!-- ##### MACRO gtk_type_is_a ##### -->
<para>
-Look in the type hierarchy to see if @type has @is_a_type among its
+Looks in the type hierarchy to see if @type has @is_a_type among its
ancestors. Do so with a simple lookup, not a loop.
</para>
-@Returns:
-<!-- # Unused Parameters # -->
-@type: GtkType
-@is_a_type: GtkType
+@type: a #GtkType.
+@is_a_type: another #GtkType.
+@Returns: %TRUE if @type is a @is_a_type.
<!-- ##### FUNCTION gtk_type_enum_get_values ##### -->
If @enum_type has values, then return a pointer to all of them.
</para>
-@enum_type: GtkType
-@Returns: GtkEnumValue*
+@enum_type: a #GtkType.
+@Returns: #GtkEnumValue*
<!-- ##### FUNCTION gtk_type_flags_get_values ##### -->
If @flags_type has values, then return a pointer to all of them.
</para>
-@flags_type:
-@Returns: GtkFlagValue*
+@flags_type: a #GtkType.
+@Returns: #GtkFlagValue*
<!-- ##### FUNCTION gtk_type_enum_find_value ##### -->
<para>
-Return a pointer to one of @enum_type's GtkEnumValues's whose name (or nickname) matches @value_name.
+Returns a pointer to one of @enum_type's #GtkEnumValues's whose name (or nickname) matches @value_name.
</para>
-@enum_type: GtkType
-@value_name:
-@Returns: GtkEnumValue*
+@enum_type: a #GtkType.
+@value_name: the name to look for.
+@Returns: #GtkEnumValue*
<!-- ##### FUNCTION gtk_type_flags_find_value ##### -->
<para>
-Return a pointer to one of @flag_type's GtkFlagValue's whose name (or nickname) matches @value_name.
+Returns a pointer to one of @flag_type's #GtkFlagValue's whose name (or nickname) matches @value_name.
</para>
-@flags_type:
-@value_name:
-@Returns: GtkFlagValue*
+@flags_type: a #GtkType.
+@value_name: the name to look for.
+@Returns: #GtkFlagValue*
<!-- # Unused Parameters # -->
@flag_type: GtkType
projects / ~andy / gtk / blobdiff