mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-09-21 17:56:18 +02:00
243 lines
4.2 KiB
Plaintext
243 lines
4.2 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Enums and Flags
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Enumeration and flags types
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GEnumClass ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@g_type_class:
|
|
@minimum:
|
|
@maximum:
|
|
@n_values:
|
|
@values:
|
|
|
|
<!-- ##### STRUCT GFlagsClass ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@g_type_class:
|
|
@mask:
|
|
@n_values:
|
|
@values:
|
|
|
|
<!-- ##### MACRO G_ENUM_CLASS_TYPE ##### -->
|
|
<para>
|
|
Returns the type identifier from a given #GEnumClass structure.
|
|
</para>
|
|
|
|
@class: a #GEnumClass
|
|
|
|
|
|
<!-- ##### MACRO G_ENUM_CLASS_TYPE_NAME ##### -->
|
|
<para>
|
|
Returns the static type name from a given #GEnumClass structure.
|
|
</para>
|
|
|
|
@class: a #GEnumClass
|
|
|
|
|
|
<!-- ##### MACRO G_TYPE_IS_ENUM ##### -->
|
|
<para>
|
|
Returns whether @type "is a" %G_TYPE_ENUM.
|
|
</para>
|
|
|
|
@type: a #GType ID.
|
|
|
|
|
|
<!-- ##### MACRO G_ENUM_CLASS ##### -->
|
|
<para>
|
|
Casts a derived #GEnumClass structure into a #GEnumClass structure.
|
|
</para>
|
|
|
|
@class: a valid #GEnumClass
|
|
|
|
|
|
<!-- ##### MACRO G_IS_ENUM_CLASS ##### -->
|
|
<para>
|
|
Checks whether @class "is a" valid #GEnumClass structure of type %G_TYPE_ENUM
|
|
or derived.
|
|
</para>
|
|
|
|
@class: a #GEnumClass
|
|
|
|
|
|
<!-- ##### MACRO G_TYPE_IS_FLAGS ##### -->
|
|
<para>
|
|
Returns whether @type "is a" %G_TYPE_FLAGS.
|
|
</para>
|
|
|
|
@type: a #GType ID.
|
|
|
|
|
|
<!-- ##### MACRO G_FLAGS_CLASS ##### -->
|
|
<para>
|
|
Casts a derived #GFlagsClass structure into a #GFlagsClass structure.
|
|
</para>
|
|
|
|
@class: a valid #GFlagsClass
|
|
|
|
|
|
<!-- ##### MACRO G_IS_FLAGS_CLASS ##### -->
|
|
<para>
|
|
Checks whether @class "is a" valid #GFlagsClass structure of type %G_TYPE_FLAGS
|
|
or derived.
|
|
</para>
|
|
|
|
@class: a #GFlagsClass
|
|
|
|
|
|
<!-- ##### MACRO G_FLAGS_CLASS_TYPE ##### -->
|
|
<para>
|
|
Returns the type identifier from a given #GFlagsClass structure.
|
|
</para>
|
|
|
|
@class: a #GFlagsClass
|
|
|
|
|
|
<!-- ##### MACRO G_FLAGS_CLASS_TYPE_NAME ##### -->
|
|
<para>
|
|
Returns the static type name from a given #GFlagsClass structure.
|
|
</para>
|
|
|
|
@class: a #GFlagsClass
|
|
|
|
|
|
<!-- ##### STRUCT GEnumValue ##### -->
|
|
<para>
|
|
A structure which contains a single enum value, its name, and it's
|
|
nickname.
|
|
</para>
|
|
|
|
@value:
|
|
@value_name:
|
|
@value_nick:
|
|
|
|
<!-- ##### STRUCT GFlagsValue ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@value_name:
|
|
@value_nick:
|
|
|
|
<!-- ##### FUNCTION g_enum_get_value ##### -->
|
|
<para>
|
|
Returns the #GEnumValue for a value.
|
|
</para>
|
|
|
|
@enum_class: a #GEnumClass
|
|
@value: the value to look up
|
|
@Returns: the #GEnumValue for @value, or %NULL if @value is not
|
|
a member of the enumeration
|
|
|
|
|
|
<!-- ##### FUNCTION g_enum_get_value_by_name ##### -->
|
|
<para>
|
|
Looks up a #GEnumValue by name.
|
|
</para>
|
|
|
|
@enum_class: a #GEnumClass
|
|
@name: the name to look up
|
|
@Returns: the #GEnumValue with name @name, or %NULL if the enumeration doesn'
|
|
t have a member with that name
|
|
|
|
|
|
<!-- ##### FUNCTION g_enum_get_value_by_nick ##### -->
|
|
<para>
|
|
Looks up a #GEnumValue by nickname.
|
|
</para>
|
|
|
|
@enum_class: a #GEnumClass
|
|
@nick: the nickname to look up
|
|
@Returns: the #GEnumValue with nickname @nick, or %NULL if the enumeration doesn'
|
|
t have a member with that nickname
|
|
|
|
|
|
<!-- ##### FUNCTION g_flags_get_first_value ##### -->
|
|
<para>
|
|
Returns the first #GFlagsValue which is set in @value.
|
|
</para>
|
|
|
|
@flags_class: a #GFlagsClass
|
|
@value: the value
|
|
@Returns: the first #GFlagsValue which is set in @value, or %NULL if none is set
|
|
|
|
|
|
<!-- ##### FUNCTION g_flags_get_value_by_name ##### -->
|
|
<para>
|
|
Looks up a #GFlagsValue by name.
|
|
</para>
|
|
|
|
@flags_class: a #GFlagsClass
|
|
@name: the name to look up
|
|
@Returns: the #GFlagsValue with name @name, or %NULL if there is no flag with
|
|
that name
|
|
|
|
|
|
<!-- ##### FUNCTION g_flags_get_value_by_nick ##### -->
|
|
<para>
|
|
Looks up a #GFlagsValue by nickname.
|
|
</para>
|
|
|
|
@flags_class: a #GFlagsClass
|
|
@nick: the nickname to look up
|
|
@Returns: the #GFlagsValue with nickname @nick, or %NULL if there is no flag
|
|
with that nickname
|
|
|
|
|
|
<!-- ##### FUNCTION g_enum_register_static ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@const_static_values:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_flags_register_static ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@const_static_values:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_enum_complete_type_info ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@g_enum_type:
|
|
@info:
|
|
@const_values:
|
|
|
|
|
|
<!-- ##### FUNCTION g_flags_complete_type_info ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@g_flags_type:
|
|
@info:
|
|
@const_values:
|
|
|
|
|