<?xml version="1.0"?>
<page id="Gimp.patterns_popup"
      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_patterns_popup</api:name>
      <api:arg>
        <api:type>unicode</api:type>
        <api:name>pattern_callback</api:name>
      </api:arg>
      <api:arg>
        <api:type>unicode</api:type>
        <api:name>popup_title</api:name>
      </api:arg>
      <api:arg>
        <api:type>Gimp.Pattern</api:type>
        <api:name>initial_pattern</api:name>
      </api:arg>
      <api:arg>
        <api:type>GLib.Bytes</api:type>
        <api:name>parent_window</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.patterns_popup</title>
  <synopsis><code mime="text/x-python">
@accepts(unicode, unicode, Gimp.Pattern, GLib.Bytes)
@returns(bool)
def patterns_popup(pattern_callback, popup_title, initial_pattern, parent_window):
    # Python wrapper for gimp_patterns_popup()
  </code></synopsis>
  <p>Invokes the Gimp pattern selection.</p>  <p>Opens the pattern selection dialog.</p>

<terms>
<item>
<title><code>pattern_callback</code></title>
  <p>The callback PDB proc to call when the user chooses a pattern.</p>
</item>
<item>
<title><code>popup_title</code></title>
  <p>Title of the pattern selection dialog.</p>
</item>
<item>
<title><code>initial_pattern</code></title>
  <p>The pattern to set as the initial choice.</p>
</item>
<item>
<title><code>parent_window</code></title>
  <p>An optional parent window handle for the popup to be set transient to.</p>
</item>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>

</page>
