gimpgradientselect

## gimpgradientselect gimpgradientselect — Functions providing a gradient selection dialog. |

## Synopsis

    void        (*GimpRunGradientCallback)      (const gchar *gradient_name,
                                                 gint width,
                                                 const gdouble *grad_data,
                                                 gboolean dialog_closing,
                                                 gpointer user_data);
    const gchar* gimp_gradient_select_new       (const gchar *title,
                                                 const gchar *gradient_name,
                                                 gint sample_size,
                                                 GimpRunGradientCallback callback,
                                                 gpointer data);
    void        gimp_gradient_select_destroy    (const gchar *gradient_callback);
    gboolean    gimp_gradients_popup            (const gchar *gradient_callback,
                                                 const gchar *popup_title,
                                                 const gchar *initial_gradient,
                                                 gint sample_size);
    gboolean    gimp_gradients_close_popup      (const gchar *gradient_callback);
    gboolean    gimp_gradients_set_popup        (const gchar *gradient_callback,
                                                 const gchar *gradient_name);

## Description

Functions providing a gradient selection dialog.

## Details

### GimpRunGradientCallback ()

    void        (*GimpRunGradientCallback)      (const gchar *gradient_name,
                                                 gint width,
                                                 const gdouble *grad_data,
                                                 gboolean dialog_closing,
                                                 gpointer user_data);

`gradient_name` : |
`width` : |
`grad_data` : |
`dialog_closing` : |
`user_data` : |

### gimp_gradient_select_new ()

    const gchar* gimp_gradient_select_new       (const gchar *title,
                                                 const gchar *gradient_name,
                                                 gint sample_size,
                                                 GimpRunGradientCallback callback,
                                                 gpointer data);

`title` : |
`gradient_name` : |
`sample_size` : |
`callback` : |
`data` : |
Returns : |

### gimp_gradient_select_destroy ()

    void        gimp_gradient_select_destroy    (const gchar *gradient_callback);

`gradient_callback` : |

### gimp_gradients_popup ()

    gboolean    gimp_gradients_popup            (const gchar *gradient_callback,
                                                 const gchar *popup_title,
                                                 const gchar *initial_gradient,
                                                 gint sample_size);

Invokes the Gimp gradients selection.

This procedure popups the gradients selection dialog.

`gradient_callback` : | The callback PDB proc to call when gradient selection is made.
`popup_title` : | Title to give the gradient popup window.
`initial_gradient` : | The name of the pattern to set as the first selected.
`sample_size` : | Size of the sample to return when the gradient is changed.
Returns : | TRUE on success.

### gimp_gradients_close_popup ()

    gboolean    gimp_gradients_close_popup      (const gchar *gradient_callback);

Popdown the Gimp gradient selection.

This procedure closes an opened gradient selection dialog.

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

### gimp_gradients_set_popup ()

    gboolean    gimp_gradients_set_popup        (const gchar *gradient_callback,
                                                 const gchar *gradient_name);

Sets the current gradient selection in a popup.

Sets the current gradient selection in a popup.

`gradient_callback` : | The name of the callback registered for this popup.
`gradient_name` : | The name of the gradient to set as selected.
Returns : | TRUE on success.