<?xml version="1.0"?>
<page id="Gimp.enum_get_value"
      type="topic"
      style="function"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/1.0/ui/">
  <info>
    <link xref="index" group="function" type="guide"/>
    <api:function>
      <api:returns>
        <api:type>Boolean</api:type>
      </api:returns>
      <api:name>gimp_enum_get_value</api:name>
      <api:arg>
        <api:type>GObject.Type</api:type>
        <api:name>enum_type</api:name>
      </api:arg>
      <api:arg>
        <api:type>Number(gint)</api:type>
        <api:name>value</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.enum_get_value</title>
  <synopsis><code mime="text/x-gjs">
function enum_get_value(enum_type: GObject.Type, value: Number(gint)): [ok: Boolean, value_name: String, value_nick: String, value_desc: String, value_help: String] {
    // Gjs wrapper for gimp_enum_get_value()
}
  </code></synopsis>
  <p>Checks if <code>value</code> is valid for the enum registered as <code>enum_type</code>.
If the value exists in that enum, its name, nick and its translated
description and help are returned (if <code>value_name</code>, <code>value_nick</code>,
<code>value_desc</code> and <code>value_help</code> are not <code>null</code>).</p>
  <p>Since 2.2</p>
<terms>
<item>
<title><code>enum_type</code></title>
  <p>the <link href="../GLib-2.0/GLib.Type.html">GLib.Type</link> of a registered enum</p>
</item>
<item>
<title><code>value</code></title>
  <p>an integer value</p>
</item>
<item>
<title><code>ok</code></title>
  <p><code>true</code> if <code>value</code> is valid for the <code>enum_type</code>, <code>false</code> otherwise</p>
</item>
<item>
<title><code>value_name</code></title>
  <p>return location for the value's name, or <code>null</code></p>
</item>
<item>
<title><code>value_nick</code></title>
  <p>return location for the value's nick, or <code>null</code></p>
</item>
<item>
<title><code>value_desc</code></title>
  <p>return location for the value's translated
                               description, or <code>null</code></p>
</item>
<item>
<title><code>value_help</code></title>
  <p>return location for the value's translated
                               help, or <code>null</code></p>
</item>
</terms>

</page>
