<?xml version="1.0"?>
<page id="Gimp.progress_update"
      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>bool</api:type>
      </api:returns>
      <api:name>gimp_progress_update</api:name>
      <api:arg>
        <api:type>float</api:type>
        <api:name>percentage</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.progress_update</title>
  <synopsis><code mime="text/x-python">
@accepts(float)
@returns(bool)
def progress_update(percentage):
    # Python wrapper for gimp_progress_update()
  </code></synopsis>
  <p>Updates the progress bar for the current plug-in.</p>  <p>The library will handle over-updating by possibly dropping silently
some updates when they happen too close next to each other (either
time-wise or step-wise).
The caller does not have to take care of this aspect of progression
and can focus on computing relevant progression steps.</p>

<terms>
<item>
<title><code>percentage</code></title>
  <p>Percentage of progress completed (in the range from 0.0
             to 1.0).</p>
</item>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>

</page>
