GimpGradientSelectButton

GimpGradientSelectButton — A button which pops up a gradient select dialog.

Synopsis

                    GimpGradientSelectButton;
GtkWidget *         gimp_gradient_select_button_new     (const gchar *title,
                                                         const gchar *gradient_name);
const gchar *       gimp_gradient_select_button_get_gradient
                                                        (GimpGradientSelectButton *button);
void                gimp_gradient_select_button_set_gradient
                                                        (GimpGradientSelectButton *button,
                                                         const gchar *gradient_name);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GimpSelectButton
                                       +----GimpGradientSelectButton

Implemented Interfaces

GimpGradientSelectButton implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Properties

  "gradient-name"            gchar*                : Read / Write
  "title"                    gchar*                : Read / Write / Construct Only

Signals

  "gradient-set"                                   : Run First

Description

A button which pops up a gradient select dialog.

Details

GimpGradientSelectButton

typedef struct _GimpGradientSelectButton GimpGradientSelectButton;

gimp_gradient_select_button_new ()

GtkWidget *         gimp_gradient_select_button_new     (const gchar *title,
                                                         const gchar *gradient_name);

Creates a new GtkWidget that completely controls the selection of a gradient. This widget is suitable for placement in a table in a plug-in dialog.

title :

 Title of the dialog to use or NULL to use the default title.

gradient_name :

 Initial gradient name.

Returns :

 A GtkWidget that you can use in your UI.

Since GIMP 2.4

gimp_gradient_select_button_get_gradient ()

const gchar *       gimp_gradient_select_button_get_gradient
                                                        (GimpGradientSelectButton *button);

Retrieves the name of currently selected gradient.

button :

 A GimpGradientSelectButton

Returns :

 an internal copy of the gradient name which must not be freed.

Since GIMP 2.4

gimp_gradient_select_button_set_gradient ()

void                gimp_gradient_select_button_set_gradient
                                                        (GimpGradientSelectButton *button,
                                                         const gchar *gradient_name);

Sets the current gradient for the gradient select button.

button :

 A GimpGradientSelectButton

gradient_name :

 Gradient name to set.

Since GIMP 2.4

Property Details

The "gradient-name" property

  "gradient-name"            gchar*                : Read / Write

The name of the currently selected gradient.

Default value: NULL

Since GIMP 2.4

The "title" property

  "title"                    gchar*                : Read / Write / Construct Only

The title to be used for the gradient selection popup dialog.

Default value: "Gradient Selection"

Since GIMP 2.4

Signal Details

The "gradient-set" signal

void                user_function                      (GimpGradientSelectButton *widget,
                                                        gchar                    *gradient_name,
                                                        gint                      width,
                                                        gpointer                  grad_data,
                                                        gboolean                  dialog_closing,
                                                        gpointer                  user_data)           : Run First

The ::gradient-set signal is emitted when the user selects a gradient.

widget :

 the object which received the signal.

gradient_name :

 the name of the currently selected gradient.

width :

 width of the gradient

grad_data :

 gradient data

dialog_closing :

 whether the dialog was closed or not.

user_data :

 user data set when the signal handler was connected.

Since GIMP 2.4

Generated by GTK-Doc V1.18