## gimppatternselect

gimppatternselect — Functions providing a pattern selection dialog.

## Synopsis

    void        (*GimpRunPatternCallback)       (const gchar *pattern_name,
                                                 gint width,
                                                 gint height,
                                                 gint bpp,
                                                 const guchar *mask_data,
                                                 gboolean dialog_closing,
                                                 gpointer user_data);
    const gchar* gimp_pattern_select_new        (const gchar *title,
                                                 const gchar *pattern_name,
                                                 GimpRunPatternCallback callback,
                                                 gpointer data);
    void        gimp_pattern_select_destroy     (const gchar *pattern_callback);
    gboolean    gimp_patterns_popup             (const gchar *pattern_callback,
                                                 const gchar *popup_title,
                                                 const gchar *initial_pattern);
    gboolean    gimp_patterns_close_popup       (const gchar *pattern_callback);
    gboolean    gimp_patterns_set_popup         (const gchar *pattern_callback,
                                                 const gchar *pattern_name);

## Description

Functions providing a pattern selection dialog.

## Details

### GimpRunPatternCallback ()

    void        (*GimpRunPatternCallback)       (const gchar *pattern_name,
                                                 gint width,
                                                 gint height,
                                                 gint bpp,
                                                 const guchar *mask_data,
                                                 gboolean dialog_closing,
                                                 gpointer user_data);

`pattern_name` : |
`width` : |
`height` : |
`bpp` : |
`mask_data` : |
`dialog_closing` : |
`user_data` : |

### gimp_pattern_select_new ()

    const gchar* gimp_pattern_select_new        (const gchar *title,
                                                 const gchar *pattern_name,
                                                 GimpRunPatternCallback callback,
                                                 gpointer data);

`title` : |
`pattern_name` : |
`callback` : |
`data` : |
Returns : |

### gimp_pattern_select_destroy ()

    void        gimp_pattern_select_destroy     (const gchar *pattern_callback);

`pattern_callback` : |

### gimp_patterns_popup ()

    gboolean    gimp_patterns_popup             (const gchar *pattern_callback,
                                                 const gchar *popup_title,
                                                 const gchar *initial_pattern);

Invokes the Gimp pattern selection.

This procedure popups the pattern selection dialog.

`pattern_callback` : | The callback PDB proc to call when pattern selection is made.
`popup_title` : | Title to give the pattern popup window.
`initial_pattern` : | The name of the pattern to set as the first selected.
Returns : | TRUE on success.

### gimp_patterns_close_popup ()

    gboolean    gimp_patterns_close_popup       (const gchar *pattern_callback);

Popdown the Gimp pattern selection.

This procedure closes an opened pattern selection dialog.

`pattern_callback` : | The name of the callback registered for this popup.
Returns : | TRUE on success.

### gimp_patterns_set_popup ()

    gboolean    gimp_patterns_set_popup         (const gchar *pattern_callback,
                                                 const gchar *pattern_name);

Sets the current pattern selection in a popup.

Sets the current pattern selection in a popup.

`pattern_callback` : | The name of the callback registered for this popup.
`pattern_name` : | The name of the pattern to set as selected.
Returns : | TRUE on success.