G_ENUM_CLASS_TYPE()

#define G_ENUM_CLASS_TYPE(class)       (G_TYPE_FROM_CLASS (class))

Get the type identifier from a given GEnumClass structure.

G_ENUM_CLASS_TYPE_NAME()

#define G_ENUM_CLASS_TYPE_NAME(class)  (g_type_name (G_ENUM_CLASS_TYPE (class)))

Get the static type name from a given GEnumClass structure.

G_TYPE_IS_ENUM()

#define G_TYPE_IS_ENUM(type)	       (G_TYPE_FUNDAMENTAL (type) == G_TYPE_ENUM)

Checks whether type "is a" G_TYPE_ENUM.

G_ENUM_CLASS()

#define G_ENUM_CLASS(class)	       (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_ENUM, GEnumClass))

Casts a derived GEnumClass structure into a GEnumClass structure.

G_IS_ENUM_CLASS()

#define G_IS_ENUM_CLASS(class)	       (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_ENUM))

Checks whether class "is a" valid GEnumClass structure of type G_TYPE_ENUM or derived.

G_TYPE_IS_FLAGS()

#define G_TYPE_IS_FLAGS(type)	       (G_TYPE_FUNDAMENTAL (type) == G_TYPE_FLAGS)

Checks whether type "is a" G_TYPE_FLAGS.

G_FLAGS_CLASS()

#define G_FLAGS_CLASS(class)	       (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_FLAGS, GFlagsClass))

Casts a derived GFlagsClass structure into a GFlagsClass structure.

G_IS_FLAGS_CLASS()

#define G_IS_FLAGS_CLASS(class)        (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_FLAGS))

Checks whether class "is a" valid GFlagsClass structure of type G_TYPE_FLAGS or derived.

G_FLAGS_CLASS_TYPE()

#define G_FLAGS_CLASS_TYPE(class)      (G_TYPE_FROM_CLASS (class))

Get the type identifier from a given GFlagsClass structure.

G_FLAGS_CLASS_TYPE_NAME()

#define G_FLAGS_CLASS_TYPE_NAME(class) (g_type_name (G_FLAGS_CLASS_TYPE (class)))

Get the static type name from a given GFlagsClass structure.

g_enum_get_value ()

GEnumValue *
g_enum_get_value (GEnumClass *enum_class,
                  gint value);

Returns the GEnumValue for a value.

g_enum_get_value_by_name ()

GEnumValue *
g_enum_get_value_by_name (GEnumClass *enum_class,
                          const gchar *name);

Looks up a GEnumValue by name.

g_enum_get_value_by_nick ()

GEnumValue *
g_enum_get_value_by_nick (GEnumClass *enum_class,
                          const gchar *nick);

Looks up a GEnumValue by nickname.

g_enum_to_string ()

gchar *
g_enum_to_string (GType g_enum_type,
                  gint value);

Pretty-prints value in the form of the enum’s name.

This is intended to be used for debugging purposes. The format of the output may change in the future.

Since: 2.54

g_flags_get_first_value ()

GFlagsValue *
g_flags_get_first_value (GFlagsClass *flags_class,
                         guint value);

Returns the first GFlagsValue which is set in value .

g_flags_get_value_by_name ()

GFlagsValue *
g_flags_get_value_by_name (GFlagsClass *flags_class,
                           const gchar *name);

Looks up a GFlagsValue by name.

g_flags_get_value_by_nick ()

GFlagsValue *
g_flags_get_value_by_nick (GFlagsClass *flags_class,
                           const gchar *nick);

Looks up a GFlagsValue by nickname.

g_flags_to_string ()

gchar *
g_flags_to_string (GType flags_type,
                   guint value);

Pretty-prints value in the form of the flag names separated by | and sorted. Any extra bits will be shown at the end as a hexadecimal number.

This is intended to be used for debugging purposes. The format of the output may change in the future.

Since: 2.54

g_enum_register_static ()

GType
g_enum_register_static (const gchar *name,
                        const GEnumValue *const_static_values);

Registers a new static enumeration type with the name name .

It is normally more convenient to let glib-mkenums, generate a my_enum_get_type() function from a usual C enumeration definition than to write one yourself using g_enum_register_static().

g_flags_register_static ()

GType
g_flags_register_static (const gchar *name,
                         const GFlagsValue *const_static_values);

Registers a new static flags type with the name name .

It is normally more convenient to let glib-mkenums generate a my_flags_get_type() function from a usual C enumeration definition than to write one yourself using g_flags_register_static().

g_enum_complete_type_info ()

void
g_enum_complete_type_info (GType g_enum_type,
                           GTypeInfo *info,
                           const GEnumValue *const_values);

This function is meant to be called from the complete_type_info function of a GTypePlugin implementation, as in the following example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

static void
my_enum_complete_type_info (GTypePlugin     *plugin,
                            GType            g_type,
                            GTypeInfo       *info,
                            GTypeValueTable *value_table)
{
  static const GEnumValue values[] = {
    { MY_ENUM_FOO, "MY_ENUM_FOO", "foo" },
    { MY_ENUM_BAR, "MY_ENUM_BAR", "bar" },
    { 0, NULL, NULL }
  };

  g_enum_complete_type_info (type, info, values);
}

g_flags_complete_type_info ()

void
g_flags_complete_type_info (GType g_flags_type,
                            GTypeInfo *info,
                            const GFlagsValue *const_values);

This function is meant to be called from the complete_type_info() function of a GTypePlugin implementation, see the example for g_enum_complete_type_info() above.

struct GEnumClass

struct GEnumClass {
  GTypeClass  g_type_class;

  gint	      minimum;
  gint	      maximum;
  guint	      n_values;
  GEnumValue *values;
};

The class of an enumeration type holds information about its possible values.

struct GFlagsClass

struct GFlagsClass {
  GTypeClass   g_type_class;
  
  guint	       mask;
  guint	       n_values;
  GFlagsValue *values;
};

The class of a flags type holds information about its possible values.

struct GEnumValue

struct GEnumValue {
  gint	 value;
  const gchar *value_name;
  const gchar *value_nick;
};

A structure which contains a single enum value, its name, and its nickname.

struct GFlagsValue

struct GFlagsValue {
  guint	 value;
  const gchar *value_name;
  const gchar *value_nick;
};

A structure which contains a single flags value, its name, and its nickname.