Function

Gimpflags_get_first_value

since: 2.2

Declaration [src]

gboolean
gimp_flags_get_first_value (
  GType flags_type,
  guint value,
  const gchar** value_name,
  const gchar** value_nick,
  const gchar** value_desc,
  const gchar** value_help
)

Description [src]

Checks if value is valid for the flags registered as flags_type. If the value exists in that flags, its name, nick and its translated description and help are returned (if value_name, value_nick, value_desc and value_help are not NULL).

Available since: 2.2

Parameters

flags_type

Type: GType

The GType of registered flags.

value

Type: guint

An integer value.

value_name

Type: const gchar**

Return location for the value’s name, or NULL.

The argument will be set by the function.
The argument can be NULL.
The called function takes ownership of the data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.
value_nick

Type: const gchar**

Return location for the value’s nick, or NULL.

The argument will be set by the function.
The argument can be NULL.
The called function takes ownership of the data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.
value_desc

Type: const gchar**

Return location for the value’s translated description, or NULL.

The argument will be set by the function.
The argument can be NULL.
The called function takes ownership of the data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.
value_help

Type: const gchar**

Return location for the value’s translated help, or NULL.

The argument will be set by the function.
The argument can be NULL.
The called function takes ownership of the data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.

Return value

Type: gboolean

TRUE if value is valid for the flags_type, FALSE otherwise.