GimpPaletteSelect

GimpPaletteSelect — A button which pops up a palette select dialog.

Synopsis

                    GimpPaletteSelectButton;
GtkWidget *         gimp_palette_select_button_new      (const gchar *title,
                                                         const gchar *palette_name);
const gchar *       gimp_palette_select_button_get_palette
                                                        (GimpPaletteSelectButton *button);
void                gimp_palette_select_button_set_palette
                                                        (GimpPaletteSelectButton *button,
                                                         const gchar *palette_name);

Object Hierarchy

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

Implemented Interfaces

GimpPaletteSelectButton implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Properties

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

Signals

  "palette-set"                                    : Run First

Description

A button which pops up a palette select dialog.

Details

GimpPaletteSelectButton

typedef struct _GimpPaletteSelectButton GimpPaletteSelectButton;

gimp_palette_select_button_new ()

GtkWidget *         gimp_palette_select_button_new      (const gchar *title,
                                                         const gchar *palette_name);

Creates a new GtkWidget that completely controls the selection of a palette. 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.

palette_name :

 Initial palette name.

Returns :

 A GtkWidget that you can use in your UI.

Since GIMP 2.4

gimp_palette_select_button_get_palette ()

const gchar *       gimp_palette_select_button_get_palette
                                                        (GimpPaletteSelectButton *button);

Retrieves the name of currently selected palette.

button :

 A GimpPaletteSelectButton

Returns :

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

Since GIMP 2.4

gimp_palette_select_button_set_palette ()

void                gimp_palette_select_button_set_palette
                                                        (GimpPaletteSelectButton *button,
                                                         const gchar *palette_name);

Sets the current palette for the palette select button.

button :

 A GimpPaletteSelectButton

palette_name :

 Palette name to set; NULL means no change.

Since GIMP 2.4

Property Details

The "palette-name" property

  "palette-name"             gchar*                : Read / Write

The name of the currently selected palette.

Default value: NULL

Since GIMP 2.4

The "title" property

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

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

Default value: "Palette Selection"

Since GIMP 2.4

Signal Details

The "palette-set" signal

void                user_function                      (GimpPaletteSelectButton *widget,
                                                        gchar                   *palette_name,
                                                        gboolean                 dialog_closing,
                                                        gpointer                 user_data)           : Run First

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

widget :

 the object which received the signal.

palette_name :

 the name of the currently selected palette.

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